Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ShareCfgModelList<T>

A Model that has an entries key and lists all results from it.

Type parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • ctor: { constructor: any }
      • constructor: function
        • new __type(id: number): T

        • Parameters

          • id: number

          Returns T

    • Default value key: string = "id"

    Returns ShareCfgModelList

Properties

ctor

ctor: { constructor: any }

Type declaration

  • constructor: function
    • new __type(id: number): T

    • Parameters

      • id: number

      Returns T

entries

entries: Array<T> = new Array<T>()

key

key: string

resolver

resolver: { constructor: any }

Type declaration

Optional resolverOptions

resolverOptions: ModelResolverOptions

Methods

load

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

  • Parameters

    • Rest ...args: 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

modify

  • modify(...args: any[]): any[]

  • Called before the returned entries are mapped into an array.

    Parameters

    • Rest ...args: any[]

      Resolved dependencies

    Returns any[]

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