ShardClientclass

A single connection to Discord's gateway, with REST access and caches for everything it receives. Every other client is built from these.

On this page

Overview
Constructor1
Properties38
Accessors7
Methods13

import { ShardClient } from 'detritus-client';

Hierarchy

EventEmitterEventSpewerShardClient

44 properties12 methodssrc/client.ts:191

Constructor

new ShardClient

src/client.ts:259

new ShardClient(token: string, options?: ShardClientOptions)

Properties

_killed

boolean

Default false

application

Application | null

Default null

applicationCommandPermissions

ApplicationCommandPermissionsCache

readonly

applicationEmojis

ApplicationEmojis

readonly

applications

Applications

readonly

autoModerationRules

AutoModerationRules

readonly

channels

Channels

readonly

cluster

ClusterClient | null

Default null

commandClient

CommandClient | null

Default null

connectedAccounts

ConnectedAccounts

readonly

emojis

Emojis

readonly

gateway

Socket

detritus-client-socket's Gateway Socket

gatewayHandler

GatewayHandler

Our Dispatch Handler

guilds

Guilds

readonly

guildScheduledEvents

GuildScheduledEvents

readonly

imageFormat

ImageFormats

Default Image Format to use for any url getters

Default ImageFormats.PNG

interactionCommandClient

InteractionCommandClient | null

Default null

interactions

Interactions

readonly

members

Members

readonly

messages

Messages

readonly

owners

BaseCollection<string, User>

If this is a bot, this will be filled with it's application owner or all of the application's team owners If this is a user, this will only include the user object Only fills once we receive the Ready payload

presences

Presences

readonly

ran

boolean

If the client is ran or not

Default false

relationships

Relationships

readonly

requiredAction?

string | null

optional

(Users only) if the client requires an action (like the captcha overlay)

rest

RestClient

detritus-client-rest's Rest Client, but wrapped over

roles

Roles

readonly

sessions

Sessions

readonly

soundboardSounds

SoundboardSounds

readonly

stageInstances

StageInstances

readonly

stickers

Stickers

readonly

token

string

our token

typings

TypingCollection

readonly

user

UserMe | null

Us, only fills once we received the Ready payload from the gateway

Default null

users

Users

readonly

voiceCalls

VoiceCalls

readonly

voiceConnections

VoiceConnections

readonly

voiceStates

VoiceStates

readonly

Accessors

applicationId

string

get

clientId

string

get

isBot

boolean

get

killed

boolean

get

shardCount

number

get

shardId

number

get

userId

string

get

Methods

_mergeOauth2Application()

src/client.ts:400

_mergeOauth2Application(data: any): Application

hookComponents()

src/client.ts:421

hookComponents(
  listenerId: string,
  components: Components | (ComponentActionRowData | ComponentActionRow)[],
  timeout?: number,
): Components

isOwner()

src/client.ts:435

isOwner(userId: string): boolean

kill()

src/client.ts:439

kill(error?: Error): void

on()

src/client.ts:698

on(event: string | symbol, listener: (...args: any[]) => void): this

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Since v0.1.101

Parameters

event

string | symbol

listener

(...args: any[]) => void

The callback function

on(event: ACTIVITY_JOIN_INVITE, listener: (payload: ActivityJoinInvite) => any): this

on(event: "activityJoinInvite", listener: (payload: ActivityJoinInvite) => any): this

on(event: ACTIVITY_JOIN_REQUEST, listener: (payload: ActivityJoinRequest) => any): this

on(event: "activityJoinRequest", listener: (payload: ActivityJoinRequest) => any): this

on(event: ACTIVITY_START, listener: (payload: ActivityStart) => any): this

on(event: "activityStart", listener: (payload: ActivityStart) => any): this

on(
  event: APPLICATION_COMMAND_CREATE,
  listener: (payload: ApplicationCommandCreate) => any,
): this

on(
  event: "applicationCommandCreate",
  listener: (payload: ApplicationCommandCreate) => any,
): this

on(
  event: APPLICATION_COMMAND_DELETE,
  listener: (payload: ApplicationCommandDelete) => any,
): this

on(
  event: "applicationCommandDelete",
  listener: (payload: ApplicationCommandDelete) => any,
): this

on(
  event: APPLICATION_COMMAND_UPDATE,
  listener: (payload: ApplicationCommandUpdate) => any,
): this

on(
  event: "applicationCommandUpdate",
  listener: (payload: ApplicationCommandUpdate) => any,
): this

on(
  event: BRAINTREE_POPUP_BRIDGE_CALLBACK,
  listener: (payload: BraintreePopupBridgeCallback) => any,
): this

on(
  event: "braintreePopupBridgeCallback",
  listener: (payload: BraintreePopupBridgeCallback) => any,
): this

on(
  event: AUTO_MODERATION_ACTION_EXECUTION,
  listener: (payload: AutoModerationActionExecution) => any,
): this

on(
  event: "autoModerationActionExecution",
  listener: (payload: AutoModerationActionExecution) => any,
): this

on(
  event: AUTO_MODERATION_RULE_CREATE,
  listener: (payload: AutoModerationRuleCreate) => any,
): this

on(
  event: "autoModerationRuleCreate",
  listener: (payload: AutoModerationRuleCreate) => any,
): this

on(
  event: AUTO_MODERATION_RULE_DELETE,
  listener: (payload: AutoModerationRuleDelete) => any,
): this

on(
  event: "autoModerationRuleDelete",
  listener: (payload: AutoModerationRuleDelete) => any,
): this

on(
  event: AUTO_MODERATION_RULE_UPDATE,
  listener: (payload: AutoModerationRuleUpdate) => any,
): this

on(
  event: "autoModerationRuleUpdate",
  listener: (payload: AutoModerationRuleUpdate) => any,
): this

on(event: CALL_CREATE, listener: (payload: CallCreate) => any): this

on(event: "callCreate", listener: (payload: CallCreate) => any): this

on(event: CALL_DELETE, listener: (payload: CallDelete) => any): this

on(event: "callDelete", listener: (payload: CallDelete) => any): this

on(event: CALL_UPDATE, listener: (payload: CallUpdate) => any): this

on(event: "callUpdate", listener: (payload: CallUpdate) => any): this

on(event: CHANNEL_CREATE, listener: (payload: ChannelCreate) => any): this

on(event: "channelCreate", listener: (payload: ChannelCreate) => any): this

on(event: CHANNEL_DELETE, listener: (payload: ChannelDelete) => any): this

on(event: "channelDelete", listener: (payload: ChannelDelete) => any): this

on(event: CHANNEL_UPDATE, listener: (payload: ChannelUpdate) => any): this

on(event: "channelUpdate", listener: (payload: ChannelUpdate) => any): this

on(event: CHANNEL_PINS_ACK, listener: (payload: ChannelPinsAck) => any): this

on(event: "channelPinsAck", listener: (payload: ChannelPinsAck) => any): this

on(event: CHANNEL_INFO, listener: (payload: ChannelInfo) => any): this

on(event: "channelInfo", listener: (payload: ChannelInfo) => any): this

on(event: CHANNEL_PINS_UPDATE, listener: (payload: ChannelPinsUpdate) => any): this

on(event: "channelPinsUpdate", listener: (payload: ChannelPinsUpdate) => any): this

on(event: CHANNEL_RECIPIENT_ADD, listener: (payload: ChannelRecipientAdd) => any): this

on(event: "channelRecipientAdd", listener: (payload: ChannelRecipientAdd) => any): this

on(
  event: CHANNEL_RECIPIENT_REMOVE,
  listener: (payload: ChannelRecipientRemove) => any,
): this

on(
  event: "channelRecipientRemove",
  listener: (payload: ChannelRecipientRemove) => any,
): this

on(event: ENTITLEMENT_CREATE, listener: (payload: EntitlementCreate) => any): this

on(event: "entitlementCreate", listener: (payload: EntitlementCreate) => any): this

on(event: ENTITLEMENT_DELETE, listener: (payload: EntitlementDelete) => any): this

on(event: "entitlementDelete", listener: (payload: EntitlementDelete) => any): this

on(event: ENTITLEMENT_UPDATE, listener: (payload: EntitlementUpdate) => any): this

on(event: "entitlementUpdate", listener: (payload: EntitlementUpdate) => any): this

on(
  event: FRIEND_SUGGESTION_CREATE,
  listener: (payload: FriendSuggestionCreate) => any,
): this

on(
  event: "friendSuggestionCreate",
  listener: (payload: FriendSuggestionCreate) => any,
): this

on(
  event: FRIEND_SUGGESTION_DELETE,
  listener: (payload: FriendSuggestionDelete) => any,
): this

on(
  event: "friendSuggestionDelete",
  listener: (payload: FriendSuggestionDelete) => any,
): this

on(event: GATEWAY_READY, listener: (payload: GatewayReady) => any): this

on(event: "gatewayReady", listener: (payload: GatewayReady) => any): this

on(event: GATEWAY_RESUMED, listener: (payload: GatewayResumed) => any): this

on(event: "gatewayResumed", listener: (payload: GatewayResumed) => any): this

on(event: GIFT_CODE_UPDATE, listener: (payload: GiftCodeUpdate) => any): this

on(event: "giftCodeUpdate", listener: (payload: GiftCodeUpdate) => any): this

on(
  event: GUILD_AUDIT_LOG_ENTRY_CREATE,
  listener: (payload: GuildAuditLogEntryCreate) => any,
): this

on(
  event: "guildAuditLogEntryCreate",
  listener: (payload: GuildAuditLogEntryCreate) => any,
): this

on(event: GUILD_BAN_ADD, listener: (payload: GuildBanAdd) => any): this

on(event: "guildBanAdd", listener: (payload: GuildBanAdd) => any): this

on(event: GUILD_BAN_REMOVE, listener: (payload: GuildBanRemove) => any): this

on(event: "guildBanRemove", listener: (payload: GuildBanRemove) => any): this

on(event: GUILD_CREATE, listener: (payload: GuildCreate) => any): this

on(event: "guildCreate", listener: (payload: GuildCreate) => any): this

on(event: GUILD_DELETE, listener: (payload: GuildDelete) => any): this

on(event: "guildDelete", listener: (payload: GuildDelete) => any): this

on(event: GUILD_EMOJIS_UPDATE, listener: (payload: GuildEmojisUpdate) => any): this

on(event: "guildEmojisUpdate", listener: (payload: GuildEmojisUpdate) => any): this

on(
  event: GUILD_INTEGRATIONS_UPDATE,
  listener: (payload: GuildIntegrationsUpdate) => any,
): this

on(
  event: "guildIntegrationsUpdate",
  listener: (payload: GuildIntegrationsUpdate) => any,
): this

on(event: GUILD_MEMBER_ADD, listener: (payload: GuildMemberAdd) => any): this

