Class ModelPack

A model pack is a combination of a domain and a reference to a model within that domain.

Its domain contains at least all the types and models that are used in the model pack, so that the model can be resolved.

Implements

Constructors

constructor

Properties

_domain? _reference?

Accessors

channels content domain methods reference values version versions

Methods

deserializeAsync deserializeSync serialize

Constructors

constructor

  • new ModelPack(domain?, reference?): ModelPack

  • Parameters

    • Optional domain: Domain
    • Optional reference: string

    Returns ModelPack

Properties

Private Optional _domain

_domain?: Domain

Private Optional _reference

_reference?: string

Accessors

channels

  • get channels(): InterfaceChannel[]

  • All channels that have to exist in the model that is referenced by the model pack.

    Returns InterfaceChannel[]

content

  • get content(): Model

  • The model that is referenced by the model pack.

    Returns Model

domain

  • get domain(): Domain

  • The domain that contains the model.

    Returns Domain

methods

  • get methods(): InterfaceMethod[]

  • All methods that have to be implemented by the model that is referenced by the model pack.

    Returns InterfaceMethod[]

reference

  • get reference(): string

  • The reference to the model within the domain.

    Returns string

values

  • get values(): InterfaceValue[]

  • All values that have to exist in the model that is referenced by the model pack.

    Returns InterfaceValue[]

version

  • get version(): undefined | string

  • The version of the model that is referenced by the model pack.

    Returns undefined | string

versions

  • get versions(): string[]

  • The model versions that are fulfilled by the model that is referenced by the model pack.

    Returns string[]

Methods

deserializeAsync

deserializeSync

serialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc