libfec

@alex.garcia/libfec / OpenOptions

Interface: OpenOptions ​

Defined in: reader.ts:18

Options for open and read.

Properties ​

dates? ​

optional dates?: DatesOption

Defined in: reader.ts:25

How date columns of Row.values come out: "iso" (default) for "YYYY-MM-DD" strings, "date" for Dates at UTC midnight. Typed records (Row.itemization, FilingReader.cover) always use ISO strings.

unknownRows? ​

optional unknownRows?: "skip" | "throw"

Defined in: reader.ts:32

What rows() does with a row whose type has no column mapping in the filing's version: "throw" (default) a MissingMappingError, or "skip" it and list it in FilingReader.skippedRows. itemizations() only yields rows it can type, so this doesn't apply.

batchSize? ​

optional batchSize?: number

Defined in: reader.ts:34

Rows per native batch (default 1024). A tuning knob; results don't depend on it.

id? ​

optional id?: string

Defined in: reader.ts:44

The filing's ID, for FilingReader.id. Bytes have no file name to take it from, so without this their id is null; for a path it replaces the ID taken from the file name.

js
open(bytes, { id: "1805248" }).id // "1805248"