Class GeneratedObjectField

A JSON-like object, with miscellaneous values.

Hierarchy

GeneratedObjectField

Indexable

[key: string]: string | number | boolean | object | undefined

Index

Constructors

Properties

confidence? pageId? printableValues rawValue?

Methods

get toNumberString toString toStringLevel

Constructors

constructor

new GeneratedObjectField(__namedParameters: BaseFieldConstructor): GeneratedObjectField
Parameters
- __namedParameters: BaseFieldConstructor
Returns GeneratedObjectField
- Defined in src/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.

`Private` printableValues

printableValues: string[]

List of all printable field names.

`Optional` rawValue

rawValue?: string

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

Methods

get

get(fieldName: string): undefined | string | number | boolean | object
Parameters
- fieldName: string
Returns undefined | string | number | boolean | object
- Defined in src/parsing/generated/generatedObject.ts:101

`Private` toNumberString

toNumberString(n: number): string
Formats a float number to have at least one decimal place.

Returns
Parameters
- n: number
  
  Input number.
Returns string
- Defined in src/parsing/generated/generatedObject.ts:90

toString

toString(): string
Returns string
- Defined in src/parsing/generated/generatedObject.ts:97

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/parsing/generated/generatedObject.ts:75

Generated using TypeDoc