Class Ark7ModelMetadata

constructor

• new Ark7ModelMetadata(cls: ModelClass<any>, name?: string): Ark7ModelMetadata

  Parameters

  • cls: ModelClass<any>
  • Optionalname: string

  Returns Ark7ModelMetadata

combinedFields

discriminations

fields

modelClass

name

superClass

StaticdiscriminationsMap

classes

• get classes(): ModelClass<any>[]

  Return related classes with priority from low to high.

  Returns ModelClass<any>[]

configs

• get configs(): ConfigOptions

  Returns ConfigOptions

• set configs(configs: ConfigOptions): void

  Parameters

  • configs: ConfigOptions

  Returns void

enums

• get enums(): object

  Returns object

enumType

• get enumType(): "string" | "number"

  Returns "string" | "number"

enumValues

• get enumValues(): string[] | number[]

  Returns string[] | number[]

isCustomizedType

• get isCustomizedType(): boolean

  Returns boolean

isEnum

• get isEnum(): boolean

  Returns boolean

tags

• get tags(): string[]

  All the tags for the fields.

  Returns string[]

createCombinedFields

• createCombinedFields(manager: Manager): void

  Parameters

  • manager: Manager

  Returns void

getFieldsByTag

• getFieldsByTag(tag: string): CombinedModelField[]

  Parameters

  • tag: string

  Returns CombinedModelField[]

toObject

• toObject(obj: any, options?: DocumentToObjectOptions): any

  Parameters

  • obj: any
  • options: DocumentToObjectOptions = {}

  Returns any

StaticaddDiscriminations

• addDiscriminations(parentCls: ModelClass<any>, cls: ModelClass<any>): void

  Parameters

  • parentCls: ModelClass<any>
  • cls: ModelClass<any>

  Returns void

StaticgetDiscriminations

• getDiscriminations(cls: ModelClass<any>): ModelClass<any>[]

  Parameters

  • cls: ModelClass<any>

  Returns ModelClass<any>[]