Skip to content

WorksResult ​

Import from: @xbbg/xnews

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

Uniform non-throwing outcome envelope for one catalog search.

Properties ​

durationMs ​

readonly durationMs: number

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


error? ​

readonly optional error?: ProviderError

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


fetchedAt ​

readonly fetchedAt: string

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


items ​

readonly items: readonly WorkRecord[]

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


page? ​

readonly optional page?: WorksPage

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

Present unless the search failed outright.


provider ​

readonly provider: string

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


recordCount ​

readonly recordCount: number

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


requestUrls ​

readonly requestUrls: readonly string[]

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


status ​

readonly status: ProviderStatus

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


warnings ​

readonly warnings: readonly string[]

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

Last updated:

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