on(event: "guildMemberAdd", listener: (payload: GuildMemberAdd) => any): this

on(
  event: GUILD_MEMBER_LIST_UPDATE,
  listener: (payload: GuildMemberListUpdate) => any,
): this

on(
  event: "guildMemberListUpdate",
  listener: (payload: GuildMemberListUpdate) => any,
): this

on(event: GUILD_MEMBER_REMOVE, listener: (payload: GuildMemberRemove) => any): this

on(event: "guildMemberRemove", listener: (payload: GuildMemberRemove) => any): this

on(event: GUILD_MEMBER_UPDATE, listener: (payload: GuildMemberUpdate) => any): this

on(event: "guildMemberUpdate", listener: (payload: GuildMemberUpdate) => any): this

on(event: GUILD_MEMBERS_CHUNK, listener: (payload: GuildMembersChunk) => any): this

on(event: "guildMembersChunk", listener: (payload: GuildMembersChunk) => any): this

on(event: GUILD_READY, listener: (payload: GuildReady) => any): this

on(event: "guildReady", listener: (payload: GuildReady) => any): this

on(event: GUILD_ROLE_CREATE, listener: (payload: GuildRoleCreate) => any): this

on(event: "guildRoleCreate", listener: (payload: GuildRoleCreate) => any): this

on(event: GUILD_ROLE_DELETE, listener: (payload: GuildRoleDelete) => any): this

on(event: "guildRoleDelete", listener: (payload: GuildRoleDelete) => any): this

on(event: GUILD_ROLE_UPDATE, listener: (payload: GuildRoleUpdate) => any): this

on(event: "guildRoleUpdate", listener: (payload: GuildRoleUpdate) => any): this

on(
  event: GUILD_SCHEDULED_EVENT_USER_ADD,
  listener: (payload: GuildScheduledEventUserAdd) => any,
): this

on(
  event: "guildScheduledEventUserAdd",
  listener: (payload: GuildScheduledEventUserAdd) => any,
): this

on(
  event: GUILD_SCHEDULED_EVENT_USER_REMOVE,
  listener: (payload: GuildScheduledEventUserRemove) => any,
): this

on(
  event: "guildScheduledEventUserRemove",
  listener: (payload: GuildScheduledEventUserRemove) => any,
): this

on(
  event: GUILD_SOUNDBOARD_SOUND_CREATE,
  listener: (payload: GuildSoundboardSoundCreate) => any,
): this

on(
  event: "guildSoundboardSoundCreate",
  listener: (payload: GuildSoundboardSoundCreate) => any,
): this

on(
  event: GUILD_SOUNDBOARD_SOUND_DELETE,
  listener: (payload: GuildSoundboardSoundDelete) => any,
): this

on(
  event: "guildSoundboardSoundDelete",
  listener: (payload: GuildSoundboardSoundDelete) => any,
): this

on(
  event: GUILD_SOUNDBOARD_SOUND_UPDATE,
  listener: (payload: GuildSoundboardSoundUpdate) => any,
): this

on(
  event: "guildSoundboardSoundUpdate",
  listener: (payload: GuildSoundboardSoundUpdate) => any,
): this

on(
  event: GUILD_SOUNDBOARD_SOUNDS_UPDATE,
  listener: (payload: GuildSoundboardSoundsUpdate) => any,
): this

on(
  event: "guildSoundboardSoundsUpdate",
  listener: (payload: GuildSoundboardSoundsUpdate) => any,
): this

on(event: SOUNDBOARD_SOUNDS, listener: (payload: SoundboardSounds) => any): this

on(event: "soundboardSounds", listener: (payload: SoundboardSounds) => any): this

on(event: GUILD_STICKERS_UPDATE, listener: (payload: GuildStickersUpdate) => any): this

on(event: "guildStickersUpdate", listener: (payload: GuildStickersUpdate) => any): this

on(event: GUILD_UPDATE, listener: (payload: GuildUpdate) => any): this

on(event: "guildUpdate", listener: (payload: GuildUpdate) => any): this

on(event: INTERACTION_CREATE, listener: (payload: InteractionCreate) => any): this

on(event: "interactionCreate", listener: (payload: InteractionCreate) => any): this

on(event: INVITE_CREATE, listener: (payload: InviteCreate) => any): this

on(event: "inviteCreate", listener: (payload: InviteCreate) => any): this

on(event: INVITE_DELETE, listener: (payload: InviteDelete) => any): this

on(event: "inviteDelete", listener: (payload: InviteDelete) => any): this

on(
  event: LIBRARY_APPLICATION_UPDATE,
  listener: (payload: LibraryApplicationUpdate) => any,
): this

on(
  event: "libraryApplicationUpdate",
  listener: (payload: LibraryApplicationUpdate) => any,
): this

on(event: LOBBY_CREATE, listener: (payload: LobbyCreate) => any): this

on(event: "lobbyCreate", listener: (payload: LobbyCreate) => any): this

on(event: LOBBY_DELETE, listener: (payload: LobbyDelete) => any): this

on(event: "lobbyDelete", listener: (payload: LobbyDelete) => any): this

on(event: LOBBY_UPDATE, listener: (payload: LobbyUpdate) => any): this

on(event: "lobbyUpdate", listener: (payload: LobbyUpdate) => any): this

on(event: LOBBY_MEMBER_CONNECT, listener: (payload: LobbyMemberConnect) => any): this

on(event: "lobbyMemberConnect", listener: (payload: LobbyMemberConnect) => any): this

on(
  event: LOBBY_MEMBER_DISCONNECT,
  listener: (payload: LobbyMemberDisconnect) => any,
): this

on(
  event: "lobbyMemberDisconnect",
  listener: (payload: LobbyMemberDisconnect) => any,
): this

on(event: LOBBY_MEMBER_UPDATE, listener: (payload: LobbyMemberUpdate) => any): this

on(event: "lobbyMemberUpdate", listener: (payload: LobbyMemberUpdate) => any): this

on(event: LOBBY_MESSAGE, listener: (payload: LobbyMessage) => any): this

on(event: "lobbyMessage", listener: (payload: LobbyMessage) => any): this

on(
  event: LOBBY_VOICE_SERVER_UPDATE,
  listener: (payload: LobbyVoiceServerUpdate) => any,
): this

on(
  event: "lobbyVoiceServerUpdate",
  listener: (payload: LobbyVoiceServerUpdate) => any,
): this

on(
  event: LOBBY_VOICE_STATE_UPDATE,
  listener: (payload: LobbyVoiceStateUpdate) => any,
): this

on(
  event: "lobbyVoiceStateUpdate",
  listener: (payload: LobbyVoiceStateUpdate) => any,
): this

on(event: MESSAGE_ACK, listener: (payload: MessageAck) => any): this

on(event: "messageAck", listener: (payload: MessageAck) => any): this

on(event: MESSAGE_CREATE, listener: (payload: MessageCreate) => any): this

on(event: "messageCreate", listener: (payload: MessageCreate) => any): this

on(event: MESSAGE_DELETE, listener: (payload: MessageDelete) => any): this

on(event: "messageDelete", listener: (payload: MessageDelete) => any): this

on(event: MESSAGE_DELETE_BULK, listener: (payload: MessageDeleteBulk) => any): this

on(event: "messageDeleteBulk", listener: (payload: MessageDeleteBulk) => any): this

on(event: MESSAGE_REACTION_ADD, listener: (payload: MessageReactionAdd) => any): this

on(event: "messageReactionAdd", listener: (payload: MessageReactionAdd) => any): this

on(
  event: MESSAGE_REACTION_REMOVE,
  listener: (payload: MessageReactionRemove) => any,
): this

on(
  event: "messageReactionRemove",
  listener: (payload: MessageReactionRemove) => any,
): this

on(
  event: MESSAGE_REACTION_REMOVE_ALL,
  listener: (payload: MessageReactionRemoveAll) => any,
): this

on(
  event: "messageReactionRemoveAll",
  listener: (payload: MessageReactionRemoveAll) => any,
): this

on(
  event: MESSAGE_REACTION_REMOVE_EMOJI,
  listener: (payload: MessageReactionRemoveEmoji) => any,
): this

on(
  event: "messageReactionRemoveEmoji",
  listener: (payload: MessageReactionRemoveEmoji) => any,
): this

on(event: MESSAGE_UPDATE, listener: (payload: MessageUpdate) => any): this

on(event: "messageUpdate", listener: (payload: MessageUpdate) => any): this

on(event: PRESENCES_REPLACE, listener: (payload: PresencesReplace) => any): this

on(event: "presencesReplace", listener: (payload: PresencesReplace) => any): this

on(event: PRESENCE_UPDATE, listener: (payload: PresenceUpdate) => any): this

on(event: "presenceUpdate", listener: (payload: PresenceUpdate) => any): this

on(event: RATE_LIMITED, listener: (payload: RateLimited) => any): this

on(event: "rateLimited", listener: (payload: RateLimited) => any): this

on(event: RECENT_MENTION_DELETE, listener: (payload: RecentMentionDelete) => any): this

on(event: "recentMentionDelete", listener: (payload: RecentMentionDelete) => any): this

on(event: RELATIONSHIP_ADD, listener: (payload: RelationshipAdd) => any): this

on(event: "relationshipAdd", listener: (payload: RelationshipAdd) => any): this

on(event: RELATIONSHIP_REMOVE, listener: (payload: RelationshipRemove) => any): this

on(event: "relationshipRemove", listener: (payload: RelationshipRemove) => any): this

on(event: SESSIONS_REPLACE, listener: (payload: SessionsReplace) => any): this

on(event: "sessionsReplace", listener: (payload: SessionsReplace) => any): this

on(event: STAGE_INSTANCE_CREATE, listener: (payload: StageInstanceCreate) => any): this

on(event: "stageInstanceCreate", listener: (payload: StageInstanceCreate) => any): this

on(event: STAGE_INSTANCE_DELETE, listener: (payload: StageInstanceDelete) => any): this

on(event: "stageInstanceDelete", listener: (payload: StageInstanceDelete) => any): this

on(event: STAGE_INSTANCE_UPDATE, listener: (payload: StageInstanceUpdate) => any): this

on(event: "stageInstanceUpdate", listener: (payload: StageInstanceUpdate) => any): this

on(event: STREAM_CREATE, listener: (payload: StreamCreate) => any): this

on(event: "streamCreate", listener: (payload: StreamCreate) => any): this

on(event: STREAM_DELETE, listener: (payload: StreamDelete) => any): this

on(event: "streamDelete", listener: (payload: StreamDelete) => any): this

on(event: STREAM_SERVER_UPDATE, listener: (payload: StreamServerUpdate) => any): this

on(event: "streamServerUpdate", listener: (payload: StreamServerUpdate) => any): this

on(event: STREAM_UPDATE, listener: (payload: StreamUpdate) => any): this

