Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Model<T>

The Model class is the base class where all deriverative model classes should inherit from.

All Model-derived classes are required to implement a load method to load its properties to properly inject itself on the endpoints.

Type parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Model(resolver: { constructor: any }): Model

  • Parameters

    • resolver: { constructor: any }
      • constructor: function

        • Parameters

          Returns T

    Returns Model

Properties

resolver

resolver: { constructor: any }

Type declaration

  • constructor: function

    • Parameters

      Returns T

Optional resolverOptions

resolverOptions: ModelResolverOptions

Methods

load

  • load(...args: unknown[]): Promise<void>

  • Loads any required properties for the deriverative model. Anything loaded by this method will be accessible later on during instantiation.

    Parameters

    • Rest ...args: unknown[]

      the arguments passed by the resolvers.

    Returns Promise<void>

loadComplete

  • loadComplete(): void

  • Called after all nested Models' dependencies are resolved. Useful if you require certain properties only available after it being resolved.

    Returns void

mixin

  • mixin(model: Model<T>): void

  • Applies the provided model to this instance.

    Parameters

    • model: Model<T>

      The model to be applied.

    Returns void

resolve

  • resolve(resolver: Resolver): Promise<void>

  • Resolves nested Models that was instanced inside the parent including those nested in objects and arrays.

    Parameters

    • resolver: Resolver

      The resolver to use.

    Returns Promise<void>

run

  • Runs the entire lifecycle of this model.

    Parameters

    • Default value raw: boolean = false

      Whether to return itself or the serialized version

    • Default value resolver: Resolver = null

      The resolver to use for model serialization

    Returns Promise<Object | IModel>

serialize

  • serialize(): Object

  • Serializes public properties including those nested inside arrays and objects into an Object.

    Returns Object

setResolverDefaults

  • setResolverDefaults(token: string, repo: string, region: ResolverRegion): void

Generated using TypeDoc