Class OutboundObject<T>

constructor

• new OutboundObject<T>(client, method, lazyLoaded?, cached?, initialLoadingCount?, sortBy?): OutboundObject<T>

• Type Parameters

  • T extends IdObject

  Parameters

  • client: WebsocketClient

  • method: string

  • Optional lazyLoaded: boolean

  • Optional cached: boolean

  • Optional initialLoadingCount: number

  • Optional sortBy: ((a, b) => number)

    • • (a, b): number

      • Parameters

        • a: T

        • b: T

        Returns number

  Returns OutboundObject<T>

Optional Readonly cached

all

• get all(): T[]

• Returns T[]

isEmpty

• get isEmpty(): boolean

• Returns boolean

length

• get length(): number

• Returns number

loadedLength

• get loadedLength(): number

• Returns number

loading

• get loading(): boolean

• Returns boolean

target

• get target(): any

• Returns any

awaitGroupDataUpdate

• awaitGroupDataUpdate(): Promise<T[]>

• Returns Promise<T[]>

awaitIdDataUpdate

• awaitIdDataUpdate(): Promise<T>

• Returns Promise<T>

get

• get(id): Promise<T>

• Parameters

  • id: number

  Returns Promise<T>

getForGroup

• getForGroup(groupId): Promise<T[]>

• Parameters

  • groupId: number

  Returns Promise<T[]>

load

• load(count?): Promise<void>

• Parameters

  • Optional count: number

  Returns Promise<void>

update

• update(callback): void

• The contained data can be modified within the callback method

  Parameters

  • callback: ((data) => void)

    • • (data): void

      • Parameters

        • data: T[]

        Returns void

  Returns void