on(event: "streamUpdate", listener: (payload: StreamUpdate) => any): this

on(event: SUBSCRIPTION_CREATE, listener: (payload: SubscriptionCreate) => any): this

on(event: "subscriptionCreate", listener: (payload: SubscriptionCreate) => any): this

on(event: SUBSCRIPTION_DELETE, listener: (payload: SubscriptionDelete) => any): this

on(event: "subscriptionDelete", listener: (payload: SubscriptionDelete) => any): this

on(event: SUBSCRIPTION_UPDATE, listener: (payload: SubscriptionUpdate) => any): this

on(event: "subscriptionUpdate", listener: (payload: SubscriptionUpdate) => any): this

on(event: THREAD_CREATE, listener: (payload: ThreadCreate) => any): this

on(event: "threadCreate", listener: (payload: ThreadCreate) => any): this

on(event: THREAD_DELETE, listener: (payload: ThreadDelete) => any): this

on(event: "threadDelete", listener: (payload: ThreadDelete) => any): this

on(event: THREAD_LIST_SYNC, listener: (payload: ThreadListSync) => any): this

on(event: "threadListSync", listener: (payload: ThreadListSync) => any): this

on(event: THREAD_MEMBER_UPDATE, listener: (payload: ThreadMemberUpdate) => any): this

on(event: "threadMemberUpdate", listener: (payload: ThreadMemberUpdate) => any): this

on(event: THREAD_MEMBERS_UPDATE, listener: (payload: ThreadMembersUpdate) => any): this

on(event: "threadMembersUpdate", listener: (payload: ThreadMembersUpdate) => any): this

on(event: THREAD_UPDATE, listener: (payload: ThreadUpdate) => any): this

on(event: "threadUpdate", listener: (payload: ThreadUpdate) => any): this

on(event: TYPING_START, listener: (payload: TypingStart) => any): this

on(event: "typingStart", listener: (payload: TypingStart) => any): this

on(event: TYPING_STOP, listener: (payload: TypingStop) => any): this

on(event: "typingStop", listener: (payload: TypingStop) => any): this

on(
  event: USER_ACHIEVEMENT_UPDATE,
  listener: (payload: UserAchievementUpdate) => any,
): this

on(
  event: "userAchievementUpdate",
  listener: (payload: UserAchievementUpdate) => any,
): this

on(
  event: USER_CONNECTIONS_UPDATE,
  listener: (payload: UserConnectionsUpdate) => any,
): this

on(
  event: "userConnectionsUpdate",
  listener: (payload: UserConnectionsUpdate) => any,
): this

on(
  event: USER_FEED_SETTINGS_UPDATE,
  listener: (payload: UserFeedSettingsUpdate) => any,
): this

on(
  event: "userFeedSettingsUpdate",
  listener: (payload: UserFeedSettingsUpdate) => any,
): this

on(
  event: USER_GUILD_SETTINGS_UPDATE,
  listener: (payload: UserGuildSettingsUpdate) => any,
): this

on(
  event: "userGuildSettingsUpdate",
  listener: (payload: UserGuildSettingsUpdate) => any,
): this

on(
  event: USER_PAYMENT_SOURCES_UPDATE,
  listener: (payload: UserPaymentSourcesUpdate) => any,
): this

on(
  event: "userPaymentSourcesUpdate",
  listener: (payload: UserPaymentSourcesUpdate) => any,
): this

on(event: USER_PAYMENTS_UPDATE, listener: (payload: UserPaymentsUpdate) => any): this

on(event: "userPaymentsUpdate", listener: (payload: UserPaymentsUpdate) => any): this

on(
  event: USER_REQUIRED_ACTION_UPDATE,
  listener: (payload: UserRequiredActionUpdate) => any,
): this

on(
  event: "userRequiredActionUpdate",
  listener: (payload: UserRequiredActionUpdate) => any,
): this

on(event: USER_UPDATE, listener: (payload: UserUpdate) => any): this

on(event: "userUpdate", listener: (payload: UserUpdate) => any): this

on(event: USERS_UPDATE, listener: (payload: UsersUpdate) => any): this

on(event: "usersUpdate", listener: (payload: UsersUpdate) => any): this

on(
  event: VOICE_CHANNEL_EFFECT_SEND,
  listener: (payload: VoiceChannelEffectSend) => any,
): this

on(
  event: "voiceChannelEffectSend",
  listener: (payload: VoiceChannelEffectSend) => any,
): this

on(
  event: VOICE_CHANNEL_START_TIME_UPDATE,
  listener: (payload: VoiceChannelStartTimeUpdate) => any,
): this

on(
  event: "voiceChannelStartTimeUpdate",
  listener: (payload: VoiceChannelStartTimeUpdate) => any,
): this

on(
  event: VOICE_CHANNEL_STATUS_UPDATE,
  listener: (payload: VoiceChannelStatusUpdate) => any,
): this

on(
  event: "voiceChannelStatusUpdate",
  listener: (payload: VoiceChannelStatusUpdate) => any,
): this

on(event: VOICE_SERVER_UPDATE, listener: (payload: VoiceServerUpdate) => any): this

on(event: "voiceServerUpdate", listener: (payload: VoiceServerUpdate) => any): this

on(event: VOICE_STATE_UPDATE, listener: (payload: VoiceStateUpdate) => any): this

on(event: "voiceStateUpdate", listener: (payload: VoiceStateUpdate) => any): this

on(event: WEBHOOKS_UPDATE, listener: (payload: WebhooksUpdate) => any): this

on(event: "webhooksUpdate", listener: (payload: WebhooksUpdate) => any): this

on(event: RAW, listener: (payload: Raw) => any): this

on(event: "raw", listener: (payload: Raw) => any): this

on(event: REST_REQUEST, listener: (payload: RestRequest) => any): this

on(event: "restRequest", listener: (payload: RestRequest) => any): this

on(event: REST_RESPONSE, listener: (payload: RestResponse) => any): this

on(event: "restResponse", listener: (payload: RestResponse) => any): this

on(event: UNKNOWN, listener: (payload: Unknown) => any): this

on(event: "unknown", listener: (payload: Unknown) => any): this

on(event: WARN, listener: (payload: Warn) => any): this

on(event: "warn", listener: (payload: Warn) => any): this

on(event: KILLED, listener: (payload: Killed) => any): this

on(event: "killed", listener: (payload: Killed) => any): this

Overrides EventSpewer.on

once()

src/client.ts:950

once(event: string | symbol, listener: (...args: any[]) => void): this

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Since v0.3.0

Parameters

event

string | symbol

listener

(...args: any[]) => void

The callback function

once(event: ACTIVITY_JOIN_INVITE, listener: (payload: ActivityJoinInvite) => any): this

once(event: "activityJoinInvite", listener: (payload: ActivityJoinInvite) => any): this

once(event: ACTIVITY_JOIN_REQUEST, listener: (payload: ActivityJoinRequest) => any): this

once(event: "activityJoinRequest", listener: (payload: ActivityJoinRequest) => any): this

once(event: ACTIVITY_START, listener: (payload: ActivityStart) => any): this

once(event: "activityStart", listener: (payload: ActivityStart) => any): this

once(
  event: APPLICATION_COMMAND_CREATE,
  listener: (payload: ApplicationCommandCreate) => any,
): this

once(
  event: "applicationCommandCreate",
  listener: (payload: ApplicationCommandCreate) => any,
): this

once(
  event: APPLICATION_COMMAND_DELETE,
  listener: (payload: ApplicationCommandDelete) => any,
): this

once(
  event: "applicationCommandDelete",
  listener: (payload: ApplicationCommandDelete) => any,
): this

once(
  event: APPLICATION_COMMAND_UPDATE,
  listener: (payload: ApplicationCommandUpdate) => any,
): this

once(
  event: "applicationCommandUpdate",
  listener: (payload: ApplicationCommandUpdate) => any,
): this

once(
  event: BRAINTREE_POPUP_BRIDGE_CALLBACK,
  listener: (payload: BraintreePopupBridgeCallback) => any,
): this

once(
  event: "braintreePopupBridgeCallback",
  listener: (payload: BraintreePopupBridgeCallback) => any,
): this

once(
  event: AUTO_MODERATION_ACTION_EXECUTION,
  listener: (payload: AutoModerationActionExecution) => any,
): this

once(
  event: "autoModerationActionExecution",
  listener: (payload: AutoModerationActionExecution) => any,
): this

once(
  event: AUTO_MODERATION_RULE_CREATE,
  listener: (payload: AutoModerationRuleCreate) => any,
): this

once(
  event: "autoModerationRuleCreate",
  listener: (payload: AutoModerationRuleCreate) => any,
): this

once(
  event: AUTO_MODERATION_RULE_DELETE,
  listener: (payload: AutoModerationRuleDelete) => any,
): this

once(
  event: "autoModerationRuleDelete",
  listener: (payload: AutoModerationRuleDelete) => any,
): this

once(
  event: AUTO_MODERATION_RULE_UPDATE,
  listener: (payload: AutoModerationRuleUpdate) => any,
): this

once(
  event: "autoModerationRuleUpdate",
  listener: (payload: AutoModerationRuleUpdate) => any,
): this

once(event: CALL_CREATE, listener: (payload: CallCreate) => any): this

once(event: "callCreate", listener: (payload: CallCreate) => any): this

once(event: CALL_DELETE, listener: (payload: CallDelete) => any): this

once(event: "callDelete", listener: (payload: CallDelete) => any): this

once(event: CALL_UPDATE, listener: (payload: CallUpdate) => any): this

once(event: "callUpdate", listener: (payload: CallUpdate) => any): this

once(event: CHANNEL_CREATE, listener: (payload: ChannelCreate) => any): this

once(event: "channelCreate", listener: (payload: ChannelCreate) => any): this

once(event: CHANNEL_DELETE, listener: (payload: ChannelDelete) => any): this

once(event: "channelDelete", listener: (payload: ChannelDelete) => any): this

once(event: CHANNEL_UPDATE, listener: (payload: ChannelUpdate) => any): this

once(event: "channelUpdate", listener: (payload: ChannelUpdate) => any): this

once(event: CHANNEL_PINS_ACK, listener: (payload: ChannelPinsAck) => any): this

once(event: "channelPinsAck", listener: (payload: ChannelPinsAck) => any): this

once(event: CHANNEL_INFO, listener: (payload: ChannelInfo) => any): this

once(event: "channelInfo", listener: (payload: ChannelInfo) => any): this

once(event: CHANNEL_PINS_UPDATE, listener: (payload: ChannelPinsUpdate) => any): this

once(event: "channelPinsUpdate", listener: (payload: ChannelPinsUpdate) => any): this

once(event: CHANNEL_RECIPIENT_ADD, listener: (payload: ChannelRecipientAdd) => any): this

