DataRelease

Import from: @xbbg/xnews

Defined in: src/types.ts (declaration: types.d.ts:218)

A dated payload of structured rows from a scheduled data publisher — the data lane's counterpart of a news article. asOf is the date the rows describe, which for scheduled releases precedes publication: CFTC COT rows are as of Tuesday and normally published Friday afternoon.

Extended by

• Ffiec002Release
• FfiecE16Release

Type Parameters

Row

Row

Properties

asOf

readonly asOf: string

Defined in: src/types.ts (declaration: types.d.ts:223)

ISO date (YYYY-MM-DD) the rows are stated as of.

---

dataset

readonly dataset: string

Defined in: src/types.ts (declaration: types.d.ts:221)

---

provider

readonly provider: string

Defined in: src/types.ts (declaration: types.d.ts:220)

Data-source identifier; data-only sources such as FRED need not be a NewsProvider.

---

rows

readonly rows: readonly Row[]

Defined in: src/types.ts (declaration: types.d.ts:243)

---

sequence?

readonly optional sequence?: number

Defined in: src/types.ts (declaration: types.d.ts:231)

Publisher's monotonic release counter, for datasets that publish many releases per asOf date (e.g. DTCC intraday slice IDs). When present, createDataReleaseWatcher orders and dedupes on sequence instead of asOf, and drains a backlog of sequenced releases without sleeping between polls.

---

updatedAt?

readonly optional updatedAt?: string

Defined in: src/types.ts (declaration: types.d.ts:242)

ISO date (YYYY-MM-DD) the publisher last revised this dataset, when the publisher exposes one (e.g. FFIEC CDR's "Call Updated" stamp). Late refilings can move updatedAt without changing asOf; the release watcher keys on asOf alone, so a refile of an already-seen period does not re-yield. Watch the publisher's stamp directly (e.g. fetchFfiecBulkPage().callUpdated) when revisions matter.

---

url

readonly url: string

Defined in: src/types.ts (declaration: types.d.ts:233)

Canonical human-facing URL for the dataset.