Skip to content

EventProviderResult ​

Import from: @xbbg/xnews

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

Uniform non-throwing outcome envelope for one snapshot fetch.

Extended by ​

Type Parameters ​

Provider ​

Provider extends string = BuiltInEventProvider

Properties ​

dataset ​

readonly dataset: string

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


durationMs ​

readonly durationMs: number

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


error? ​

readonly optional error?: ProviderError

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


eventCount ​

readonly eventCount: number

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


events ​

readonly events: readonly EventRecord<Provider>[]

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

Full current-state event set; identical to snapshot.events when present.


fetchedAt ​

readonly fetchedAt: string

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


provider ​

readonly provider: Provider

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


requestUrls ​

readonly requestUrls: readonly string[]

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


snapshot? ​

readonly optional snapshot?: EventSnapshot<Provider>

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

Present unless the fetch failed or found nothing active.


status ​

readonly status: ProviderStatus

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


warnings ​

readonly warnings: readonly string[]

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

Last updated:

xbbg is independent open-source software and is not affiliated with, endorsed by, sponsored by, or approved by Bloomberg Finance L.P.