Class ChannelUnreadCollection

Readonlyclient

ReadonlygetUnderlyingObject

ReadonlyupdateUnderlyingObject

create

• create(
      id: string,
      type:
          | "user"
          | "server"
          | "channel"
          | "bot"
          | "channelUnread"
          | "channelWebhook"
          | "emoji"
          | "message"
          | "serverMember"
          | "session",
      instance: ChannelUnread,
      context: unknown,
      data?: unknown,
  ): 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: ChannelUnread

    Instance
  • context: unknown

    Context
  • Optionaldata: unknown

    Data

  Returns void

delete

• delete(id: string): void

  Delete an object

  Parameters

  • id: string

    Id

  Returns void

entries

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

  Iterable of key, value pairs in the map

  Returns IterableIterator<[string, ChannelUnread]>

  Iterable

filter

• filter(
      predicate: (value: ChannelUnread, key: string) => boolean,
  ): ChannelUnread[]

  Filter the collection by a given predicate

  Parameters

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

    Predicate to satisfy

  Returns ChannelUnread[]

find

• find(
      predicate: (value: ChannelUnread, key: string) => boolean,
  ): undefined | ChannelUnread

  Find some value based on a predicate

  Parameters

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

    Predicate to satisfy

  Returns undefined | ChannelUnread

forEach

• forEach(
      cb: (
          value: ChannelUnread,
          key: string,
          map: Map<string, ChannelUnread>,
      ) => void,
  ): void

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

  Parameters

  • cb: (value: ChannelUnread, key: string, map: Map<string, ChannelUnread>) => void

    Callback for each pair

  Returns void

  Iterable

get

• get(id: string): undefined | ChannelUnread

  Get an existing object

  Parameters

  • id: string

    Id

  Returns undefined | ChannelUnread

  Object

has

• has(id: string): boolean

  Check whether an id exists in the Collection

  Parameters

  • id: string

    Id

  Returns boolean

  Whether it exists

isPartial

• isPartial(id: string): 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: (value: ChannelUnread, key: string) => O): O[]

  Map the collection using a given callback

  Type Parameters

  • O

  Parameters

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

    Callback

  Returns O[]

size

• size(): number

  Number of stored objects

  Returns number

  Size

toList

• toList(): ChannelUnread[]

  List of values in the map

  Returns ChannelUnread[]

  List

values

• values(): IterableIterator<ChannelUnread>

  Iterable of values in the map

  Returns IterableIterator<ChannelUnread>

  Iterable