once(event: "channelRecipientAdd", listener: (payload: ChannelRecipientAdd) => any): this

once(
  event: CHANNEL_RECIPIENT_REMOVE,
  listener: (payload: ChannelRecipientRemove) => any,
): this

once(
  event: "channelRecipientRemove",
  listener: (payload: ChannelRecipientRemove) => any,
): this

once(event: ENTITLEMENT_CREATE, listener: (payload: EntitlementCreate) => any): this

once(event: "entitlementCreate", listener: (payload: EntitlementCreate) => any): this

once(event: ENTITLEMENT_DELETE, listener: (payload: EntitlementDelete) => any): this

once(event: "entitlementDelete", listener: (payload: EntitlementDelete) => any): this

once(event: ENTITLEMENT_UPDATE, listener: (payload: EntitlementUpdate) => any): this

once(event: "entitlementUpdate", listener: (payload: EntitlementUpdate) => any): this

once(
  event: FRIEND_SUGGESTION_CREATE,
  listener: (payload: FriendSuggestionCreate) => any,
): this

once(
  event: "friendSuggestionCreate",
  listener: (payload: FriendSuggestionCreate) => any,
): this

once(
  event: FRIEND_SUGGESTION_DELETE,
  listener: (payload: FriendSuggestionDelete) => any,
): this

once(
  event: "friendSuggestionDelete",
  listener: (payload: FriendSuggestionDelete) => any,
): this

once(event: GATEWAY_READY, listener: (payload: GatewayReady) => any): this

once(event: "gatewayReady", listener: (payload: GatewayReady) => any): this

once(event: GATEWAY_RESUMED, listener: (payload: GatewayResumed) => any): this

once(event: "gatewayResumed", listener: (payload: GatewayResumed) => any): this

once(event: GIFT_CODE_UPDATE, listener: (payload: GiftCodeUpdate) => any): this

once(event: "giftCodeUpdate", listener: (payload: GiftCodeUpdate) => any): this

once(
  event: GUILD_AUDIT_LOG_ENTRY_CREATE,
  listener: (payload: GuildAuditLogEntryCreate) => any,
): this

once(
  event: "guildAuditLogEntryCreate",
  listener: (payload: GuildAuditLogEntryCreate) => any,
): this

once(event: GUILD_BAN_ADD, listener: (payload: GuildBanAdd) => any): this

once(event: "guildBanAdd", listener: (payload: GuildBanAdd) => any): this

once(event: GUILD_BAN_REMOVE, listener: (payload: GuildBanRemove) => any): this

once(event: "guildBanRemove", listener: (payload: GuildBanRemove) => any): this

once(event: GUILD_CREATE, listener: (payload: GuildCreate) => any): this

once(event: "guildCreate", listener: (payload: GuildCreate) => any): this

once(event: GUILD_DELETE, listener: (payload: GuildDelete) => any): this

once(event: "guildDelete", listener: (payload: GuildDelete) => any): this

once(event: GUILD_EMOJIS_UPDATE, listener: (payload: GuildEmojisUpdate) => any): this

once(event: "guildEmojisUpdate", listener: (payload: GuildEmojisUpdate) => any): this

once(
  event: GUILD_INTEGRATIONS_UPDATE,
  listener: (payload: GuildIntegrationsUpdate) => any,
): this

once(
  event: "guildIntegrationsUpdate",
  listener: (payload: GuildIntegrationsUpdate) => any,
): this

once(event: GUILD_MEMBER_ADD, listener: (payload: GuildMemberAdd) => any): this

once(event: "guildMemberAdd", listener: (payload: GuildMemberAdd) => any): this

once(
  event: GUILD_MEMBER_LIST_UPDATE,
  listener: (payload: GuildMemberListUpdate) => any,
): this

once(
  event: "guildMemberListUpdate",
  listener: (payload: GuildMemberListUpdate) => any,
): this

once(event: GUILD_MEMBER_REMOVE, listener: (payload: GuildMemberRemove) => any): this

once(event: "guildMemberRemove", listener: (payload: GuildMemberRemove) => any): this

once(event: GUILD_MEMBER_UPDATE, listener: (payload: GuildMemberUpdate) => any): this

once(event: "guildMemberUpdate", listener: (payload: GuildMemberUpdate) => any): this

once(event: GUILD_MEMBERS_CHUNK, listener: (payload: GuildMembersChunk) => any): this

once(event: "guildMembersChunk", listener: (payload: GuildMembersChunk) => any): this

once(event: GUILD_READY, listener: (payload: GuildReady) => any): this

once(event: "guildReady", listener: (payload: GuildReady) => any): this

once(event: GUILD_ROLE_CREATE, listener: (payload: GuildRoleCreate) => any): this

once(event: "guildRoleCreate", listener: (payload: GuildRoleCreate) => any): this

once(event: GUILD_ROLE_DELETE, listener: (payload: GuildRoleDelete) => any): this

once(event: "guildRoleDelete", listener: (payload: GuildRoleDelete) => any): this

once(event: GUILD_ROLE_UPDATE, listener: (payload: GuildRoleUpdate) => any): this

once(event: "guildRoleUpdate", listener: (payload: GuildRoleUpdate) => any): this

once(
  event: GUILD_SCHEDULED_EVENT_USER_ADD,
  listener: (payload: GuildScheduledEventUserAdd) => any,
): this

once(
  event: "guildScheduledEventUserAdd",
  listener: (payload: GuildScheduledEventUserAdd) => any,
): this

once(
  event: GUILD_SCHEDULED_EVENT_USER_REMOVE,
  listener: (payload: GuildScheduledEventUserRemove) => any,
): this

once(
  event: "guildScheduledEventUserRemove",
  listener: (payload: GuildScheduledEventUserRemove) => any,
): this

once(
  event: GUILD_SOUNDBOARD_SOUND_CREATE,
  listener: (payload: GuildSoundboardSoundCreate) => any,
): this

once(
  event: "guildSoundboardSoundCreate",
  listener: (payload: GuildSoundboardSoundCreate) => any,
): this

once(
  event: GUILD_SOUNDBOARD_SOUND_DELETE,
  listener: (payload: GuildSoundboardSoundDelete) => any,
): this

once(
  event: "guildSoundboardSoundDelete",
  listener: (payload: GuildSoundboardSoundDelete) => any,
): this

once(
  event: GUILD_SOUNDBOARD_SOUND_UPDATE,
  listener: (payload: GuildSoundboardSoundUpdate) => any,
): this

once(
  event: "guildSoundboardSoundUpdate",
  listener: (payload: GuildSoundboardSoundUpdate) => any,
): this

once(
  event: GUILD_SOUNDBOARD_SOUNDS_UPDATE,
  listener: (payload: GuildSoundboardSoundsUpdate) => any,
): this

once(
  event: "guildSoundboardSoundsUpdate",
  listener: (payload: GuildSoundboardSoundsUpdate) => any,
): this

once(event: SOUNDBOARD_SOUNDS, listener: (payload: SoundboardSounds) => any): this

once(event: "soundboardSounds", listener: (payload: SoundboardSounds) => any): this

once(event: GUILD_STICKERS_UPDATE, listener: (payload: GuildStickersUpdate) => any): this

once(event: "guildStickersUpdate", listener: (payload: GuildStickersUpdate) => any): this

once(event: GUILD_UPDATE, listener: (payload: GuildUpdate) => any): this

once(event: "guildUpdate", listener: (payload: GuildUpdate) => any): this

once(event: INVITE_CREATE, listener: (payload: InviteCreate) => any): this

once(event: "inviteCreate", listener: (payload: InviteCreate) => any): this

once(event: INVITE_DELETE, listener: (payload: InviteDelete) => any): this

once(event: "inviteDelete", listener: (payload: InviteDelete) => any): this

once(
  event: LIBRARY_APPLICATION_UPDATE,
  listener: (payload: LibraryApplicationUpdate) => any,
): this

once(
  event: "libraryApplicationUpdate",
  listener: (payload: LibraryApplicationUpdate) => any,
): this

once(event: LOBBY_CREATE, listener: (payload: LobbyCreate) => any): this

once(event: "lobbyCreate", listener: (payload: LobbyCreate) => any): this

once(event: LOBBY_DELETE, listener: (payload: LobbyDelete) => any): this

once(event: "lobbyDelete", listener: (payload: LobbyDelete) => any): this

once(event: LOBBY_UPDATE, listener: (payload: LobbyUpdate) => any): this

once(event: "lobbyUpdate", listener: (payload: LobbyUpdate) => any): this

once(event: LOBBY_MEMBER_CONNECT, listener: (payload: LobbyMemberConnect) => any): this

once(event: "lobbyMemberConnect", listener: (payload: LobbyMemberConnect) => any): this

once(
  event: LOBBY_MEMBER_DISCONNECT,
  listener: (payload: LobbyMemberDisconnect) => any,
): this

once(
  event: "lobbyMemberDisconnect",
  listener: (payload: LobbyMemberDisconnect) => any,
): this

once(event: LOBBY_MEMBER_UPDATE, listener: (payload: LobbyMemberUpdate) => any): this

once(event: "lobbyMemberUpdate", listener: (payload: LobbyMemberUpdate) => any): this

once(event: LOBBY_MESSAGE, listener: (payload: LobbyMessage) => any): this

once(event: "lobbyMessage", listener: (payload: LobbyMessage) => any): this

once(
  event: LOBBY_VOICE_SERVER_UPDATE,
  listener: (payload: LobbyVoiceServerUpdate) => any,
): this

once(
  event: "lobbyVoiceServerUpdate",
  listener: (payload: LobbyVoiceServerUpdate) => any,
): this

once(
  event: LOBBY_VOICE_STATE_UPDATE,
  listener: (payload: LobbyVoiceStateUpdate) => any,
): this

once(
  event: "lobbyVoiceStateUpdate",
  listener: (payload: LobbyVoiceStateUpdate) => any,
): this

once(event: MESSAGE_ACK, listener: (payload: MessageAck) => any): this

once(event: "messageAck", listener: (payload: MessageAck) => any): this

once(event: MESSAGE_CREATE, listener: (payload: MessageCreate) => any): this

once(event: "messageCreate", listener: (payload: MessageCreate) => any): this

once(event: MESSAGE_DELETE, listener: (payload: MessageDelete) => any): this

once(event: "messageDelete", listener: (payload: MessageDelete) => any): this

once(event: MESSAGE_DELETE_BULK, listener: (payload: MessageDeleteBulk) => any): this

once(event: "messageDeleteBulk", listener: (payload: MessageDeleteBulk) => any): this

once(event: MESSAGE_REACTION_ADD, listener: (payload: MessageReactionAdd) => any): this

once(event: "messageReactionAdd", listener: (payload: MessageReactionAdd) => any): this

once(
  event: MESSAGE_REACTION_REMOVE,
  listener: (payload: MessageReactionRemove) => any,
): this

