Class SimpleField

Scalar inference field.

Hierarchy

BaseField
- SimpleField

Index

Constructors

Properties

_indentLevel confidence locations value

Accessors

booleanValue numberValue stringValue

Methods

Constructors

constructor

new SimpleField(serverResponse: StringDict, indentLevel?: number): SimpleField
Parameters
- serverResponse: StringDict
- indentLevel: number = 0
Returns SimpleField
Overrides BaseField.constructor
- Defined in src/v2/parsing/inference/field/simpleField.ts:16

Properties

`Protected`_indentLevel

_indentLevel: number

Indentation level used when rendering field text output.

confidence

confidence: v2.parsing.field.FieldConfidence | undefined

Confidence level associated with this field.

locations

locations: FieldLocation[] | undefined

Optional list of source locations for this field.

`Readonly`value

value: string | number | boolean | null

The untyped value of the field.

This is usually not what you want, look at the typed accessors instead:

stringValue
numberValue
booleanValue

Accessors

booleanValue

get booleanValue(): boolean | null
Retrieves a boolean field value as a boolean.

Returns boolean | null
- Defined in src/v2/parsing/inference/field/simpleField.ts:45

numberValue

get numberValue(): number | null
Retrieves a number field value as a number.

Returns number | null
- Defined in src/v2/parsing/inference/field/simpleField.ts:35

stringValue

get stringValue(): string | null
Retrieves a string field value as a string.

Returns string | null
- Defined in src/v2/parsing/inference/field/simpleField.ts:25

Methods

toString

toString(): string
Returns a readable scalar representation.

Returns string
- Defined in src/v2/parsing/inference/field/simpleField.ts:53