Class EntitySchema<E, R, ERawSchema>

Wrapper around raw entity schemas from the Schema. You should never have to create this object yourself. Instead, retrieve these objects from the methods in the Schema class.

Type Parameters

Hierarchy

  • EntitySchema

Constructors

Accessors

  • get description(): ERawSchema["description"]
  • A short description which can be used as documentation for the entity schema.

    Returns ERawSchema["description"]

  • get final(): ERawSchema["final"]
  • True if the current entity schema is a primitive type such as string or int

    Returns ERawSchema["final"]

  • get type(): ERawSchema["type"]
  • The type of the entity schema. This can also be referred to as the entity schema's name.

    Returns ERawSchema["type"]

Methods

Generated using TypeDoc