Class GuildBasedResource<T, S>

constructor

• new GuildBasedResource<T = any, S = any>(
      cache: Cache,
      client: UsingClient,
  ): GuildBasedResource<T, S>

  Type Parameters

  • T = any
  • S = any

  Parameters

  • cache: Cache
  • client: UsingClient

  Returns GuildBasedResource<T, S>

Readonlyclient

namespace

adapter

• get adapter(): Adapter

  Returns Adapter

addToRelationship

• addToRelationship(id: string | string[], guild: string): Awaitable<void>

  Parameters

  • id: string | string[]
  • guild: string

  Returns Awaitable<void>

bulk

• bulk(ids: string[], guild: string): (T & { guild_id: string })[]

  Parameters

  • ids: string[]
  • guild: string

  Returns (T & { guild_id: string })[]

contains

• contains(id: string, guild: string): ReturnCache<boolean>

  Parameters

  • id: string
  • guild: string

  Returns ReturnCache<boolean>

count

• count(guild: string): number

  Parameters

  • guild: string

  Returns number

filter

• filter(data: any, id: string, guild_id: string, from: CacheFrom): boolean

  Parameters

  • data: any
  • id: string
  • guild_id: string
  • from: CacheFrom

  Returns boolean

flush

• flush(guild?: string & {} | "*"): unknown[] | Promise<unknown[]>

  Parameters

  • guild: string & {} | "*" = '*'

  Returns unknown[] | Promise<unknown[]>

get

• get(
      id: string,
      guild: string,
  ): ReturnCache<undefined | T & { guild_id: string }>

  Parameters

  • id: string
  • guild: string

  Returns ReturnCache<undefined | T & { guild_id: string }>

getToRelationship

• getToRelationship(guild: string): Awaitable<string[]>

  Parameters

  • guild: string

  Returns Awaitable<string[]>

hashGuildId

• hashGuildId(guild: string, id: string): string

  Parameters

  • guild: string
  • id: string

  Returns string

hashId

• hashId(id: string): string

  Parameters

  • id: string

  Returns string

keys

• keys(guild: string): string[]

  Parameters

  • guild: string

  Returns string[]

parse

• parse(data: any, id: string, guild_id: string): any

  Parameters

  • data: any
  • id: string
  • guild_id: string

  Returns any

patch

• patch(from: CacheFrom, __keys: string, guild: string, data: S): void

  Parameters

  • from: CacheFrom
  • __keys: string
  • guild: string
  • data: S

  Returns void

• patch(from: CacheFrom, __keys: [string, any][], guild: string): void

  Parameters

  • from: CacheFrom
  • __keys: [string, any][]
  • guild: string

  Returns void

remove

• remove(id: string | string[], guild: string): Awaitable<void>

  Parameters

  • id: string | string[]
  • guild: string

  Returns Awaitable<void>

removeIfNI

• removeIfNI(
      intent:
          | "Guilds"
          | "GuildMembers"
          | "GuildModeration"
          | "GuildExpressions"
          | "GuildIntegrations"
          | "GuildWebhooks"
          | "GuildInvites"
          | "GuildVoiceStates"
          | "GuildPresences"
          | "GuildMessages"
          | "GuildMessageReactions"
          | "GuildMessageTyping"
          | "DirectMessages"
          | "DirectMessageReactions"
          | "DirectMessageTyping"
          | "MessageContent"
          | "GuildScheduledEvents"
          | "AutoModerationConfiguration"
          | "AutoModerationExecution"
          | "GuildMessagePolls"
          | "DirectMessagePolls"
          | "NonPrivilaged"
          | "OnlyPrivilaged",
      id: string | string[],
      guildId: string,
  ): Awaitable<void>

  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"
  • id: string | string[]
  • guildId: string

  Returns Awaitable<void>

removeRelationship

• removeRelationship(id: string | string[]): Awaitable<void>

  Parameters

  • id: string | string[]

  Returns Awaitable<void>

removeToRelationship

• removeToRelationship(id: string | string[], guild: string): Awaitable<void>

  Parameters

  • id: string | string[]
  • guild: string

  Returns Awaitable<void>

set

• set(from: CacheFrom, __keys: string, guild: string, data: S): void

  Parameters

  • from: CacheFrom
  • __keys: string
  • guild: string
  • data: S

  Returns void

• set(from: CacheFrom, __keys: [string, S][], guild: string): void

  Parameters

  • from: CacheFrom
  • __keys: [string, S][]
  • guild: string

  Returns void

setIfNI

• setIfNI(
      from: CacheFrom,
      intent:
          | "Guilds"
          | "GuildMembers"
          | "GuildModeration"
          | "GuildExpressions"
          | "GuildIntegrations"
          | "GuildWebhooks"
          | "GuildInvites"
          | "GuildVoiceStates"
          | "GuildPresences"
          | "GuildMessages"
          | "GuildMessageReactions"
          | "GuildMessageTyping"
          | "DirectMessages"
          | "DirectMessageReactions"
          | "DirectMessageTyping"
          | "MessageContent"
          | "GuildScheduledEvents"
          | "AutoModerationConfiguration"
          | "AutoModerationExecution"
          | "GuildMessagePolls"
          | "DirectMessagePolls"
          | "NonPrivilaged"
          | "OnlyPrivilaged",
      id: string,
      guildId: string,
      data: S,
  ): void

  Parameters

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

  Returns void

values

• values(guild: string): (T & { guild_id: string })[]

  Parameters

  • guild: string

  Returns (T & { guild_id: string })[]