Class Client

constructor

• new Client(
      token: string,
      options?: ClientOptions,
      logCallback?: LogCallback,
      logThisArg?: any,
  ): Client

  Create a client.

  Parameters

  • token: string

    The bot's token.
  • options: ClientOptions = {}

    Client options.
  • logCallback: LogCallback = ...

    A callback to be used for logging events internally throughout the client.
  • OptionallogThisArg: any

    A value to use as this in the logCallback.

  Returns Client

cache

ReadonlyDISTYPE_VERSION

gateway

log

Readonlyoptions

rest

Readonlysystem

getChannelData

• getChannelData<
      T extends
          (
              | "name"
              | "type"
              | "id"
              | "position"
              | "managed"
              | "flags"
              | "applied_tags"
              | "thread_metadata"
              | "message_count"
              | "member_count"
              | "owner_id"
              | "total_message_sent"
              | "last_message_id"
              | "rate_limit_per_user"
              | "guild_id"
              | "permission_overwrites"
              | "parent_id"
              | "nsfw"
              | "last_pin_timestamp"
              | "recipients"
              | "application_id"
              | "icon"
              | "default_forum_layout"
              | "topic"
              | "default_auto_archive_duration"
              | "available_tags"
              | "default_thread_rate_limit_per_user"
              | "default_reaction_emoji"
              | "default_sort_order"
              | "bitrate"
              | "user_limit"
              | "rtc_region"
              | "video_quality_mode"
          )[],
  >(
      id: string,
      ...keys: T,
  ): Promise<Pick<CachedChannel, T[number]>>

  Tries to ensure channel data. Fetches data from the cache, then if data isn't found a rest request is made.

  Type Parameters

  • T extends (
        | "name"
        | "type"
        | "id"
        | "position"
        | "managed"
        | "flags"
        | "applied_tags"
        | "thread_metadata"
        | "message_count"
        | "member_count"
        | "owner_id"
        | "total_message_sent"
        | "last_message_id"
        | "rate_limit_per_user"
        | "guild_id"
        | "permission_overwrites"
        | "parent_id"
        | "nsfw"
        | "last_pin_timestamp"
        | "recipients"
        | "application_id"
        | "icon"
        | "default_forum_layout"
        | "topic"
        | "default_auto_archive_duration"
        | "available_tags"
        | "default_thread_rate_limit_per_user"
        | "default_reaction_emoji"
        | "default_sort_order"
        | "bitrate"
        | "user_limit"
        | "rtc_region"
        | "video_quality_mode"
    )[]

  Parameters

  • id: string

    The channel's ID.
  • ...keys: T

    Properties to ensure.

  Returns Promise<Pick<CachedChannel, T[number]>>

getGuildData

• getGuildData<T extends (keyof CachedGuild)[]>(
      id: string,
      ...keys: T,
  ): Promise<Pick<CachedGuild, T[number]>>

  Tries to ensure guild data. Fetches data from the cache, then if data isn't found a rest request is made.

  Type Parameters

  • T extends (keyof CachedGuild)[]

  Parameters

  • id: string

    The guild's ID.
  • ...keys: T

    Properties to ensure.

  Returns Promise<Pick<CachedGuild, T[number]>>

getMemberData

• getMemberData<T extends (keyof CachedMember)[]>(
      guildId: string,
      userId: string,
      ...keys: T,
  ): Promise<Pick<CachedMember, T[number]>>

  Tries to ensure member data. Fetches data from the cache, then if data isn't found a rest request is made.

  Type Parameters

  • T extends (keyof CachedMember)[]

  Parameters

  • guildId: string

    The member's guild ID.
  • userId: string

    The member's user ID.
  • ...keys: T

    Properties to ensure.

  Returns Promise<Pick<CachedMember, T[number]>>

getPresenceData

• getPresenceData<T extends (keyof CachedPresence)[]>(
      guildId: string,
      userId: string,
      ...keys: T,
  ): Pick<CachedPresence, T[number]>

  Tries to ensure presence data.

  Type Parameters

  • T extends (keyof CachedPresence)[]

  Parameters

  • guildId: string

    The presence's guild ID.
  • userId: string

    The presence's user ID.
  • ...keys: T

    Properties to ensure.

  Returns Pick<CachedPresence, T[number]>

getRoleData

• getRoleData<T extends (keyof CachedRole)[]>(
      id: string,
      guildId: string,
      ...keys: T,
  ): Promise<Pick<CachedRole, T[number]>>

  Tries to ensure role data. Fetches data from the cache, then if data isn't found a rest request is made.

  Type Parameters

  • T extends (keyof CachedRole)[]

  Parameters

  • id: string

    The role's ID.
  • guildId: string

    The role's guild's ID.
  • ...keys: T

    Properties to ensure.

  Returns Promise<Pick<CachedRole, T[number]>>

getSelfPermissions

• getSelfPermissions(guildId: string, channelId?: string): Promise<bigint>

  Gets the bot's self permissions. For no requests to the API to be made, the following must be cached:

  const cacheOptions = {
    channels: [`permission_overwrites`], // Only necessary if channelId is specified
    guilds: [`owner_id`, `roles`],
    members: [`communication_disabled_until`, `roles`],
    roles: [`permissions`]
  }
  Copy

  Parameters

  • guildId: string

    The guild to get the bot's permissions in.
  • OptionalchannelId: string

    The channel to get the bot's permissions in.

  Returns Promise<bigint>

  The bot's permission flags.

getUserData

• getUserData<T extends (keyof CachedUser)[]>(
      id: string,
      ...keys: T,
  ): Promise<Pick<CachedUser, T[number]>>

  Tries to ensure user data. Fetches data from the cache, then if data isn't found a rest request is made.

  Type Parameters

  • T extends (keyof CachedUser)[]

  Parameters

  • id: string

    The user's ID.
  • ...keys: T

    Properties to ensure.

  Returns Promise<Pick<CachedUser, T[number]>>

getVoiceStateData

• getVoiceStateData<T extends (keyof CachedVoiceState)[]>(
      guildId: string,
      userId: string,
      ...keys: T,
  ): Pick<CachedVoiceState, T[number]>

  Tries to ensure presence data.

  Type Parameters

  • T extends (keyof CachedVoiceState)[]

  Parameters

  • guildId: string

    The presence's guild ID.
  • userId: string

    The presence's user ID.
  • ...keys: T

    Properties to ensure.

  Returns Pick<CachedVoiceState, T[number]>