Class Cache

constructor

• new Cache(
      intents: number,
      adapter: Adapter,
      disabledCache: DisabledCache,
      client: UsingClient,
  ): Cache

  Parameters

  • intents: number
  • adapter: Adapter
  • disabledCache: DisabledCache
  • client: UsingClient

  Returns Cache

Optional__logger__

adapter

Optionalbans

Optionalchannels

Optionalemojis

Optionalguilds

intents

Optionalmembers

Optionalmessages

Optionaloverwrites

Optionalpresences

Optionalroles

OptionalstageInstances

Optionalstickers

Optionalusers

OptionalvoiceStates

hasChannelsIntent

• get hasChannelsIntent(): boolean

  Returns boolean

hasDirectMessages

• get hasDirectMessages(): boolean

  Returns boolean

hasGuildExpressionsIntent

• get hasGuildExpressionsIntent(): boolean

  Returns boolean

hasGuildMembersIntent

• get hasGuildMembersIntent(): boolean

  Returns boolean

hasGuildsIntent

• get hasGuildsIntent(): boolean

  Returns boolean

hasModerationIntent

• get hasModerationIntent(): boolean

  Returns boolean

hasPrenseceUpdates

• get hasPrenseceUpdates(): boolean

  Returns boolean

hasRolesIntent

• get hasRolesIntent(): boolean

  Returns boolean

hasVoiceStatesIntent

• get hasVoiceStatesIntent(): boolean

  Returns boolean

buildCache

• buildCache(disabledCache: DisabledCache, client: UsingClient): void

  Parameters

  • disabledCache: DisabledCache
  • client: UsingClient

  Returns void

bulkGet

• bulkGet(
      keys: (
          | readonly [NonGuildBased | GuildRelated, string]
          | readonly [GuildBased, string, string]
      )[],
  ): Promise<
      Partial<
          {
              bans: GuildBan[];
              channels: NonNullable<ReturnCache<undefined | AllChannels>>[];
              emojis: NonNullable<
                  ReturnCache<undefined | ApplicationEmoji | GuildEmoji>,
              >[];
              guilds: Guild<"cached">[];
              members: GuildMember[];
              messages: Message[];
              overwrites: {
                  allow: PermissionsBitField;
                  deny: PermissionsBitField;
                  guildId: string;
                  id: string;
                  type: number;
              }[][];
              presences: (
                  Omit<GatewayPresenceUpdate, "user"> & { id: string; user_id: string } & {
                      guild_id: string;
                  }
              )[];
              roles: GuildRole[];
              stageInstances: (APIStageInstance & { guild_id: string })[];
              stickers: Sticker[];
              users: User[];
              voiceStates: VoiceState[];
          },
      >,
  >

  Parameters

  • keys: (
        | readonly [NonGuildBased | GuildRelated, string]
        | readonly [GuildBased, string, string]
    )[]

  Returns Promise<
      Partial<
          {
              bans: GuildBan[];
              channels: NonNullable<ReturnCache<undefined | AllChannels>>[];
              emojis: NonNullable<
                  ReturnCache<undefined | ApplicationEmoji | GuildEmoji>,
              >[];
              guilds: Guild<"cached">[];
              members: GuildMember[];
              messages: Message[];
              overwrites: {
                  allow: PermissionsBitField;
                  deny: PermissionsBitField;
                  guildId: string;
                  id: string;
                  type: number;
              }[][];
              presences: (
                  Omit<GatewayPresenceUpdate, "user"> & { id: string; user_id: string } & {
                      guild_id: string;
                  }
              )[];
              roles: GuildRole[];
              stageInstances: (APIStageInstance & { guild_id: string })[];
              stickers: Sticker[];
              users: User[];
              voiceStates: VoiceState[];
          },
      >,
  >

bulkPatch

• bulkPatch(
      keys: (
          | readonly [CacheFrom, NonGuildBased, any, string]
          | readonly [CacheFrom, GuildBased | GuildRelated, any, string, string]
      )[],
  ): Promise<void>

  Parameters

  • keys: (
        | readonly [CacheFrom, NonGuildBased, any, string]
        | readonly [CacheFrom, GuildBased | GuildRelated, any, string, string]
    )[]

  Returns Promise<void>

bulkSet

• bulkSet(
      keys: (
          | readonly [CacheFrom, NonGuildBased, any, string]
          | readonly [CacheFrom, GuildBased | GuildRelated, any, string, string]
      )[],
  ): Promise<void>

  Parameters

  • keys: (
        | readonly [CacheFrom, NonGuildBased, any, string]
        | readonly [CacheFrom, GuildBased | GuildRelated, any, string, string]
    )[]

  Returns Promise<void>

flush

• flush(): void

  Returns void

hasIntent

• hasIntent(
      intent:
          | "Guilds"
          | "GuildMembers"
          | "GuildModeration"
          | "GuildExpressions"
          | "GuildIntegrations"
          | "GuildWebhooks"
          | "GuildInvites"
          | "GuildVoiceStates"
          | "GuildPresences"
          | "GuildMessages"
          | "GuildMessageReactions"
          | "GuildMessageTyping"
          | "DirectMessages"
          | "DirectMessageReactions"
          | "DirectMessageTyping"
          | "MessageContent"
          | "GuildScheduledEvents"
          | "AutoModerationConfiguration"
          | "AutoModerationExecution"
          | "GuildMessagePolls"
          | "DirectMessagePolls"
          | "NonPrivilaged"
          | "OnlyPrivilaged",
  ): boolean

  Parameters

  • intent:
        | "Guilds"
        | "GuildMembers"
        | "GuildModeration"
        | "GuildExpressions"
        | "GuildIntegrations"
        | "GuildWebhooks"
        | "GuildInvites"
        | "GuildVoiceStates"
        | "GuildPresences"
        | "GuildMessages"
        | "GuildMessageReactions"
        | "GuildMessageTyping"
        | "DirectMessages"
        | "DirectMessageReactions"
        | "DirectMessageTyping"
        | "MessageContent"
        | "GuildScheduledEvents"
        | "AutoModerationConfiguration"
        | "AutoModerationExecution"
        | "GuildMessagePolls"
        | "DirectMessagePolls"
        | "NonPrivilaged"
        | "OnlyPrivilaged"

  Returns boolean

onPacket

• onPacket(event: GatewayDispatchPayload): Promise<void>

  Parameters

  • event: GatewayDispatchPayload

  Returns Promise<void>

testAdapter

• testAdapter(): Promise<void>

  Returns Promise<void>