once(
  event: "messageReactionRemove",
  listener: (payload: MessageReactionRemove) => any,
): this

once(
  event: MESSAGE_REACTION_REMOVE_ALL,
  listener: (payload: MessageReactionRemoveAll) => any,
): this

once(
  event: "messageReactionRemoveAll",
  listener: (payload: MessageReactionRemoveAll) => any,
): this

once(
  event: MESSAGE_REACTION_REMOVE_EMOJI,
  listener: (payload: MessageReactionRemoveEmoji) => any,
): this

once(
  event: "messageReactionRemoveEmoji",
  listener: (payload: MessageReactionRemoveEmoji) => any,
): this

once(event: MESSAGE_UPDATE, listener: (payload: MessageUpdate) => any): this

once(event: "messageUpdate", listener: (payload: MessageUpdate) => any): this

once(event: PRESENCES_REPLACE, listener: (payload: PresencesReplace) => any): this

once(event: "presencesReplace", listener: (payload: PresencesReplace) => any): this

once(event: PRESENCE_UPDATE, listener: (payload: PresenceUpdate) => any): this

once(event: "presenceUpdate", listener: (payload: PresenceUpdate) => any): this

once(event: RATE_LIMITED, listener: (payload: RateLimited) => any): this

once(event: "rateLimited", listener: (payload: RateLimited) => any): this

once(event: RECENT_MENTION_DELETE, listener: (payload: RecentMentionDelete) => any): this

once(event: "recentMentionDelete", listener: (payload: RecentMentionDelete) => any): this

once(event: RELATIONSHIP_ADD, listener: (payload: RelationshipAdd) => any): this

once(event: "relationshipAdd", listener: (payload: RelationshipAdd) => any): this

once(event: RELATIONSHIP_REMOVE, listener: (payload: RelationshipRemove) => any): this

once(event: "relationshipRemove", listener: (payload: RelationshipRemove) => any): this

once(event: SESSIONS_REPLACE, listener: (payload: SessionsReplace) => any): this

once(event: "sessionsReplace", listener: (payload: SessionsReplace) => any): this

once(event: STAGE_INSTANCE_CREATE, listener: (payload: StageInstanceCreate) => any): this

once(event: "stageInstanceCreate", listener: (payload: StageInstanceCreate) => any): this

once(event: STAGE_INSTANCE_DELETE, listener: (payload: StageInstanceDelete) => any): this

once(event: "stageInstanceDelete", listener: (payload: StageInstanceDelete) => any): this

once(event: STAGE_INSTANCE_UPDATE, listener: (payload: StageInstanceUpdate) => any): this

once(event: "stageInstanceUpdate", listener: (payload: StageInstanceUpdate) => any): this

once(event: STREAM_CREATE, listener: (payload: StreamCreate) => any): this

once(event: "streamCreate", listener: (payload: StreamCreate) => any): this

once(event: STREAM_DELETE, listener: (payload: StreamDelete) => any): this

once(event: "streamDelete", listener: (payload: StreamDelete) => any): this

once(event: STREAM_SERVER_UPDATE, listener: (payload: StreamServerUpdate) => any): this

once(event: "streamServerUpdate", listener: (payload: StreamServerUpdate) => any): this

once(event: STREAM_UPDATE, listener: (payload: StreamUpdate) => any): this

once(event: "streamUpdate", listener: (payload: StreamUpdate) => any): this

once(event: SUBSCRIPTION_CREATE, listener: (payload: SubscriptionCreate) => any): this

once(event: "subscriptionCreate", listener: (payload: SubscriptionCreate) => any): this

once(event: SUBSCRIPTION_DELETE, listener: (payload: SubscriptionDelete) => any): this

once(event: "subscriptionDelete", listener: (payload: SubscriptionDelete) => any): this

once(event: SUBSCRIPTION_UPDATE, listener: (payload: SubscriptionUpdate) => any): this

once(event: "subscriptionUpdate", listener: (payload: SubscriptionUpdate) => any): this

once(event: THREAD_CREATE, listener: (payload: ThreadCreate) => any): this

once(event: "threadCreate", listener: (payload: ThreadCreate) => any): this

once(event: THREAD_DELETE, listener: (payload: ThreadDelete) => any): this

once(event: "threadDelete", listener: (payload: ThreadDelete) => any): this

once(event: THREAD_LIST_SYNC, listener: (payload: ThreadListSync) => any): this

once(event: "threadListSync", listener: (payload: ThreadListSync) => any): this

once(event: THREAD_MEMBER_UPDATE, listener: (payload: ThreadMemberUpdate) => any): this

once(event: "threadMemberUpdate", listener: (payload: ThreadMemberUpdate) => any): this

once(event: THREAD_MEMBERS_UPDATE, listener: (payload: ThreadMembersUpdate) => any): this

once(event: "threadMembersUpdate", listener: (payload: ThreadMembersUpdate) => any): this

once(event: THREAD_UPDATE, listener: (payload: ThreadUpdate) => any): this

once(event: "threadUpdate", listener: (payload: ThreadUpdate) => any): this

once(event: TYPING_START, listener: (payload: TypingStart) => any): this

once(event: "typingStart", listener: (payload: TypingStart) => any): this

once(event: TYPING_STOP, listener: (payload: TypingStop) => any): this

once(event: "typingStop", listener: (payload: TypingStop) => any): this

once(
  event: USER_ACHIEVEMENT_UPDATE,
  listener: (payload: UserAchievementUpdate) => any,
): this

once(
  event: "userAchievementUpdate",
  listener: (payload: UserAchievementUpdate) => any,
): this

once(
  event: USER_CONNECTIONS_UPDATE,
  listener: (payload: UserConnectionsUpdate) => any,
): this

once(
  event: "userConnectionsUpdate",
  listener: (payload: UserConnectionsUpdate) => any,
): this

once(
  event: USER_FEED_SETTINGS_UPDATE,
  listener: (payload: UserFeedSettingsUpdate) => any,
): this

once(
  event: "userFeedSettingsUpdate",
  listener: (payload: UserFeedSettingsUpdate) => any,
): this

once(
  event: USER_GUILD_SETTINGS_UPDATE,
  listener: (payload: UserGuildSettingsUpdate) => any,
): this

once(
  event: "userGuildSettingsUpdate",
  listener: (payload: UserGuildSettingsUpdate) => any,
): this

once(
  event: USER_PAYMENT_SOURCES_UPDATE,
  listener: (payload: UserPaymentSourcesUpdate) => any,
): this

once(
  event: "userPaymentSourcesUpdate",
  listener: (payload: UserPaymentSourcesUpdate) => any,
): this

once(event: USER_PAYMENTS_UPDATE, listener: (payload: UserPaymentsUpdate) => any): this

once(event: "userPaymentsUpdate", listener: (payload: UserPaymentsUpdate) => any): this

once(
  event: USER_REQUIRED_ACTION_UPDATE,
  listener: (payload: UserRequiredActionUpdate) => any,
): this

once(
  event: "userRequiredActionUpdate",
  listener: (payload: UserRequiredActionUpdate) => any,
): this

once(event: USER_UPDATE, listener: (payload: UserUpdate) => any): this

once(event: "userUpdate", listener: (payload: UserUpdate) => any): this

once(event: USERS_UPDATE, listener: (payload: UsersUpdate) => any): this

once(event: "usersUpdate", listener: (payload: UsersUpdate) => any): this

once(
  event: VOICE_CHANNEL_EFFECT_SEND,
  listener: (payload: VoiceChannelEffectSend) => any,
): this

once(
  event: "voiceChannelEffectSend",
  listener: (payload: VoiceChannelEffectSend) => any,
): this

once(
  event: VOICE_CHANNEL_START_TIME_UPDATE,
  listener: (payload: VoiceChannelStartTimeUpdate) => any,
): this

once(
  event: "voiceChannelStartTimeUpdate",
  listener: (payload: VoiceChannelStartTimeUpdate) => any,
): this

once(
  event: VOICE_CHANNEL_STATUS_UPDATE,
  listener: (payload: VoiceChannelStatusUpdate) => any,
): this

once(
  event: "voiceChannelStatusUpdate",
  listener: (payload: VoiceChannelStatusUpdate) => any,
): this

once(event: VOICE_SERVER_UPDATE, listener: (payload: VoiceServerUpdate) => any): this

once(event: "voiceServerUpdate", listener: (payload: VoiceServerUpdate) => any): this

once(event: VOICE_STATE_UPDATE, listener: (payload: VoiceStateUpdate) => any): this

once(event: "voiceStateUpdate", listener: (payload: VoiceStateUpdate) => any): this

once(event: WEBHOOKS_UPDATE, listener: (payload: WebhooksUpdate) => any): this

once(event: "webhooksUpdate", listener: (payload: WebhooksUpdate) => any): this

once(event: RAW, listener: (payload: Raw) => any): this

once(event: "raw", listener: (payload: Raw) => any): this

once(event: REST_REQUEST, listener: (payload: RestRequest) => any): this

once(event: "restRequest", listener: (payload: RestRequest) => any): this

once(event: REST_RESPONSE, listener: (payload: RestResponse) => any): this

once(event: "restResponse", listener: (payload: RestResponse) => any): this

once(event: UNKNOWN, listener: (payload: Unknown) => any): this

once(event: "unknown", listener: (payload: Unknown) => any): this

once(event: WARN, listener: (payload: Warn) => any): this

once(event: "warn", listener: (payload: Warn) => any): this

once(event: KILLED, listener: (payload: Killed) => any): this

once(event: "killed", listener: (payload: Killed) => any): this

Overrides EventSpewer.once

ping()

async src/client.ts:453

ping(): Promise<{ gateway: number; rest: number }>

requestGuildMembers()

async src/client.ts:466

requestGuildMembers(
  guildId: string,
  oldOptions: { limit?: number; presences?: boolean; query: string; timeout?: number; userIds?: string[] },
): Promise<{ members: BaseCollection<string, Member>; nonce: string; notFound: BaseSet<string>; presences: BaseCollection<string, Presence> }>

Parameters

guildId

string

oldOptions

{ limit?: number; presences?: boolean; query: string; timeout?: number; userIds?: string[] }

oldOptions.limit?

number

oldOptions.presences?

boolean

oldOptions.query

string

oldOptions.timeout?

number

oldOptions.userIds?

string[]

reset()

src/client.ts:543

reset(
  applications?: boolean,
  applicationEmojis?: boolean,
  applicationCommandPermissions?: boolean,
): void

Parameters

applications?

boolean

Default true

applicationEmojis?

boolean

Default true

applicationCommandPermissions?

boolean

Default true

run()

async src/client.ts:581

run(options?: ShardClientRunOptions): Promise<ShardClient>

subscribe()

src/client.ts:1200

