Class BaseField

Base class for most fields.

Hierarchy

BaseField

Index

Constructors

Properties

pageId? reconstructed value?

Methods

compare toString arraySum

Constructors

constructor

new BaseField(constructor: BaseFieldConstructor): BaseField
Parameters
- constructor: BaseFieldConstructor
  
  Constructor parameters.
Returns BaseField
- Defined in src/parsing/standard/base.ts:30

Properties

`Optional` pageId

pageId?: number

Page ID for multi-page document.

reconstructed

reconstructed: boolean

true when the field was reconstructed or computed using other fields.

`Optional` value

value?: string | number | boolean = undefined

The value.

Methods

compare

compare(other: BaseField): boolean
Parameters
- other: BaseField
Returns boolean
- Defined in src/parsing/standard/base.ts:48

toString

toString(): string
Default string representation.

Returns string
- Defined in src/parsing/standard/base.ts:74

`Static` arraySum

arraySum(array: BaseField[]): number
Returns
Sum of all the Fields values in the array
Parameters
- array: BaseField[]
  
  Array of Fields
Returns number
- Defined in src/parsing/standard/base.ts:61

Generated using TypeDoc