Class Tree

_class

_nodes

_optional

_requires

_special

validationFailures

[iterator]

• [iterator](): {
      next: (() => {
          done: boolean;
          value: string;
      } | {
          done: boolean;
          value?: undefined;
      });
  }

• Iterator

  Allows the instance to be used as an iterator

  Returns {
      next: (() => {
          done: boolean;
          value: string;
      } | {
          done: boolean;
          value?: undefined;
      });
  }

  a key (field name) of the parent

  • next: (() => {
        done: boolean;
        value: string;
    } | {
        done: boolean;
        value?: undefined;
    })

    • • (): {
            done: boolean;
            value: string;
        } | {
            done: boolean;
            value?: undefined;
        }

      • Returns {
            done: boolean;
            value: string;
        } | {
            done: boolean;
            value?: undefined;
        }

  Name

  [Symbol.iterator]

class

• class(): string

• Class

  Returns a string representation of the Node's class

  Returns string

  string

  Name

  class

  Access

  public

clean

• clean(value?, level?): null | Record<any, any>

• Clean

  Goes through each of the values in the Object, cleans it, stores it, and returns a new Object

  Parameters

  • Optional value: null | Record<any, any>

    The value to clean
  • Optional level: string[]

  Returns null | Record<any, any>

  the cleaned object values

  Name

  clean

  Access

  public

contains

• contains(key): boolean

• Contains

  Returns whether a specific key exists in the parent

  Parameters

  • key: string

    The key to check the existence of

  Returns boolean

  bool

  Name

  contains

  Access

  public

get

• get(key, def?): Base

• Get

  Returns the node associated with the given key

  Parameters

  • key: string

    The key associated with the node to get
  • Optional def: Base

    If set, returned when a node is not found

  Returns Base

  the child node associated with the key

  Name

  get

  Access

  public

keys

• keys(): string[]

• Keys

  Returns a list of the node names in the parent

  Returns string[]

  a list of keys (field names) in the parent

  Name

  keys

  Access

  public

optional

• optional(value?): boolean | void

• Optional

  Getter/Setter for the optional flag

  Parameters

  • Optional value: boolean

    The value to set

  Returns boolean | void

  bool | void

  Name

  optional

requires

• requires(require?): void | Record<string, string[]>

• Requires

  Sets or gets the require rules used to validate the Parent

  Parameters

  • Optional require: Record<string, string | string[]>

    An Object expressing requirements of fields

  Returns void | Record<string, string[]>

  The object of requirements for get, or void for set

  Name

  requires

  Access

  public

special

• special(name, value?): any

• Special

  Getter/Setter method for special values associated with nodes that are not fields. To retrieve a value or values, pass only the name or names, to set a single special value, pass a name and value

  Parameters

  • name: string

    The name of the value to either set or get
  • Optional value: any

    The value to set, must be something that can be converted directly to JSON

  Returns any

  mixed | void

  Name

  special

  Access

  public

toJSON

• toJSON(): string

• To JSON

  Returns a JSON string representation of the instance

  Returns string

  json reprentation of the node

  Name

  toJSON

  Access

  public

Static create

• create(details): Base

• Create

  Figure out the child node type necessary and create an instance of it

  Parameters

  • details: Record<string, any>

    An object describing a data point

  Returns Base

  any

  Name

  create

  Access

  public

  Static

Static register

• register(name, constructor?): void

• Register

  Registers the classes that can be children because we can't require them in this file as webpack can't handle file A that requires file B that requires file A

  Parameters

  • name: string | object

    Name / value object of all classes to register, or the name of the constructor that will be added
  • Optional constructor: any

    The class to associate with the given name

  Returns void

  Name

  register

  Access

  public

  Static