Skip to content

WorkIdentityResolution ​

Import from: @xbbg/xnews

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

Outcome of resolving a record's identifiers against an authoritative catalog. matched is set only when the best candidate met the confidence floor; candidates is always populated so callers can review near misses.

Properties ​

candidates ​

readonly candidates: readonly WorkIdentityCandidate[]

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


error? ​

readonly optional error?: ProviderError

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

Set when status is error or disabled.


identity ​

readonly identity: WorkIdentity

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


matched? ​

readonly optional matched?: WorkRecord

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


status ​

readonly status: ProviderStatus

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

Status of the authoritative lookup. error and disabled mean the catalog never answered, so an absent matched states nothing about whether the work exists — distinguishing that from a genuine no-match is why this is not left to warning prose.


warnings ​

readonly warnings: readonly string[]

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

Last updated:

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