subscribe(event: string | symbol, listener: (...args: any[]) => void): EventSubscription

subscribe(
  event: ACTIVITY_JOIN_INVITE,
  listener: (payload: ActivityJoinInvite) => any,
): EventSubscription

subscribe(
  event: "activityJoinInvite",
  listener: (payload: ActivityJoinInvite) => any,
): EventSubscription

subscribe(
  event: ACTIVITY_JOIN_REQUEST,
  listener: (payload: ActivityJoinRequest) => any,
): EventSubscription

subscribe(
  event: "activityJoinRequest",
  listener: (payload: ActivityJoinRequest) => any,
): EventSubscription

subscribe(
  event: ACTIVITY_START,
  listener: (payload: ActivityStart) => any,
): EventSubscription

subscribe(
  event: "activityStart",
  listener: (payload: ActivityStart) => any,
): EventSubscription

subscribe(
  event: APPLICATION_COMMAND_CREATE,
  listener: (payload: ApplicationCommandCreate) => any,
): EventSubscription

subscribe(
  event: "applicationCommandCreate",
  listener: (payload: ApplicationCommandCreate) => any,
): EventSubscription

subscribe(
  event: APPLICATION_COMMAND_DELETE,
  listener: (payload: ApplicationCommandDelete) => any,
): EventSubscription

subscribe(
  event: "applicationCommandDelete",
  listener: (payload: ApplicationCommandDelete) => any,
): EventSubscription

subscribe(
  event: APPLICATION_COMMAND_UPDATE,
  listener: (payload: ApplicationCommandUpdate) => any,
): EventSubscription

subscribe(
  event: "applicationCommandUpdate",
  listener: (payload: ApplicationCommandUpdate) => any,
): EventSubscription

subscribe(
  event: BRAINTREE_POPUP_BRIDGE_CALLBACK,
  listener: (payload: BraintreePopupBridgeCallback) => any,
): EventSubscription

subscribe(
  event: "braintreePopupBridgeCallback",
  listener: (payload: BraintreePopupBridgeCallback) => any,
): EventSubscription

subscribe(
  event: AUTO_MODERATION_ACTION_EXECUTION,
  listener: (payload: AutoModerationActionExecution) => any,
): EventSubscription

subscribe(
  event: "autoModerationActionExecution",
  listener: (payload: AutoModerationActionExecution) => any,
): EventSubscription

subscribe(
  event: AUTO_MODERATION_RULE_CREATE,
  listener: (payload: AutoModerationRuleCreate) => any,
): EventSubscription

subscribe(
  event: "autoModerationRuleCreate",
  listener: (payload: AutoModerationRuleCreate) => any,
): EventSubscription

subscribe(
  event: AUTO_MODERATION_RULE_DELETE,
  listener: (payload: AutoModerationRuleDelete) => any,
): EventSubscription

subscribe(
  event: "autoModerationRuleDelete",
  listener: (payload: AutoModerationRuleDelete) => any,
): EventSubscription

subscribe(
  event: AUTO_MODERATION_RULE_UPDATE,
  listener: (payload: AutoModerationRuleUpdate) => any,
): EventSubscription

subscribe(
  event: "autoModerationRuleUpdate",
  listener: (payload: AutoModerationRuleUpdate) => any,
): EventSubscription

subscribe(event: CALL_CREATE, listener: (payload: CallCreate) => any): EventSubscription

subscribe(event: "callCreate", listener: (payload: CallCreate) => any): EventSubscription

subscribe(event: CALL_DELETE, listener: (payload: CallDelete) => any): EventSubscription

subscribe(event: "callDelete", listener: (payload: CallDelete) => any): EventSubscription

subscribe(event: CALL_UPDATE, listener: (payload: CallUpdate) => any): EventSubscription

subscribe(event: "callUpdate", listener: (payload: CallUpdate) => any): EventSubscription

subscribe(
  event: CHANNEL_CREATE,
  listener: (payload: ChannelCreate) => any,
): EventSubscription

subscribe(
  event: "channelCreate",
  listener: (payload: ChannelCreate) => any,
): EventSubscription

subscribe(
  event: CHANNEL_DELETE,
  listener: (payload: ChannelDelete) => any,
): EventSubscription

subscribe(
  event: "channelDelete",
  listener: (payload: ChannelDelete) => any,
): EventSubscription

subscribe(
  event: CHANNEL_UPDATE,
  listener: (payload: ChannelUpdate) => any,
): EventSubscription

subscribe(
  event: "channelUpdate",
  listener: (payload: ChannelUpdate) => any,
): EventSubscription

subscribe(
  event: CHANNEL_PINS_ACK,
  listener: (payload: ChannelPinsAck) => any,
): EventSubscription

subscribe(
  event: "channelPinsAck",
  listener: (payload: ChannelPinsAck) => any,
): EventSubscription

subscribe(event: CHANNEL_INFO, listener: (payload: ChannelInfo) => any): EventSubscription

subscribe(
  event: "channelInfo",
  listener: (payload: ChannelInfo) => any,
): EventSubscription

subscribe(
  event: CHANNEL_PINS_UPDATE,
  listener: (payload: ChannelPinsUpdate) => any,
): EventSubscription

subscribe(
  event: "channelPinsUpdate",
  listener: (payload: ChannelPinsUpdate) => any,
): EventSubscription

subscribe(
  event: CHANNEL_RECIPIENT_ADD,
  listener: (payload: ChannelRecipientAdd) => any,
): EventSubscription

subscribe(
  event: "channelRecipientAdd",
  listener: (payload: ChannelRecipientAdd) => any,
): EventSubscription

subscribe(
  event: CHANNEL_RECIPIENT_REMOVE,
  listener: (payload: ChannelRecipientRemove) => any,
): EventSubscription

subscribe(
  event: "channelRecipientRemove",
  listener: (payload: ChannelRecipientRemove) => any,
): EventSubscription

subscribe(
  event: ENTITLEMENT_CREATE,
  listener: (payload: EntitlementCreate) => any,
): EventSubscription

subscribe(
  event: "entitlementCreate",
  listener: (payload: EntitlementCreate) => any,
): EventSubscription

subscribe(
  event: ENTITLEMENT_DELETE,
  listener: (payload: EntitlementDelete) => any,
): EventSubscription

subscribe(
  event: "entitlementDelete",
  listener: (payload: EntitlementDelete) => any,
): EventSubscription

subscribe(
  event: ENTITLEMENT_UPDATE,
  listener: (payload: EntitlementUpdate) => any,
): EventSubscription

subscribe(
  event: "entitlementUpdate",
  listener: (payload: EntitlementUpdate) => any,
): EventSubscription

subscribe(
  event: FRIEND_SUGGESTION_CREATE,
  listener: (payload: FriendSuggestionCreate) => any,
): EventSubscription

subscribe(
  event: "friendSuggestionCreate",
  listener: (payload: FriendSuggestionCreate) => any,
): EventSubscription

subscribe(
  event: FRIEND_SUGGESTION_DELETE,
  listener: (payload: FriendSuggestionDelete) => any,
): EventSubscription

subscribe(
  event: "friendSuggestionDelete",
  listener: (payload: FriendSuggestionDelete) => any,
): EventSubscription

subscribe(
  event: GATEWAY_READY,
  listener: (payload: GatewayReady) => any,
): EventSubscription

subscribe(
  event: "gatewayReady",
  listener: (payload: GatewayReady) => any,
): EventSubscription

subscribe(
  event: GATEWAY_RESUMED,
  listener: (payload: GatewayResumed) => any,
): EventSubscription

subscribe(
  event: "gatewayResumed",
  listener: (payload: GatewayResumed) => any,
): EventSubscription

subscribe(
  event: GIFT_CODE_UPDATE,
  listener: (payload: GiftCodeUpdate) => any,
): EventSubscription

subscribe(
  event: "giftCodeUpdate",
  listener: (payload: GiftCodeUpdate) => any,
): EventSubscription

subscribe(
  event: GUILD_AUDIT_LOG_ENTRY_CREATE,
  listener: (payload: GuildAuditLogEntryCreate) => any,
): EventSubscription

subscribe(
  event: "guildAuditLogEntryCreate",
  listener: (payload: GuildAuditLogEntryCreate) => any,
): EventSubscription

subscribe(
  event: GUILD_BAN_ADD,
  listener: (payload: GuildBanAdd) => any,
): EventSubscription

subscribe(
  event: "guildBanAdd",
  listener: (payload: GuildBanAdd) => any,
): EventSubscription

subscribe(
  event: GUILD_BAN_REMOVE,
  listener: (payload: GuildBanRemove) => any,
): EventSubscription

subscribe(
  event: "guildBanRemove",
  listener: (payload: GuildBanRemove) => any,
): EventSubscription

subscribe(event: GUILD_CREATE, listener: (payload: GuildCreate) => any): EventSubscription

subscribe(
  event: "guildCreate",
  listener: (payload: GuildCreate) => any,
): EventSubscription

subscribe(event: GUILD_DELETE, listener: (payload: GuildDelete) => any): EventSubscription

subscribe(
  event: "guildDelete",
  listener: (payload: GuildDelete) => any,
): EventSubscription

subscribe(
  event: GUILD_EMOJIS_UPDATE,
  listener: (payload: GuildEmojisUpdate) => any,
): EventSubscription

subscribe(
  event: "guildEmojisUpdate",
  listener: (payload: GuildEmojisUpdate) => any,
): EventSubscription

subscribe(
  event: GUILD_INTEGRATIONS_UPDATE,
  listener: (payload: GuildIntegrationsUpdate) => any,
): EventSubscription

subscribe(
  event: "guildIntegrationsUpdate",
  listener: (payload: GuildIntegrationsUpdate) => any,
): EventSubscription

subscribe(
  event: GUILD_MEMBER_ADD,
  listener: (payload: GuildMemberAdd) => any,
): EventSubscription

subscribe(
  event: "guildMemberAdd",
  listener: (payload: GuildMemberAdd) => any,
): EventSubscription

subscribe(
  event: GUILD_MEMBER_LIST_UPDATE,
  listener: (payload: GuildMemberListUpdate) => any,
): EventSubscription

subscribe(
  event: "guildMemberListUpdate",
  listener: (payload: GuildMemberListUpdate) => any,
): EventSubscription

subscribe(
  event: GUILD_MEMBER_REMOVE,
  listener: (payload: GuildMemberRemove) => any,
): EventSubscription

subscribe(
  event: "guildMemberRemove",
  listener: (payload: GuildMemberRemove) => any,
): EventSubscription

subscribe(
  event: GUILD_MEMBER_UPDATE,
  listener: (payload: GuildMemberUpdate) => any,
): EventSubscription

subscribe(
  event: "guildMemberUpdate",
  listener: (payload: GuildMemberUpdate) => any,
): EventSubscription

