Class ObjectField

Object-valued inference field.

Hierarchy

BaseField
- ObjectField

Index

Constructors

Properties

_indentLevel confidence fields locations

Accessors

listFields objectFields simpleFields

Methods

getListField getObjectField getSimpleField toString toStringFromList

Constructors

constructor

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

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.

`Readonly`fields

fields: InferenceFields

Nested fields carried by this object.

locations

locations: FieldLocation[] | undefined

Optional list of source locations for this field.

Accessors

listFields

get listFields(): Map<string, ListField>
Retrieves the list sub-fields in the object.

Returns Map<string, ListField>
A map of field names to their corresponding ListField instances.
- Defined in src/v2/parsing/inference/field/objectField.ts:32

objectFields

get objectFields(): Map<string, ObjectField>
Retrieves the object sub-fields in the object.

Returns Map<string, ObjectField>
A map of field names to their corresponding ObjectField instances.
- Defined in src/v2/parsing/inference/field/objectField.ts:47

simpleFields

get simpleFields(): Map<string, SimpleField>
Retrieves the simple sub-fields in the object.

Returns Map<string, SimpleField>
A map of field names to their corresponding SimpleField instances.
- Defined in src/v2/parsing/inference/field/objectField.ts:17

Methods

getListField

getListField(fieldName: string): ListField
Retrieves a ListField by its name if it exists and is of the correct type.
Parameters
- fieldName: string
  The name of the field to retrieve.
Returns ListField
The ListField instance if it exists and is valid, or undefined if not.

Throws
If the field does not exist or is not of type ListField.
- Defined in src/v2/parsing/inference/field/objectField.ts:81

getObjectField

getObjectField(fieldName: string): ObjectField
Retrieves an ObjectField by its name if it exists and is of the correct type.
Parameters
- fieldName: string
  The name of the field to retrieve.
Returns ObjectField
The ObjectField instance if it exists and is valid, or undefined if not.

Throws
If the field does not exist or is not of type ObjectField.
- Defined in src/v2/parsing/inference/field/objectField.ts:99

getSimpleField

getSimpleField(fieldName: string): SimpleField
Retrieves a SimpleField by its name if it exists and is of the correct type.
Parameters
- fieldName: string
  The name of the field to retrieve.
Returns SimpleField
The SimpleField instance if it exists and is valid, or undefined if not.

Throws
If the field does not exist or is not of type SimpleField.
- Defined in src/v2/parsing/inference/field/objectField.ts:64

toString

toString(): string
Returns a readable representation of nested fields.

Returns string
- Defined in src/v2/parsing/inference/field/objectField.ts:116

toStringFromList

toStringFromList(): string
Returns a compact representation suitable for list items.

Returns string
- Defined in src/v2/parsing/inference/field/objectField.ts:121