discord.js | Client

Search...

Client

export class Client<Ready extends boolean = boolean> extends BaseClient

export class Client<Ready extends boolean = boolean> extends BaseClient

The main hub for interacting with the Discord API, and the starting point for any bot.

Extends

BaseClient

Name	Constraints	Optional	Default	Description
Ready	boolean	Yes	boolean	None

constructor(options)

Name	Type	Optional	Description
options	ClientOptions	No	None

applicationCommandPermissionsUpdate

Emitted whenever permissions for an application command in a guild were updated. This includes permission updates for other applications in addition to the logged in client, check data.applicationId to verify which application the update is for

Name	Type	Optional	Description
data	ApplicationCommandPermissionsUpdateData	No	The updated permissions

autoModerationActionExecution

Emitted whenever an auto moderation rule is triggered. This event requires the PermissionFlagsBits.ManageGuild permission.

Name	Type	Optional	Description
autoModerationActionExecution	AutoModerationActionExecution	No	The data of the execution

autoModerationRuleCreate

Emitted whenever an auto moderation rule is created. This event requires the PermissionFlagsBits.ManageGuild permission.

Name	Type	Optional	Description
autoModerationRule	AutoModerationRule	No	The created auto moderation rule

autoModerationRuleDelete

Emitted whenever an auto moderation rule is deleted. This event requires the PermissionFlagsBits.ManageGuild permission.

Name	Type	Optional	Description
autoModerationRule	AutoModerationRule	No	The deleted auto moderation rule

autoModerationRuleUpdate

Emitted whenever an auto moderation rule gets updated. This event requires the PermissionFlagsBits.ManageGuild permission.

Name	Type	Optional	Description
oldAutoModerationRule	AutoModerationRule \| null	No	The auto moderation rule before the update
newAutoModerationRule	AutoModerationRule	No	The auto moderation rule after the update

channelCreate

Emitted whenever a guild channel is created.

Name	Type	Optional	Description
channel	GuildChannel	No	The channel that was created

channelDelete

Emitted whenever a channel is deleted.

Name	Type	Optional	Description
channel	DMChannel \| GuildChannel	No	The channel that was deleted

channelPinsUpdate

Emitted whenever the pins of a channel are updated. Due to the nature of the WebSocket event, not much information can be provided easily here - you need to manually check the pins yourself.

Name	Type	Optional	Description
channel	TextBasedChannels	No	The channel that the pins update occurred in
time	Date	No	The time of the pins update

channelUpdate

Emitted whenever a channel is updated - e.g. name change, topic change, channel type change.

Name	Type	Optional	Description
oldChannel	DMChannel \| GuildChannel	No	The channel before the update
newChannel	DMChannel \| GuildChannel	No	The channel after the update

clientReady

Emitted when the client becomes ready to start working.

Name	Type	Optional	Description
client	Client	No	The client

debug

Emitted for general debugging information.

Name	Type	Optional	Description
info	string	No	The debug information

emojiCreate

Emitted whenever a custom emoji is created in a guild.

Name	Type	Optional	Description
emoji	GuildEmoji	No	The emoji that was created

emojiDelete

Emitted whenever a custom emoji is deleted in a guild.

Name	Type	Optional	Description
emoji	GuildEmoji	No	The emoji that was deleted

emojiUpdate

Emitted whenever a custom emoji is updated in a guild.

Name	Type	Optional	Description
oldEmoji	GuildEmoji	No	The old emoji
newEmoji	GuildEmoji	No	The new emoji

entitlementCreate

Emitted whenever an entitlement is created.

Name	Type	Optional	Description
entitlement	Entitlement	No	The entitlement that was created

entitlementDelete

Emitted whenever an entitlement is deleted. Entitlements are not deleted when they expire. This is only triggered when Discord issues a refund or deletes the entitlement manually.

Name	Type	Optional	Description
entitlement	Entitlement	No	The entitlement that was deleted

entitlementUpdate

Emitted whenever an entitlement is updated - i.e. when a user's subscription renews.

