DataSource

Import from: @xbbg/xnews

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

Binds one provider dataset to its transport: everything the data lane's generic machinery (fetchDataRelease, createDataReleaseWatcher) needs to fetch and label releases. Built-in providers export factories returning sources (see cotDataSource); consumers can implement DataSource for their own publishers and reuse the same machinery.

Type Parameters

Row

Row

Properties

dataset

readonly dataset: string

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

---

provider

readonly provider: string

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

Methods

fetchRelease()

fetchRelease(options?): Promise<DataRelease<Row>>

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

Resolves undefined when the dataset currently has no matching data.

Parameters

options?

DataFetchOptions

Returns

Promise<DataRelease<Row>>

---

requestUrls()

requestUrls(options?): readonly string[]

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

URLs the next fetchRelease call would dial, for observability.

Parameters

options?

DataFetchOptions

Returns

readonly string[]