Skip to content

WorkRecord ​

Import from: @xbbg/xnews

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

One bibliographic record, normalized across catalogs. Numeric fields are absent rather than zero when the provider stated an uncoercible value, and the reason lands in warnings so a layout change surfaces instead of silently degrading every row.

Properties ​

addedAt? ​

readonly optional addedAt?: string

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

ISO instant the catalog first listed the record, when stated.


authors ​

readonly authors: readonly string[]

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


availability ​

readonly availability: WorkAvailability

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


edition? ​

readonly optional edition?: string

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


format? ​

readonly optional format?: string

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

Lowercase file extension, when the record describes a file.


identity ​

readonly identity: WorkIdentity

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


language? ​

readonly optional language?: string

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


modifiedAt? ​

readonly optional modifiedAt?: string

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

ISO instant the catalog last revised the record, when stated.


pageCount? ​

readonly optional pageCount?: number

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


provenance ​

readonly provenance: readonly WorkRecordProvenance[]

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


provider ​

readonly provider: string

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

Built-in providers use their WorksProvider name (e.g. "libgen").


publishedYear? ​

readonly optional publishedYear?: number

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


publisher? ​

readonly optional publisher?: string

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


series? ​

readonly optional series?: string

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


sizeBytes? ​

readonly optional sizeBytes?: number

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


sourceId ​

readonly sourceId: string

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

Provider-native record id, stable within provider.


subtitle? ​

readonly optional subtitle?: string

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


title ​

readonly title: string

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


url ​

readonly url: string

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

Canonical absolute human-facing URL for the record.


warnings ​

readonly warnings: readonly string[]

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

Last updated:

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