subscribe(
  event: GUILD_MEMBERS_CHUNK,
  listener: (payload: GuildMembersChunk) => any,
): EventSubscription

subscribe(
  event: "guildMembersChunk",
  listener: (payload: GuildMembersChunk) => any,
): EventSubscription

subscribe(event: GUILD_READY, listener: (payload: GuildReady) => any): EventSubscription

subscribe(event: "guildReady", listener: (payload: GuildReady) => any): EventSubscription

subscribe(
  event: GUILD_ROLE_CREATE,
  listener: (payload: GuildRoleCreate) => any,
): EventSubscription

subscribe(
  event: "guildRoleCreate",
  listener: (payload: GuildRoleCreate) => any,
): EventSubscription

subscribe(
  event: GUILD_ROLE_DELETE,
  listener: (payload: GuildRoleDelete) => any,
): EventSubscription

subscribe(
  event: "guildRoleDelete",
  listener: (payload: GuildRoleDelete) => any,
): EventSubscription

subscribe(
  event: GUILD_ROLE_UPDATE,
  listener: (payload: GuildRoleUpdate) => any,
): EventSubscription

subscribe(
  event: "guildRoleUpdate",
  listener: (payload: GuildRoleUpdate) => any,
): EventSubscription

subscribe(
  event: GUILD_SCHEDULED_EVENT_USER_ADD,
  listener: (payload: GuildScheduledEventUserAdd) => any,
): EventSubscription

subscribe(
  event: "guildScheduledEventUserAdd",
  listener: (payload: GuildScheduledEventUserAdd) => any,
): EventSubscription

subscribe(
  event: GUILD_SCHEDULED_EVENT_USER_REMOVE,
  listener: (payload: GuildScheduledEventUserRemove) => any,
): EventSubscription

subscribe(
  event: "guildScheduledEventUserRemove",
  listener: (payload: GuildScheduledEventUserRemove) => any,
): EventSubscription

subscribe(
  event: GUILD_SOUNDBOARD_SOUND_CREATE,
  listener: (payload: GuildSoundboardSoundCreate) => any,
): EventSubscription

subscribe(
  event: "guildSoundboardSoundCreate",
  listener: (payload: GuildSoundboardSoundCreate) => any,
): EventSubscription

subscribe(
  event: GUILD_SOUNDBOARD_SOUND_DELETE,
  listener: (payload: GuildSoundboardSoundDelete) => any,
): EventSubscription

subscribe(
  event: "guildSoundboardSoundDelete",
  listener: (payload: GuildSoundboardSoundDelete) => any,
): EventSubscription

subscribe(
  event: GUILD_SOUNDBOARD_SOUND_UPDATE,
  listener: (payload: GuildSoundboardSoundUpdate) => any,
): EventSubscription

subscribe(
  event: "guildSoundboardSoundUpdate",
  listener: (payload: GuildSoundboardSoundUpdate) => any,
): EventSubscription

subscribe(
  event: GUILD_SOUNDBOARD_SOUNDS_UPDATE,
  listener: (payload: GuildSoundboardSoundsUpdate) => any,
): EventSubscription

subscribe(
  event: "guildSoundboardSoundsUpdate",
  listener: (payload: GuildSoundboardSoundsUpdate) => any,
): EventSubscription

subscribe(
  event: SOUNDBOARD_SOUNDS,
  listener: (payload: SoundboardSounds) => any,
): EventSubscription

subscribe(
  event: "soundboardSounds",
  listener: (payload: SoundboardSounds) => any,
): EventSubscription

subscribe(
  event: GUILD_STICKERS_UPDATE,
  listener: (payload: GuildStickersUpdate) => any,
): EventSubscription

subscribe(
  event: "guildStickersUpdate",
  listener: (payload: GuildStickersUpdate) => any,
): EventSubscription

subscribe(event: GUILD_UPDATE, listener: (payload: GuildUpdate) => any): EventSubscription

subscribe(
  event: "guildUpdate",
  listener: (payload: GuildUpdate) => any,
): EventSubscription

subscribe(
  event: INVITE_CREATE,
  listener: (payload: InviteCreate) => any,
): EventSubscription

subscribe(
  event: "inviteCreate",
  listener: (payload: InviteCreate) => any,
): EventSubscription

subscribe(
  event: INVITE_DELETE,
  listener: (payload: InviteDelete) => any,
): EventSubscription

subscribe(
  event: "inviteDelete",
  listener: (payload: InviteDelete) => any,
): EventSubscription

subscribe(
  event: LIBRARY_APPLICATION_UPDATE,
  listener: (payload: LibraryApplicationUpdate) => any,
): EventSubscription

subscribe(
  event: "libraryApplicationUpdate",
  listener: (payload: LibraryApplicationUpdate) => any,
): EventSubscription

subscribe(event: LOBBY_CREATE, listener: (payload: LobbyCreate) => any): EventSubscription

subscribe(
  event: "lobbyCreate",
  listener: (payload: LobbyCreate) => any,
): EventSubscription

subscribe(event: LOBBY_DELETE, listener: (payload: LobbyDelete) => any): EventSubscription

subscribe(
  event: "lobbyDelete",
  listener: (payload: LobbyDelete) => any,
): EventSubscription

subscribe(event: LOBBY_UPDATE, listener: (payload: LobbyUpdate) => any): EventSubscription

subscribe(
  event: "lobbyUpdate",
  listener: (payload: LobbyUpdate) => any,
): EventSubscription

subscribe(
  event: LOBBY_MEMBER_CONNECT,
  listener: (payload: LobbyMemberConnect) => any,
): EventSubscription

subscribe(
  event: "lobbyMemberConnect",
  listener: (payload: LobbyMemberConnect) => any,
): EventSubscription

subscribe(
  event: LOBBY_MEMBER_DISCONNECT,
  listener: (payload: LobbyMemberDisconnect) => any,
): EventSubscription

subscribe(
  event: "lobbyMemberDisconnect",
  listener: (payload: LobbyMemberDisconnect) => any,
): EventSubscription

subscribe(
  event: LOBBY_MEMBER_UPDATE,
  listener: (payload: LobbyMemberUpdate) => any,
): EventSubscription

subscribe(
  event: "lobbyMemberUpdate",
  listener: (payload: LobbyMemberUpdate) => any,
): EventSubscription

subscribe(
  event: LOBBY_MESSAGE,
  listener: (payload: LobbyMessage) => any,
): EventSubscription

subscribe(
  event: "lobbyMessage",
  listener: (payload: LobbyMessage) => any,
): EventSubscription

subscribe(
  event: LOBBY_VOICE_SERVER_UPDATE,
  listener: (payload: LobbyVoiceServerUpdate) => any,
): EventSubscription

subscribe(
  event: "lobbyVoiceServerUpdate",
  listener: (payload: LobbyVoiceServerUpdate) => any,
): EventSubscription

subscribe(
  event: LOBBY_VOICE_STATE_UPDATE,
  listener: (payload: LobbyVoiceStateUpdate) => any,
): EventSubscription

subscribe(
  event: "lobbyVoiceStateUpdate",
  listener: (payload: LobbyVoiceStateUpdate) => any,
): EventSubscription

subscribe(event: MESSAGE_ACK, listener: (payload: MessageAck) => any): EventSubscription

subscribe(event: "messageAck", listener: (payload: MessageAck) => any): EventSubscription

subscribe(
  event: MESSAGE_CREATE,
  listener: (payload: MessageCreate) => any,
): EventSubscription

subscribe(
  event: "messageCreate",
  listener: (payload: MessageCreate) => any,
): EventSubscription

subscribe(
  event: MESSAGE_DELETE,
  listener: (payload: MessageDelete) => any,
): EventSubscription

subscribe(
  event: "messageDelete",
  listener: (payload: MessageDelete) => any,
): EventSubscription

subscribe(
  event: MESSAGE_DELETE_BULK,
  listener: (payload: MessageDeleteBulk) => any,
): EventSubscription

subscribe(
  event: "messageDeleteBulk",
  listener: (payload: MessageDeleteBulk) => any,
): EventSubscription

subscribe(
  event: MESSAGE_REACTION_ADD,
  listener: (payload: MessageReactionAdd) => any,
): EventSubscription

subscribe(
  event: "messageReactionAdd",
  listener: (payload: MessageReactionAdd) => any,
): EventSubscription

subscribe(
  event: MESSAGE_REACTION_REMOVE,
  listener: (payload: MessageReactionRemove) => any,
): EventSubscription

subscribe(
  event: "messageReactionRemove",
  listener: (payload: MessageReactionRemove) => any,
): EventSubscription

subscribe(
  event: MESSAGE_REACTION_REMOVE_ALL,
  listener: (payload: MessageReactionRemoveAll) => any,
): EventSubscription

subscribe(
  event: "messageReactionRemoveAll",
  listener: (payload: MessageReactionRemoveAll) => any,
): EventSubscription

subscribe(
  event: MESSAGE_REACTION_REMOVE_EMOJI,
  listener: (payload: MessageReactionRemoveEmoji) => any,
): EventSubscription

subscribe(
  event: "messageReactionRemoveEmoji",
  listener: (payload: MessageReactionRemoveEmoji) => any,
): EventSubscription

subscribe(
  event: MESSAGE_UPDATE,
  listener: (payload: MessageUpdate) => any,
): EventSubscription

subscribe(
  event: "messageUpdate",
  listener: (payload: MessageUpdate) => any,
): EventSubscription

subscribe(
  event: PRESENCES_REPLACE,
  listener: (payload: PresencesReplace) => any,
): EventSubscription

subscribe(
  event: "presencesReplace",
  listener: (payload: PresencesReplace) => any,
): EventSubscription

subscribe(
  event: PRESENCE_UPDATE,
  listener: (payload: PresenceUpdate) => any,
): EventSubscription

subscribe(
  event: "presenceUpdate",
  listener: (payload: PresenceUpdate) => any,
): EventSubscription

subscribe(event: RATE_LIMITED, listener: (payload: RateLimited) => any): EventSubscription

subscribe(
  event: "rateLimited",
  listener: (payload: RateLimited) => any,
): EventSubscription

subscribe(
  event: RECENT_MENTION_DELETE,
  listener: (payload: RecentMentionDelete) => any,
): EventSubscription

subscribe(
  event: "recentMentionDelete",
  listener: (payload: RecentMentionDelete) => any,
): EventSubscription

subscribe(
  event: RELATIONSHIP_ADD,
  listener: (payload: RelationshipAdd) => any,
): EventSubscription

subscribe(
  event: "relationshipAdd",
  listener: (payload: RelationshipAdd) => any,
): EventSubscription

subscribe(
  event: RELATIONSHIP_REMOVE,
  listener: (payload: RelationshipRemove) => any,
): EventSubscription

subscribe(
  event: "relationshipRemove",
  listener: (payload: RelationshipRemove) => any,
): EventSubscription

