xbbg

Appearance

ExtractOptions ​

Import from: @xbbg/xnews

Defined in: src/extract.ts (declaration: extract.d.ts:32)

Properties ​

format? ​

readonly optional format?: string

Defined in: src/extract.ts (declaration: extract.d.ts:37)

Container format. Inferred from the file name when omitted; supply it when the bytes came from somewhere without one.

maxCharacters? ​

readonly optional maxCharacters?: number

Defined in: src/extract.ts (declaration: extract.d.ts:39)

Stop after this many characters of body text.

ocr? ​

readonly optional ocr?: OcrOptions

Defined in: src/extract.ts (declaration: extract.d.ts:45)

OCR server to fall back to when a PDF carries no text layer. Without it, a scan throws instead, because returning nothing would be indistinguishable from an empty document.

Last updated:

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

Bloomberg and related marks are trademarks or service marks of Bloomberg Finance L.P. or its affiliates. Use of Bloomberg data, APIs, and SDKs requires appropriate Bloomberg licenses and entitlements.