Class ObjectField

constructor

• new ObjectField(serverResponse: StringDict, indentLevel?: number): ObjectField

  Parameters

  • serverResponse: StringDict
  • indentLevel: number = 0

  Returns ObjectField

Readonlyfields

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.

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.

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.

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.

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.

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.

toString

• toString(): string

  Returns a string representation of an object.

  Returns string

toStringFromList

• toStringFromList(): string

  Returns string