Class ChannelCollection

Collection of Channels

Hierarchy

Constructors

constructor

Properties

#objects #storage client getUnderlyingObject updateUnderlyingObject

Methods

create createGroup delete entries fetch filter find forEach get getOrCreate getOrPartial has isPartial keys map size toList values

Constructors

constructor

Properties

Private #objects

#objects: ReactiveMap<string, Channel> = ...

Private #storage

#storage: ObjectStorage<HydratedChannel> = ...

Readonly client

client: Client

Readonly getUnderlyingObject

getUnderlyingObject: ((id: string) => HydratedChannel)

Type declaration

    • (id: string): HydratedChannel

    • Parameters

      • id: string

      Returns HydratedChannel

Readonly updateUnderlyingObject

updateUnderlyingObject: SetStoreFunction<Record<string, HydratedChannel>>

Methods

create

  • Create a new instance of an object

    Parameters

    • id: string

      Id

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

      Type

    • instance: Channel

      Instance

    • context: unknown

      Context

    • Optional data: unknown

      Data

    Returns void

createGroup

delete

entries

fetch

filter

find

forEach

get

getOrCreate

  • Get or create

    Parameters

    • id: string

      Id

    • data: {
          _id: string;
          channel_type: "SavedMessages";
          user: string;
      } | {
          _id: string;
          active: boolean;
          channel_type: "DirectMessage";
          last_message_id?: null | string;
          recipients: string[];
      } | {
          _id: string;
          channel_type: "Group";
          description?: null | string;
          icon?: null | {
              _id: string;
              content_type: string;
              deleted?: null | boolean;
              filename: string;
              message_id?: null | string;
              metadata: {
                  type: "File";
              } | {
                  type: "Text";
              } | {
                  height: number;
                  type: "Image";
                  width: number;
              } | {
                  height: number;
                  type: "Video";
                  width: number;
              } | {
                  type: "Audio";
              };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          };
          last_message_id?: null | string;
          name: string;
          nsfw?: boolean;
          owner: string;
          permissions?: null | number;
          recipients: string[];
      } | {
          _id: string;
          channel_type: "TextChannel";
          default_permissions?: null | {
              a: number;
              d: number;
          };
          description?: null | string;
          icon?: null | {
              _id: string;
              content_type: string;
              deleted?: null | boolean;
              filename: string;
              message_id?: null | string;
              metadata: {
                  type: "File";
              } | {
                  type: "Text";
              } | {
                  height: number;
                  type: "Image";
                  width: number;
              } | {
                  height: number;
                  type: "Video";
                  width: number;
              } | {
                  type: "Audio";
              };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          };
          last_message_id?: null | string;
          name: string;
          nsfw?: boolean;
          role_permissions?: {
              [key: string]: components["schemas"]["OverrideField"];
          };
          server: string;
      } | {
          _id: string;
          channel_type: "VoiceChannel";
          default_permissions?: null | {
              a: number;
              d: number;
          };
          description?: null | string;
          icon?: null | {
              _id: string;
              content_type: string;
              deleted?: null | boolean;
              filename: string;
              message_id?: null | string;
              metadata: {
                  type: "File";
              } | {
                  type: "Text";
              } | {
                  height: number;
                  type: "Image";
                  width: number;
              } | {
                  height: number;
                  type: "Video";
                  width: number;
              } | {
                  type: "Audio";
              };
              object_id?: null | string;
              reported?: null | boolean;
              server_id?: null | string;
              size: number;
              tag: string;
              user_id?: null | string;
          };
          name: string;
          nsfw?: boolean;
          role_permissions?: {
              [key: string]: components["schemas"]["OverrideField"];
          };
          server: string;
      }

      Data

    • isNew: boolean = false

      Whether this object is new

    Returns Channel

getOrPartial

has

isPartial

keys

map

size

toList

values

On This Page

Generated using TypeDoc