Name	Type	Optional	Description
oldEntitlement	Entitlement \| null	No	The entitlement before the update
newEntitlement	Entitlement	No	The entitlement after the update

error

Emitted when the client encounters an error. Errors thrown within this event do not have a catch handler, it is recommended to not use async functions as error event handlers. See the [Node.js docs](https://nodejs.org/api/events.html#capture-rejections-of-promises) for details.

Name	Type	Optional	Description
error	Error	No	The error encountered

guildAuditLogEntryCreate

Emitted whenever a guild audit log entry is created.

Name	Type	Optional	Description
auditLogEntry	GuildAuditLogsEntry	No	The entry that was created
guild	Guild	No	The guild where the entry was created

guildAvailable

Emitted whenever a guild becomes available.

Name	Type	Optional	Description
guild	Guild	No	The guild that became available

guildBanAdd

Emitted whenever a member is banned from a guild.

Name	Type	Optional	Description
ban	GuildBan	No	The ban that occurred

guildBanRemove

Emitted whenever a member is unbanned from a guild.

Name	Type	Optional	Description
ban	GuildBan	No	The ban that was removed

guildCreate

Emitted whenever the client joins a guild.

Name	Type	Optional	Description
guild	Guild	No	The created guild

guildDelete

Emitted whenever a guild kicks the client or the guild is deleted/left.

Name	Type	Optional	Description
guild	Guild	No	The guild that was deleted

guildIntegrationsUpdate

Emitted whenever a guild integration is updated

Name	Type	Optional	Description
guild	Guild	No	The guild whose integrations were updated

guildMemberAdd

Emitted whenever a user joins a guild.

Name	Type	Optional	Description
member	GuildMember	No	The member that has joined a guild

guildMemberAvailable

Emitted whenever a member becomes available.

Name	Type	Optional	Description
member	GuildMember	No	The member that became available

guildMemberRemove

Emitted whenever a member leaves a guild, or is kicked.

Name	Type	Optional	Description
member	GuildMember	No	The member that has left/been kicked from the guild

guildMembersChunk

Emitted whenever a chunk of guild members is received (all members come from the same guild).

Name	Type	Optional	Description
members	Collection<Snowflake, GuildMember>	No	The members in the chunk
guild	Guild	No	The guild related to the member chunk
chunk	GuildMembersChunk	No	Properties of the received chunk

guildMemberUpdate

Emitted whenever a guild member changes - i.e. new role, removed role, nickname.

Name	Type	Optional	Description
oldMember	GuildMember	No	The member before the update
newMember	GuildMember	No	The member after the update

guildScheduledEventCreate

Emitted whenever a guild scheduled event is created.

Name	Type	Optional	Description
guildScheduledEvent	GuildScheduledEvent	No	The created guild scheduled event

guildScheduledEventDelete

Emitted whenever a guild scheduled event is deleted.

Name	Type	Optional	Description
guildScheduledEvent	GuildScheduledEvent	No	The deleted guild scheduled event

guildScheduledEventUpdate

Emitted whenever a guild scheduled event gets updated.

Name	Type	Optional	Description
oldGuildScheduledEvent	GuildScheduledEvent \| null	No	The guild scheduled event object before the update
newGuildScheduledEvent	GuildScheduledEvent	No	The guild scheduled event object after the update

guildScheduledEventUserAdd

Emitted whenever a user subscribes to a guild scheduled event

Name	Type	Optional	Description
guildScheduledEvent	GuildScheduledEvent	No	The guild scheduled event
user	User	No	The user who subscribed

guildScheduledEventUserRemove

Emitted whenever a user unsubscribes from a guild scheduled event

Name	Type	Optional	Description
guildScheduledEvent	GuildScheduledEvent	No	The guild scheduled event
user	User	No	The user who unsubscribed

guildUnavailable

Emitted whenever a guild becomes unavailable, likely due to a server outage.

Name	Type	Optional	Description
guild	Guild	No	The guild that has become unavailable

guildUpdate

Emitted whenever a guild is updated - e.g. name change.

Name	Type	Optional	Description
oldGuild	Guild	No	The guild before the update
newGuild	Guild	No	The guild after the update

interactionCreate

Emitted when an interaction is created.

Name	Type	Optional	Description
interaction	BaseInteraction	No	The interaction which was created

inviteCreate

Emitted when an invite is created. This event requires the PermissionFlagsBits.ManageChannels permission for the channel.

Name	Type	Optional	Description
invite	Invite	No	The invite that was created

inviteDelete

Emitted when an invite is deleted. This event requires the PermissionFlagsBits.ManageChannels permission for the channel.

Name	Type	Optional	Description
invite	Invite	No	The invite that was deleted

messageCreate

Emitted whenever a message is created.

Name	Type	Optional	Description
message	Message	No	The created message

messageDelete

Emitted whenever a message is deleted.

Name	Type	Optional	Description
message	Message	No	The deleted message

messageDeleteBulk

Emitted whenever messages are deleted in bulk.

Name	Type	Optional	Description
messages	Collection<Snowflake, Message>	No	The deleted messages, mapped by their id
channel	GuildTextBasedChannel	No	The channel that the messages were deleted in

messagePollVoteAdd

Emitted whenever a user votes in a poll.

Name	Type	Optional	Description
pollAnswer	PollAnswer	No	The answer that was voted on
userId	Snowflake	No	The id of the user that voted

messagePollVoteRemove

Emitted whenever a user removes their vote in a poll.

Name	Type	Optional	Description
pollAnswer	PollAnswer	No	The answer where the vote was removed
userId	Snowflake	No	The id of the user that removed their vote

messageReactionAdd

Emitted whenever a reaction is added to a cached message.

Name	Type	Optional	Description
messageReaction	MessageReaction	No	The reaction object
user	User	No	The user that applied the guild or reaction emoji
details	MessageReactionEventDetails	No	Details of adding the reaction

messageReactionRemove

Emitted whenever a reaction is removed from a cached message.

Name	Type	Optional	Description
messageReaction	MessageReaction	No	The reaction object
user	User	No	The user whose emoji or reaction emoji was removed
details	MessageReactionEventDetails	No	Details of removing the reaction

messageReactionRemoveAll

Emitted whenever all reactions are removed from a cached message.

Name	Type	Optional	Description
message	Message	No	The message the reactions were removed from
reactions	Collection<(string\|Snowflake), MessageReaction>	No	The cached message reactions that were removed.

messageReactionRemoveEmoji

Emitted when a bot removes an emoji reaction from a cached message.

Name	Type	Optional	Description
reaction	MessageReaction	No	The reaction that was removed

messageUpdate

Emitted whenever a message is updated - e.g. embed or content change.

Name	Type	Optional	Description
oldMessage	Message	No	The message before the update
newMessage	Message	No	The message after the update

presenceUpdate

Emitted whenever a guild member's presence (e.g. status, activity) is changed.

Name	Type	Optional	Description
oldPresence	Presence \| null	No	The presence before the update, if one at all
newPresence	Presence	No	The presence after the update

roleCreate

Emitted whenever a role is created.

Name	Type	Optional	Description
role	Role	No	The role that was created

roleDelete

Emitted whenever a guild role is deleted.

Name	Type	Optional	Description
role	Role	No	The role that was deleted

roleUpdate

Emitted whenever a guild role is updated.

Name	Type	Optional	Description
oldRole	Role	No	The role before the update
newRole	Role	No	The role after the update

stageInstanceCreate

Emitted whenever a stage instance is created.

Name	Type	Optional	Description
stageInstance	StageInstance	No	The created stage instance

stageInstanceDelete

Emitted whenever a stage instance is deleted.

Name	Type	Optional	Description
stageInstance	StageInstance	No	The deleted stage instance

stageInstanceUpdate

Emitted whenever a stage instance gets updated - e.g. change in topic or privacy level

Name	Type	Optional	Description
oldStageInstance	StageInstance \| null	No	The stage instance before the update
newStageInstance	StageInstance	No	The stage instance after the update

stickerCreate

Emitted whenever a custom sticker is created in a guild.

Name	Type	Optional	Description
sticker	Sticker	No	The sticker that was created

stickerDelete

Emitted whenever a custom sticker is deleted in a guild.

Name	Type	Optional	Description
sticker	Sticker	No	The sticker that was deleted

stickerUpdate

Emitted whenever a custom sticker is updated in a guild.

Name	Type	Optional	Description
oldSticker	Sticker	No	The old sticker
newSticker	Sticker	No	The new sticker

threadCreate

Emitted whenever a thread is created or when the client user is added to a thread.

Name	Type	Optional	Description
thread	ThreadChannel	No	The thread that was created
newlyCreated	boolean	No	Whether the thread was newly created

threadDelete

Emitted whenever a thread is deleted.

Name	Type	Optional	Description
thread	ThreadChannel	No	The thread that was deleted

threadListSync

Emitted whenever the client user gains access to a text or announcement channel that contains threads

Name	Type	Optional	Description
threads	Collection<Snowflake, ThreadChannel>	No	The threads that were synced
guild	Guild	No	The guild that the threads were synced in

threadMembersUpdate

Emitted whenever members are added or removed from a thread. This event requires the GatewayIntentBits.GuildMembers privileged gateway intent.

Name	Type	Optional	Description
addedMembers	Collection<Snowflake, ThreadMember>	No	The members that were added
removedMembers	Collection<Snowflake, ThreadMember>	No	The members that were removed
thread	ThreadChannel	No	The thread where members got updated

threadMemberUpdate

Emitted whenever the client user's thread member is updated.

Name	Type	Optional	Description
oldMember	ThreadMember	No	The member before the update
newMember	ThreadMember	No	The member after the update

threadUpdate

Emitted whenever a thread is updated - e.g. name change, archive state change, locked state change.

Name	Type	Optional	Description
oldThread	ThreadChannel	No	The thread before the update
newThread	ThreadChannel	No	The thread after the update

typingStart

Emitted whenever a user starts typing in a channel.

Name	Type	Optional	Description
typing	Typing	No	The typing state

userUpdate

Emitted whenever a user's details (e.g. username) are changed. Triggered by the Discord gateway events UserUpdate, GuildMemberUpdate, and PresenceUpdate.

Name	Type	Optional	Description
oldUser	User	No	The user before the update
newUser	User	No	The user after the update

voiceChannelEffectSend

Emmited when someone sends an effect, such as an emoji reaction, in a voice channel the client is connected to.

Name	Type	Optional	Description
voiceChannelEffect	VoiceChannelEffect	No	The sent voice channel effect

voiceStateUpdate

Emitted whenever a member changes voice state - e.g. joins/leaves a channel, mutes/unmutes.

Name	Type	Optional	Description
oldState	VoiceState	No	The voice state before the update
newState	VoiceState	No	The voice state after the update

warn

Emitted for general warnings.

Name	Type	Optional	Description
info	string	No	The warning

webhooksUpdate

Emitted whenever a channel has its webhooks changed.

Name	Type	Optional	Description
channel	TextChannel \| AnnouncementChannel \| VoiceChannel \| StageChannel \| ForumChannel \| MediaChannel	No	The channel that had a webhook update

application:If<Ready, ClientApplication>

The application of this bot

channels:ChannelManager

All of the BaseChannels that the client is currently handling - as long as sharding isn't being used, this will be *every * channel in *every * guild the bot is a member of. Note that DM channels will not be initially cached, and thus not be present in the Manager without their explicit fetching or use.

Readonly

emojis:BaseGuildEmojiManager

A manager of all the custom emojis that the client has access to

guilds:GuildManager

A manager of all the guilds the client is currently handling - as long as sharding isn't being used, this will be *every * guild the bot is a member of

lastPingTimestamp:number

lastPingTimestamps:Collection<number, number>

The last time a ping was sent (a timestamp) for each WebSocketShard connection

options:Omit<ClientOptions, 'intents'> & { intents: IntentsBitField }

The options the client was instantiated with

Readonly

ping:number | null

The average ping of all WebSocketShards

pings:Collection<number, number>

The latencies of the WebSocketShard connections

Readonly

readyAt:If<Ready, Date>

Time at which the client was last regarded as being in the Ready state (each time the client disconnects and successfully reconnects, this will be overwritten)

readyTimestamp:If<Ready, number>

Timestamp of the time the client was last Ready at

rest:REST

The REST manager of the client

Inherited from BaseClient

shard:ShardClientUtil | null

Shard helpers for the client (only if the process was spawned from a ShardingManager)

status:Status

The current status of this Client

sweepers:Sweepers

The sweeping functions and their intervals used to periodically sweep caches

token:If<Ready, string, string | null>

Authorization token for the logged in bot. If present, this defaults to process.env.DISCORD_TOKEN when instantiating the client This should be kept private at all times.

Readonly

uptime:If<Ready, number>

How long it has been since the client last entered the Ready state in milliseconds

user:If<Ready, ClientUser>

User that the client is logged in as

users:UserManager

The user manager of this client

voice:ClientVoiceManager

The voice manager of the client

ws:WebSocketManager

The WebSocket manager of the client

[Symbol.asyncDispose]():Promise<void>

deleteWebhook(id, options?):Promise<void>

Deletes a webhook.

Name	Type	Optional	Description
id	Snowflake	No	The webhook's id
options	WebhookDeleteOptions	Yes	Options for deleting the webhook

destroy():Promise<void>

Logs out, terminates the connection to Discord, and destroys the client.

emit(event, ...args):boolean

Name	Constraints	Optional	Default	Description
Event	keyof ClientEvents	No		None

Name	Type	Optional	Description
event	Event	No	None
...args	ClientEvents[Event]	No	None

fetchGuildPreview(guild):Promise<GuildPreview>

Obtains a guild preview from Discord, available for all guilds the bot is in and all Discoverable guilds.

Name	Type	Optional	Description
guild	GuildResolvable	No	The guild to fetch the preview for

fetchGuildTemplate(template):Promise<GuildTemplate>

Obtains a template from Discord.

Example

client.fetchGuildTemplate('https://discord.new/FKvmczH2HyUf')
  .then(template => console.log(`Obtained template with code: ${template.code}`))
  .catch(console.error);

client.fetchGuildTemplate('https://discord.new/FKvmczH2HyUf')
  .then(template => console.log(`Obtained template with code: ${template.code}`))
  .catch(console.error);

Name	Type	Optional	Description
template	GuildTemplateResolvable	No	Template code or URL

fetchGuildWidget(guild):Promise<Widget>

Obtains the widget data of a guild from Discord, available for guilds with the widget enabled.

Name	Type	Optional	Description
guild	GuildResolvable	No	The guild to fetch the widget data for

fetchInvite(invite, options?):Promise<Invite>

Obtains an invite from Discord.

Example

client.fetchInvite('https://discord.gg/djs')
  .then(invite => console.log(`Obtained invite with code: ${invite.code}`))
  .catch(console.error);

client.fetchInvite('https://discord.gg/djs')
  .then(invite => console.log(`Obtained invite with code: ${invite.code}`))
  .catch(console.error);

Name	Type	Optional	Description
invite	InviteResolvable	No	Invite code or URL
options	ClientFetchInviteOptions	Yes	Options for fetching the invite

fetchSticker(id):Promise<Sticker>

Obtains a sticker from Discord.

Example

client.fetchSticker('id')
  .then(sticker => console.log(`Obtained sticker with name: ${sticker.name}`))
  .catch(console.error);

client.fetchSticker('id')
  .then(sticker => console.log(`Obtained sticker with name: ${sticker.name}`))
  .catch(console.error);

Name	Type	Optional	Description
id	Snowflake	No	The sticker's id

fetchStickerPacks(options):Promise<StickerPack>

Obtains the list of available sticker packs.

Returns

A collection of sticker packs, or a single sticker pack if a packId was provided

Example

client.fetchStickerPacks()
  .then(packs => console.log(`Available sticker packs are: ${packs.map(pack => pack.name).join(', ')}`))
  .catch(console.error);

client.fetchStickerPacks()
  .then(packs => console.log(`Available sticker packs are: ${packs.map(pack => pack.name).join(', ')}`))
  .catch(console.error);

Example

client.fetchStickerPacks({ packId: '751604115435421716' })
  .then(pack => console.log(`Sticker pack name: ${pack.name}`))
  .catch(console.error);

client.fetchStickerPacks({ packId: '751604115435421716' })
  .then(pack => console.log(`Sticker pack name: ${pack.name}`))
  .catch(console.error);

Name	Type	Optional	Description
options	{ packId: Snowflake }	No	Options for fetching sticker packs

fetchVoiceRegions():Promise<Collection<string, VoiceRegion>>

Obtains the available voice regions from Discord.

Example

client.fetchVoiceRegions()
  .then(regions => console.log(`Available regions are: ${regions.map(region => region.name).join(', ')}`))
  .catch(console.error);

client.fetchVoiceRegions()
  .then(regions => console.log(`Available regions are: ${regions.map(region => region.name).join(', ')}`))
  .catch(console.error);

fetchWebhook(id, token?):Promise<Webhook>

Obtains a webhook from Discord.

Example

client.fetchWebhook('id', 'token')
  .then(webhook => console.log(`Obtained webhook with name: ${webhook.name}`))
  .catch(console.error);

client.fetchWebhook('id', 'token')
  .then(webhook => console.log(`Obtained webhook with name: ${webhook.name}`))
  .catch(console.error);

Name	Type	Optional	Description
id	Snowflake	No	The webhook's id
token	string	Yes	Token for the webhook

generateInvite(options?):string

Generates a link that can be used to invite the bot to a guild.

Example

const link = client.generateInvite({
  scopes: [OAuth2Scopes.ApplicationsCommands],
});
console.log(`Generated application invite link: ${link}`);

const link = client.generateInvite({
  scopes: [OAuth2Scopes.ApplicationsCommands],
});
console.log(`Generated application invite link: ${link}`);

Example

const link = client.generateInvite({
  permissions: [
    PermissionFlagsBits.SendMessages,
    PermissionFlagsBits.ManageGuild,
    PermissionFlagsBits.MentionEveryone,
  ],
  scopes: [OAuth2Scopes.Bot],
});
console.log(`Generated bot invite link: ${link}`);

const link = client.generateInvite({
  permissions: [
    PermissionFlagsBits.SendMessages,
    PermissionFlagsBits.ManageGuild,
    PermissionFlagsBits.MentionEveryone,
  ],
  scopes: [OAuth2Scopes.Bot],
});
console.log(`Generated bot invite link: ${link}`);

Name	Type	Optional	Description
options	InviteGenerationOptions	Yes	Options for the invite

isReady():this is Client<true>

Returns whether the client has logged in, indicative of being able to access properties such as user and application.

Logs the client in, establishing a WebSocket connection to Discord.

Returns

Token of the account used

Example

client.login('my token');

client.login('my token');

Name	Type	Optional	Description
token	string	Yes	Token of the account to log in with

off(event, listener):this

Name	Constraints	Optional	Default	Description
Event	keyof ClientEvents	No		None

Name	Type	Optional	Description
event	Event	No	None
listener	(...args: ClientEvents[Event]) => void	No	None

on(event, listener):this

Name	Constraints	Optional	Default	Description
Event	keyof ClientEvents	No		None

Name	Type	Optional	Description
event	Event	No	None
listener	(...args: ClientEvents[Event]) => void	No	None

once(event, listener):this

Name	Constraints	Optional	Default	Description
Event	keyof ClientEvents	No		None

Name	Type	Optional	Description
event	Event	No	None
listener	(...args: ClientEvents[Event]) => void	No	None

removeAllListeners(event?):this

Name	Constraints	Optional	Default	Description
Event	keyof ClientEvents	No		None

Name	Type	Optional	Description
event	Event	Yes	None

toJSON():unknown