Class Type

A type is a description of a data structure.

Implements

Constructors

constructor

Properties

_hologram? _intersection? _list? _map? _optional? _primitive? _reference? _special? _tuple? _union? _version?

Accessors

hologram intersection list map optional primitive reference special tuple union version

Methods

deserializeAsync deserializeSync serialize

Constructors

constructor

Properties

Private Optional _hologram

_hologram?: HologramType

Private Optional _intersection

_intersection?: Type[]

Private Optional _list

_list?: Type

Private Optional _map

_map?: TypeMapEntry[]

Private Optional _optional

_optional?: Type

Private Optional _primitive

_primitive?: number

Private Optional _reference

_reference?: string

Private Optional _special

_special?: number

Private Optional _tuple

_tuple?: TypeTupleEntry[]

Private Optional _union

_union?: Type[]

Private Optional _version

_version?: string

Accessors

hologram

  • get hologram(): undefined | HologramType

  • The hologram type.

    It is a type that represents a hologram.

    Returns undefined | HologramType

intersection

  • get intersection(): undefined | Type[]

  • The intersection type.

    It is a list of types that represents an intersection.

    Returns undefined | Type[]

list

  • get list(): undefined | Type

  • The list type.

    It is a type that represents a list.

    Returns undefined | Type

map

  • get map(): undefined | TypeMapEntry[]

  • The map type.

    It is a list of map entries.

    Returns undefined | TypeMapEntry[]

optional

  • get optional(): undefined | Type

  • The optional type.

    It is a type that represents an optional value.

    Returns undefined | Type

primitive

  • get primitive(): undefined | number

  • The primitive type.

    It is a number that represents a primitive type.

    Returns undefined | number

reference

  • get reference(): undefined | string

  • The reference to the type.

    This is a reference to a type within a domain. It is a dot-separated path to the type, starting from the domain.

    Example: myDomain.MyType@1.0.0

    Returns undefined | string

special

  • get special(): undefined | number

  • The special type.

    It is a number that represents a special type.

    Returns undefined | number

tuple

  • get tuple(): undefined | TypeTupleEntry[]

  • The tuple type.

    It is a list of tuple entries.

    Returns undefined | TypeTupleEntry[]

union

  • get union(): undefined | Type[]

  • The union type.

    It is a list of types that represents a union.

    Returns undefined | Type[]

version

  • get version(): undefined | string

  • The version of the type.

    It is a version string that is used to identify the version of the type.

    The format of the version string is a dot-separated pat, followed by an at sign and three numbers separated by dots.

    Example: myDomain.MyType@1.0.0

    Returns undefined | string

Methods

deserializeAsync

deserializeSync

serialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc