Model

Callable

• Model<T>(packageName: string, modelName: keyof BaseModelSchemas, schema: Constructable<ModelSchema<T>>): (constructor: any) => void

---

• A @Model is a class decorator and must be placed on top of a class representing a model.

  • A model must also extend a base model class.
  • For type safety, the type of model being decorated is passed to the decorator.

  @example

  @Model<MyModel>('@example', 'region', MyModelSchema)
  export class MyModel extends Region { ... }

  @group

  Decorators

  @see

  • Definition of Models.
  • App, Region, and Server for the base models you can extend.

  ---

  Type parameters

  • T: UnknownModel

  Parameters

  • packageName: string

    The name of the package under which the model is registered. Selecting a unique package name helps avoid collisions between same model class names across different libraries. You will reuse the same package name throughout your library for different Octo components you create.

  • modelName: keyof BaseModelSchemas

    The name of the base model you are extending, e.g. region for Region.

  • schema: Constructable<ModelSchema<T>>

    The schema of the model.

  Returns (constructor: any) => void

  The decorated class.

  • • (constructor: any): void

    • Parameters

      • constructor: any

      Returns void