subscribe(
  event: SESSIONS_REPLACE,
  listener: (payload: SessionsReplace) => any,
): EventSubscription

subscribe(
  event: "sessionsReplace",
  listener: (payload: SessionsReplace) => any,
): EventSubscription

subscribe(
  event: STAGE_INSTANCE_CREATE,
  listener: (payload: StageInstanceCreate) => any,
): EventSubscription

subscribe(
  event: "stageInstanceCreate",
  listener: (payload: StageInstanceCreate) => any,
): EventSubscription

subscribe(
  event: STAGE_INSTANCE_DELETE,
  listener: (payload: StageInstanceDelete) => any,
): EventSubscription

subscribe(
  event: "stageInstanceDelete",
  listener: (payload: StageInstanceDelete) => any,
): EventSubscription

subscribe(
  event: STAGE_INSTANCE_UPDATE,
  listener: (payload: StageInstanceUpdate) => any,
): EventSubscription

subscribe(
  event: "stageInstanceUpdate",
  listener: (payload: StageInstanceUpdate) => any,
): EventSubscription

subscribe(
  event: STREAM_CREATE,
  listener: (payload: StreamCreate) => any,
): EventSubscription

subscribe(
  event: "streamCreate",
  listener: (payload: StreamCreate) => any,
): EventSubscription

subscribe(
  event: STREAM_DELETE,
  listener: (payload: StreamDelete) => any,
): EventSubscription

subscribe(
  event: "streamDelete",
  listener: (payload: StreamDelete) => any,
): EventSubscription

subscribe(
  event: STREAM_SERVER_UPDATE,
  listener: (payload: StreamServerUpdate) => any,
): EventSubscription

subscribe(
  event: "streamServerUpdate",
  listener: (payload: StreamServerUpdate) => any,
): EventSubscription

subscribe(
  event: STREAM_UPDATE,
  listener: (payload: StreamUpdate) => any,
): EventSubscription

subscribe(
  event: "streamUpdate",
  listener: (payload: StreamUpdate) => any,
): EventSubscription

subscribe(
  event: SUBSCRIPTION_CREATE,
  listener: (payload: SubscriptionCreate) => any,
): EventSubscription

subscribe(
  event: "subscriptionCreate",
  listener: (payload: SubscriptionCreate) => any,
): EventSubscription

subscribe(
  event: SUBSCRIPTION_DELETE,
  listener: (payload: SubscriptionDelete) => any,
): EventSubscription

subscribe(
  event: "subscriptionDelete",
  listener: (payload: SubscriptionDelete) => any,
): EventSubscription

subscribe(
  event: SUBSCRIPTION_UPDATE,
  listener: (payload: SubscriptionUpdate) => any,
): EventSubscription

subscribe(
  event: "subscriptionUpdate",
  listener: (payload: SubscriptionUpdate) => any,
): EventSubscription

subscribe(
  event: THREAD_CREATE,
  listener: (payload: ThreadCreate) => any,
): EventSubscription

subscribe(
  event: "threadCreate",
  listener: (payload: ThreadCreate) => any,
): EventSubscription

subscribe(
  event: THREAD_DELETE,
  listener: (payload: ThreadDelete) => any,
): EventSubscription

subscribe(
  event: "threadDelete",
  listener: (payload: ThreadDelete) => any,
): EventSubscription

subscribe(
  event: THREAD_LIST_SYNC,
  listener: (payload: ThreadListSync) => any,
): EventSubscription

subscribe(
  event: "threadListSync",
  listener: (payload: ThreadListSync) => any,
): EventSubscription

subscribe(
  event: THREAD_MEMBER_UPDATE,
  listener: (payload: ThreadMemberUpdate) => any,
): EventSubscription

subscribe(
  event: "threadMemberUpdate",
  listener: (payload: ThreadMemberUpdate) => any,
): EventSubscription

subscribe(
  event: THREAD_MEMBERS_UPDATE,
  listener: (payload: ThreadMembersUpdate) => any,
): EventSubscription

subscribe(
  event: "threadMembersUpdate",
  listener: (payload: ThreadMembersUpdate) => any,
): EventSubscription

subscribe(
  event: THREAD_UPDATE,
  listener: (payload: ThreadUpdate) => any,
): EventSubscription

subscribe(
  event: "threadUpdate",
  listener: (payload: ThreadUpdate) => any,
): EventSubscription

subscribe(event: TYPING_START, listener: (payload: TypingStart) => any): EventSubscription

subscribe(
  event: "typingStart",
  listener: (payload: TypingStart) => any,
): EventSubscription

subscribe(event: TYPING_STOP, listener: (payload: TypingStop) => any): EventSubscription

subscribe(event: "typingStop", listener: (payload: TypingStop) => any): EventSubscription

subscribe(
  event: USER_ACHIEVEMENT_UPDATE,
  listener: (payload: UserAchievementUpdate) => any,
): EventSubscription

subscribe(
  event: "userAchievementUpdate",
  listener: (payload: UserAchievementUpdate) => any,
): EventSubscription

subscribe(
  event: USER_CONNECTIONS_UPDATE,
  listener: (payload: UserConnectionsUpdate) => any,
): EventSubscription

subscribe(
  event: "userConnectionsUpdate",
  listener: (payload: UserConnectionsUpdate) => any,
): EventSubscription

subscribe(
  event: USER_FEED_SETTINGS_UPDATE,
  listener: (payload: UserFeedSettingsUpdate) => any,
): EventSubscription

subscribe(
  event: "userFeedSettingsUpdate",
  listener: (payload: UserFeedSettingsUpdate) => any,
): EventSubscription

subscribe(
  event: USER_GUILD_SETTINGS_UPDATE,
  listener: (payload: UserGuildSettingsUpdate) => any,
): EventSubscription

subscribe(
  event: "userGuildSettingsUpdate",
  listener: (payload: UserGuildSettingsUpdate) => any,
): EventSubscription

subscribe(
  event: USER_PAYMENT_SOURCES_UPDATE,
  listener: (payload: UserPaymentSourcesUpdate) => any,
): EventSubscription

subscribe(
  event: "userPaymentSourcesUpdate",
  listener: (payload: UserPaymentSourcesUpdate) => any,
): EventSubscription

subscribe(
  event: USER_PAYMENTS_UPDATE,
  listener: (payload: UserPaymentsUpdate) => any,
): EventSubscription

subscribe(
  event: "userPaymentsUpdate",
  listener: (payload: UserPaymentsUpdate) => any,
): EventSubscription

subscribe(
  event: USER_REQUIRED_ACTION_UPDATE,
  listener: (payload: UserRequiredActionUpdate) => any,
): EventSubscription

subscribe(
  event: "userRequiredActionUpdate",
  listener: (payload: UserRequiredActionUpdate) => any,
): EventSubscription

subscribe(event: USER_UPDATE, listener: (payload: UserUpdate) => any): EventSubscription

subscribe(event: "userUpdate", listener: (payload: UserUpdate) => any): EventSubscription

subscribe(event: USERS_UPDATE, listener: (payload: UsersUpdate) => any): EventSubscription

subscribe(
  event: "usersUpdate",
  listener: (payload: UsersUpdate) => any,
): EventSubscription

subscribe(
  event: VOICE_CHANNEL_EFFECT_SEND,
  listener: (payload: VoiceChannelEffectSend) => any,
): EventSubscription

subscribe(
  event: "voiceChannelEffectSend",
  listener: (payload: VoiceChannelEffectSend) => any,
): EventSubscription

subscribe(
  event: VOICE_CHANNEL_START_TIME_UPDATE,
  listener: (payload: VoiceChannelStartTimeUpdate) => any,
): EventSubscription

subscribe(
  event: "voiceChannelStartTimeUpdate",
  listener: (payload: VoiceChannelStartTimeUpdate) => any,
): EventSubscription

subscribe(
  event: VOICE_CHANNEL_STATUS_UPDATE,
  listener: (payload: VoiceChannelStatusUpdate) => any,
): EventSubscription

subscribe(
  event: "voiceChannelStatusUpdate",
  listener: (payload: VoiceChannelStatusUpdate) => any,
): EventSubscription

subscribe(
  event: VOICE_SERVER_UPDATE,
  listener: (payload: VoiceServerUpdate) => any,
): EventSubscription

subscribe(
  event: "voiceServerUpdate",
  listener: (payload: VoiceServerUpdate) => any,
): EventSubscription

subscribe(
  event: VOICE_STATE_UPDATE,
  listener: (payload: VoiceStateUpdate) => any,
): EventSubscription

subscribe(
  event: "voiceStateUpdate",
  listener: (payload: VoiceStateUpdate) => any,
): EventSubscription

subscribe(
  event: WEBHOOKS_UPDATE,
  listener: (payload: WebhooksUpdate) => any,
): EventSubscription

subscribe(
  event: "webhooksUpdate",
  listener: (payload: WebhooksUpdate) => any,
): EventSubscription

subscribe(event: RAW, listener: (payload: Raw) => any): EventSubscription

subscribe(event: "raw", listener: (payload: Raw) => any): EventSubscription

subscribe(event: REST_REQUEST, listener: (payload: RestRequest) => any): EventSubscription

subscribe(
  event: "restRequest",
  listener: (payload: RestRequest) => any,
): EventSubscription

subscribe(
  event: REST_RESPONSE,
  listener: (payload: RestResponse) => any,
): EventSubscription

subscribe(
  event: "restResponse",
  listener: (payload: RestResponse) => any,
): EventSubscription

subscribe(event: UNKNOWN, listener: (payload: Unknown) => any): EventSubscription

subscribe(event: "unknown", listener: (payload: Unknown) => any): EventSubscription

subscribe(event: WARN, listener: (payload: Warn) => any): EventSubscription

subscribe(event: "warn", listener: (payload: Warn) => any): EventSubscription

subscribe(event: KILLED, listener: (payload: Killed) => any): EventSubscription

subscribe(event: "killed", listener: (payload: Killed) => any): EventSubscription

Overrides EventSpewer.subscribe

toString()

src/client.ts:694

toString(): string

Returns a string representation of an object.

voiceConnect()

async src/client.ts:626

voiceConnect(
  guildId?: string | null,
  channelId?: string | null,
  options?: VoiceConnectOptions,
): Promise<VoiceConnectObject | null>

Parameters

guildId?

string | null

Guild Id you want to connect to, if a user and wanting to connect to a Dm Channel, keep this blank

channelId?

string | null

Channel Id you want to connect to or move to

options?

VoiceConnectOptions

Options to pass into the detritus-client-socket's gateway's voiceConnect

Returns

Promise<VoiceConnectObject | null>

Returns a promise that resolves into a Voice Connection object and an isNew variable. isNew is used to see if the connection was reused (e.g. changing channels) so you can put listeners on or not