libfec

@alex.garcia/libfec / Filing

Class: Filing ​

Defined in: filing.ts:21

A whole filing read into memory by read. Re-iterable (for (const row of filing) walks rows), and there is nothing to close.

Implements ​

  • Iterable<Row<null>>

Properties ​

id ​

readonly id: string | null

Defined in: filing.ts:23

The filing ID; see FilingReader.id.

fecVersion ​

readonly fecVersion: string

Defined in: filing.ts:25

The filing's format version.

readonly header: Header

Defined in: filing.ts:27

The filing's header.

cover ​

readonly cover: Cover | null

Defined in: filing.ts:29

The typed cover; see FilingReader.cover.

coverSummary ​

readonly coverSummary: CoverSummary

Defined in: filing.ts:31

The six cover fields every form has.

coverRow ​

readonly coverRow: Row<null>

Defined in: filing.ts:33

The cover record as a raw Row.

rows ​

readonly rows: readonly Row<null>[]

Defined in: filing.ts:35

Every row after the cover, untyped (itemization is null).

invalidValues ​

readonly invalidValues: readonly InvalidValue[]

Defined in: filing.ts:37

Amounts and dates in rows that didn't parse: the first 1,000.

invalidValueCount ​

readonly invalidValueCount: number

Defined in: filing.ts:39

How many amounts and dates didn't parse, uncapped.

skippedRows ​

readonly skippedRows: readonly SkippedRow[]

Defined in: filing.ts:41

Rows skipped with unknownRows: "skip".

Accessors ​

length ​

Get Signature ​

get length(): number

Defined in: filing.ts:64

rows.length.

Returns ​

number

Methods ​

itemizations() ​

itemizations(): readonly Row<Itemization>[]

Defined in: filing.ts:75

The typed rows (see FilingReader.itemizations). The first call reads the source again, typing every row, and caches the result: later calls return the same array. A bytes source is kept alive for this; a path that changed or vanished since read gives different rows or ENOENT.

Returns ​

readonly Row<Itemization>[]

[iterator]() ​

[iterator](): IterableIterator<Row<null>>

Defined in: filing.ts:88

Iterate rows; a Filing can be iterated any number of times.

Returns ​

IterableIterator<Row<null>>

Implementation of ​

Iterable.[iterator]