APIs

Show:

Methods

check_options_correctness_against_schema

()

check correctness of option fields against scheme

check_schema_correctness

(
  • schema
)

ensure correctness of a schema object.

Parameters:

  • schema Object

extract_all_fields

()

extract a list of all possible fields for a schema (by walking up the inheritance chain)

get_base_schema

(
  • schema
)

Parameters:

  • schema Object

Returns:

:

initialize_field

(
  • field
  • value
)

Parameters:

  • field Object
  • value Object

Returns:

:

initialize_field_array

(
  • field
  • valueArray
)
Array

Parameters:

  • field Object
  • valueArray Object

Returns:

Array:

registerEnumeration

(
  • schema
)
Enum

Parameters:

  • schema Object
    • name String
    • enumValues Key:Name, value:values

      []

    • encode
    • decode
    • typedEnum
    • defaultValue

Returns:

Enum:

registerObject

(
  • schema
  • optional_folder
)
Function

register a new object type from a schema

Parameters:

  • schema Object
  • optional_folder String

Returns:

Function:

the object constructor.