Class ClassCollection<T, V>

Readonly getUnderlyingObject

Readonly updateUnderlyingObject

create

• create(id, type, instance, context, data?): void

• Create a new instance of an object

  Parameters

  • id: string

    Id

  • type: "user" | "server" | "channel" | "bot" | "channelUnread" | "channelWebhook" | "emoji" | "message" | "serverMember" | "session"

    Type

  • instance: T

    Instance

  • context: unknown

    Context

  • Optional data: unknown

    Data

  Returns void

delete

• delete(id): void

• Delete an object

  Parameters

  • id: string

    Id

  Returns void

entries

• entries(): IterableIterator<[string, T]>

• Iterable of key, value pairs in the map

  Returns IterableIterator<[string, T]>

  Iterable

filter

• filter(predicate): T[]

• Filter the collection by a given predicate

  Parameters

  • predicate: ((value, key) => boolean)

    Predicate to satisfy

    • • (value, key): boolean

      • Parameters

        • value: T

        • key: string

        Returns boolean

  Returns T[]

find

• find(predicate): undefined | T

• Find some value based on a predicate

  Parameters

  • predicate: ((value, key) => boolean)

    Predicate to satisfy

    • • (value, key): boolean

      • Parameters

        • value: T

        • key: string

        Returns boolean

  Returns undefined | T

forEach

• forEach(cb): void

• Execute a provided function over each key, value pair in the map

  Parameters

  • cb: ((value, key, map) => void)

    Callback for each pair

    • • (value, key, map): void

      • Parameters

        • value: T

        • key: string

        • map: ReactiveMap<string, T>

        Returns void

  Returns void

  Iterable

get

• get(id): undefined | T

• Get an existing object

  Parameters

  • id: string

    Id

  Returns undefined | T

  Object

has

• has(id): boolean

• Check whether an id exists in the Collection

  Parameters

  • id: string

    Id

  Returns boolean

  Whether it exists

isPartial

• isPartial(id): boolean

• Check whether an object is partially defined

  Parameters

  • id: string

    Id

  Returns boolean

  Whether it is a partial

keys

• keys(): IterableIterator<string>

• Iterable of keys in the map

  Returns IterableIterator<string>

  Iterable

map

• map<O>(cb): O[]

• Map the collection using a given callback

  Type Parameters

  • O

  Parameters

  • cb: ((value, key) => O)

    Callback

    • • (value, key): O

      • Parameters

        • value: T

        • key: string

        Returns O

  Returns O[]

size

• size(): number

• Number of stored objects

  Returns number

  Size

toList

• toList(): T[]

• List of values in the map

  Returns T[]

  List

values

• values(): IterableIterator<T>

• Iterable of values in the map

  Returns IterableIterator<T>

  Iterable