Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Construct

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

cost

cost: { currency: number; gold: number }

Type declaration

  • currency: number
  • gold: number

currency

currency: Item

id

id: number

name

name: string

rate

rate: { name: string; percentage: number; pickup?: boolean }

Type declaration

  • name: string
  • percentage: number
  • Optional pickup?: boolean

resolver

resolver: { constructor: any }

Type declaration

Optional resolverOptions

resolverOptions: ModelResolverOptions

type

type: number

Methods

load

  • load(constructs: any[], codes: any[]): Promise<void>

  • Parameters

    • constructs: any[]
    • codes: any[]

    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

  • Applies the provided model to this instance.

    Parameters

    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