Class GeneratedObjectField

A JSON-like object, with miscellaneous values.

Indexable

[key: string]: string | number | boolean | object | undefined
All potentially present fields.

Index

Constructors

Properties

confidence? pageId? rawValue?

Methods

get toString toStringLevel

Constructors

constructor

new GeneratedObjectField(
__namedParameters: BaseFieldConstructor,
): GeneratedObjectField
Parameters
- __namedParameters: BaseFieldConstructor
Returns GeneratedObjectField
- Defined in src/v1/parsing/generated/generatedObject.ts:20

Properties

`Optional`confidence

confidence?: number

Confidence with which the value was assessed.

`Optional`pageId

pageId?: number

The document page on which the information was found.

`Optional`rawValue

rawValue?: string

Raw unprocessed value, as it was sent by the server.

Methods

get

get(fieldName: string): string | number | boolean | object | undefined
Returns a field value by key from this generated object.
Parameters
- fieldName: string
Returns string | number | boolean | object | undefined
- Defined in src/v1/parsing/generated/generatedObject.ts:111

toString

toString(): string
Returns the default string representation.

Returns string
- Defined in src/v1/parsing/generated/generatedObject.ts:106

toStringLevel

toStringLevel(level?: number): string
ReSTructured-compliant string representation. Takes into account level of indentation & displays elements as list elements.
Parameters
- level: number = 0
  Level of indentation. 0 by default.
Returns string
- Defined in src/v1/parsing/generated/generatedObject.ts:83