API reference

This catalog is generated from the JSDoc in src/ by @discordjs/docgen. It contains every documented class, function, interface, typedef, and external in the current source tree.

Generated documentation

Run npm run docs after changing public JSDoc, then commit the resulting docs/main.json. The VitePress API routes are produced from that file at build time—there are no generated Markdown pages to maintain.

Browse symbols

Showing 660 of 660 documented symbols.

AcceptInviteOptionstypedefsOptions for Client#acceptInvite.ActivitiesOptionstypedefsOptions for setting activitiesActivityclassesRepresents an activity that is part of a user's presence.ActivityFlagsclassesData structure that makes it easy to interact with an Activity#flags bitfield.ActivityOptionstypedefsOptions for setting an activity.ActivityPartytypedefsRepresents a party of an activityActivityPlatformtypedefsThe platform of this activity: * **`desktop`** * **`samsung`** - playing on Samsung Galaxy * **`xbox`** - playing on Xbox Live * **`ios`** * **`android`** * **`embedded`** * **`ps4`** * **`ps5`**ActivityTimestampstypedefsRepresents timestamps of an activityActivityTypetypedefsBots cannot set a `CUSTOM` activity type, it is only for custom statuses received from users The type of an activity of a user's presence. Here are the available types: * PLAYING * STREAMING * LISTENING * WATCHING * CUSTOM * COMPETING * HANGAddApplicationCommandPermissionsOptionstypedefsOptions used to add permissions to a command The `command` parameter is not optional when the managers `commandId` is `null`AddGuildMemberOptionstypedefsOptions used to add a user to a guild using OAuth2.AgentOptionstypedefsHTTPS Agent options.AnonymousGuildclassesBundles common attributes and methods between Guild and InviteGuildAPIApplicationCommandexternalsAPIApplicationCommandOptionexternalsAPIApplicationCommandPermissionsexternalsAPIAttachmentexternalsAPIChannelexternalsAPIEmbedexternalsAPIEmojiexternalsAPIErrorexternalsAPIErrortypedefsAn error encountered while performing an API request. Here are the potential errors: * UNKNOWN_ACCOUNT * UNKNOWN_APPLICATION * UNKNOWN_CHANNEL * UNKNOWN_GUILD * UNKNOWN_INTEGRATION * UNKNOWN_INVITE * UNKNOWN_MEMBER * UNKNOWN_MESSAGE * UNKNOWN_OVERWRITE * UNKNOWN_PROVIDER * UNKNOWN_ROLE * UNKNOWN_TOKEN * UNKNOWN_USER * UNKNOWN_EMOJI * UNKNOWN_WEBHOOK * UNKNOWN_WEBHOOK_SERVICE * UNKNOWN_SESSION * UNKNOWN_BAN * UNKNOWN_SKU * UNKNOWN_STORE_LISTING * UNKNOWN_ENTITLEMENT * UNKNOWN_BUILD * UNKNOWN_LOBBY * UNKNOWN_BRANCH * UNKNOWN_STORE_DIRECTORY_LAYOUT * UNKNOWN_REDISTRIBUTABLE * UNKNOWN_GIFT_CODE * UNKNOWN_STREAM * UNKNOWN_PREMIUM_SERVER_SUBSCRIBE_COOLDOWN * UNKNOWN_GUILD_TEMPLATE * UNKNOWN_DISCOVERABLE_SERVER_CATEGORY * UNKNOWN_STICKER * UNKNOWN_INTERACTION * UNKNOWN_APPLICATION_COMMAND * UNKNOWN_APPLICATION_COMMAND_PERMISSIONS * UNKNOWN_STAGE_INSTANCE * UNKNOWN_GUILD_MEMBER_VERIFICATION_FORM * UNKNOWN_GUILD_WELCOME_SCREEN * UNKNOWN_GUILD_SCHEDULED_EVENT * UNKNOWN_GUILD_SCHEDULED_EVENT_USER * BOT_PROHIBITED_ENDPOINT * BOT_ONLY_ENDPOINT * CANNOT_SEND_EXPLICIT_CONTENT * NOT_AUTHORIZED * SLOWMODE_RATE_LIMIT * ACCOUNT_OWNER_ONLY * ANNOUNCEMENT_EDIT_LIMIT_EXCEEDED * CHANNEL_HIT_WRITE_RATELIMIT * SERVER_HIT_WRITE_RATELIMIT * CONTENT_NOT_ALLOWED * GUILD_PREMIUM_LEVEL_TOO_LOW * MAXIMUM_GUILDS * MAXIMUM_FRIENDS * MAXIMUM_PINS * MAXIMUM_RECIPIENTS * MAXIMUM_ROLES * MAXIMUM_WEBHOOKS * MAXIMUM_EMOJIS * MAXIMUM_REACTIONS * MAXIMUM_CHANNELS * MAXIMUM_ATTACHMENTS * MAXIMUM_INVITES * MAXIMUM_ANIMATED_EMOJIS * MAXIMUM_SERVER_MEMBERS * MAXIMUM_NUMBER_OF_SERVER_CATEGORIES * GUILD_ALREADY_HAS_TEMPLATE * MAXIMUM_THREAD_PARTICIPANTS * MAXIMUM_NON_GUILD_MEMBERS_BANS * MAXIMUM_BAN_FETCHES * MAXIMUM_NUMBER_OF_UNCOMPLETED_GUILD_SCHEDULED_EVENTS_REACHED * MAXIMUM_NUMBER_OF_STICKERS_REACHED * MAXIMUM_PRUNE_REQUESTS * MAXIMUM_GUILD_WIDGET_SETTINGS_UPDATE * UNAUTHORIZED * ACCOUNT_VERIFICATION_REQUIRED * DIRECT_MESSAGES_TOO_FAST * REQUEST_ENTITY_TOO_LARGE * FEATURE_TEMPORARILY_DISABLED * USER_BANNED * TARGET_USER_NOT_CONNECTED_TO_VOICE * ALREADY_CROSSPOSTED * MISSING_ACCESS * INVALID_ACCOUNT_TYPE * CANNOT_EXECUTE_ON_DM * EMBED_DISABLED * CANNOT_EDIT_MESSAGE_BY_OTHER * CANNOT_SEND_EMPTY_MESSAGE * CANNOT_MESSAGE_USER * CANNOT_SEND_MESSAGES_IN_VOICE_CHANNEL * CHANNEL_VERIFICATION_LEVEL_TOO_HIGH * OAUTH2_APPLICATION_BOT_ABSENT * MAXIMUM_OAUTH2_APPLICATIONS * INVALID_OAUTH_STATE * MISSING_PERMISSIONS * INVALID_AUTHENTICATION_TOKEN * NOTE_TOO_LONG * INVALID_BULK_DELETE_QUANTITY * CANNOT_PIN_MESSAGE_IN_OTHER_CHANNEL * INVALID_OR_TAKEN_INVITE_CODE * CANNOT_EXECUTE_ON_SYSTEM_MESSAGE * CANNOT_EXECUTE_ON_CHANNEL_TYPE * INVALID_OAUTH_TOKEN * MISSING_OAUTH_SCOPE * INVALID_WEBHOOK_TOKEN * INVALID_ROLE * INVALID_RECIPIENTS * BULK_DELETE_MESSAGE_TOO_OLD * INVALID_FORM_BODY * INVITE_ACCEPTED_TO_GUILD_NOT_CONTAINING_BOT * INVALID_API_VERSION * FILE_UPLOADED_EXCEEDS_MAXIMUM_SIZE * INVALID_FILE_UPLOADED * CANNOT_SELF_REDEEM_GIFT * INVALID_GUILD * INVALID_MESSAGE_TYPE * PAYMENT_SOURCE_REQUIRED * CANNOT_DELETE_COMMUNITY_REQUIRED_CHANNEL * INVALID_STICKER_SENT * INVALID_OPERATION_ON_ARCHIVED_THREAD * INVALID_THREAD_NOTIFICATION_SETTINGS * PARAMETER_EARLIER_THAN_CREATION * GUILD_NOT_AVAILABLE_IN_LOCATION * GUILD_MONETIZATION_REQUIRED * INSUFFICIENT_BOOSTS * INVALID_JSON * TWO_FACTOR_REQUIRED * NO_USERS_WITH_DISCORDTAG_EXIST * REACTION_BLOCKED * RESOURCE_OVERLOADED * STAGE_ALREADY_OPEN * CANNOT_REPLY_WITHOUT_READ_MESSAGE_HISTORY_PERMISSION * MESSAGE_ALREADY_HAS_THREAD * THREAD_LOCKED * MAXIMUM_ACTIVE_THREADS * MAXIMUM_ACTIVE_ANNOUNCEMENT_THREADS * INVALID_JSON_FOR_UPLOADED_LOTTIE_FILE * UPLOADED_LOTTIES_CANNOT_CONTAIN_RASTERIZED_IMAGES * STICKER_MAXIMUM_FRAMERATE_EXCEEDED * STICKER_FRAME_COUNT_EXCEEDS_MAXIMUM_OF_1000_FRAMES * LOTTIE_ANIMATION_MAXIMUM_DIMENSIONS_EXCEEDED * STICKER_FRAME_RATE_IS_TOO_SMALL_OR_TOO_LARGE * STICKER_ANIMATION_DURATION_EXCEEDS_MAXIMUM_OF_5_SECONDS * CANNOT_UPDATE_A_FINISHED_EVENT * FAILED_TO_CREATE_STAGE_NEEDED_FOR_STAGE_EVENTAPIGuildexternalsAPIGuildMemberexternalsAPIGuildScheduledEventRecurrenceRuleexternalsAPIIncidentsDataexternalsAPIInteractionDataResolvedexternalsAPIMessageexternalsAPIMessageActionRowComponenttypedefsRaw message components from the API * APIMessageButton * APIMessageSelectMenuAPIMessageButtonexternalsAPIMessageComponentexternalsAPIMessageSelectMenuexternalsAPIPresenceexternalsAPIRequesttypedefsRepresents a request that will or has been made to the Discord APIAPIRoleexternalsAPIStickerexternalsAPIUserexternalsApplicationclassesRepresents an OAuth2 Application.ApplicationAssettypedefsAsset data.ApplicationCommandclassesRepresents an application command.ApplicationCommandDatatypedefsData for creating or editing an application command.ApplicationCommandDataResolvabletypedefsData that resolves to the data of an ApplicationCommandApplicationCommandManagerclassesManages API methods for application commands and stores their cache.ApplicationCommandOptiontypedefsAn option for an application command or subcommand.ApplicationCommandOptionChoicetypedefsA choice for an application command option.ApplicationCommandOptionChoiceDatatypedefsApplicationCommandOptionDatatypedefsAn option for an application command or subcommand. In addition to the listed properties, when used as a parameter, API style `snake_case` properties can be used for compatibility with generators like `@discordjs/builders`. Note that providing a value for the `camelCase` counterpart for any `snake_case` property will discard the provided `snake_case` property.ApplicationCommandOptionTypetypedefsThe type of an ApplicationCommandOption object: * SUB_COMMAND * SUB_COMMAND_GROUP * STRING * INTEGER * BOOLEAN * USER * CHANNEL * ROLE * MENTIONABLE * NUMBER * ATTACHMENTApplicationCommandPermissionDatatypedefsData for setting the permissions of an application command.ApplicationCommandPermissionstypedefsThe object returned when fetching permissions for an application command.ApplicationCommandPermissionsManagerclassesManages API methods for permissions of Application Commands.ApplicationCommandPermissionsUpdateDatatypedefsThe data received in the Client#event:applicationCommandPermissionsUpdate eventApplicationCommandPermissionTypetypedefsThe type of an ApplicationCommandPermissions object: * ROLE * USERApplicationCommandResolvabletypedefsData that resolves to give an ApplicationCommand object. This can be: * An ApplicationCommand object * A SnowflakeApplicationCommandTypetypedefsThe type of an ApplicationCommand object: * CHAT_INPUT * USER * MESSAGEApplicationExecutabletypedefsApplicationFlagsclassesData structure that makes it easy to interact with a Application#flags bitfield.ApplicationResolvabletypedefsData that can be resolved to an Application. This can be: * An Application * An Activity with associated Application * A SnowflakeApplicationRoleConnectionMetadataclassesRole connection metadata object for an application.ApplicationRoleConnectionMetadataTypetypedefsEach metadata type offers a comparison operation that allows guilds to configure role requirements based on metadata values stored by the bot. Bots specify a metadata value for each user and guilds specify the required guild's configured value within the guild role settings. All available channel types: * INTEGER_LESS_THAN_OR_EQUAL * INTEGER_GREATER_THAN_OR_EQUAL * INTEGER_EQUAL * INTEGER_NOT_EQUAL * DATATIME_LESS_THAN_OR_EQUAL * DATATIME_GREATER_THAN_OR_EQUAL * BOOLEAN_EQUAL * BOOLEAN_NOT_EQUALApplicationSkutypedefsAttachmentFlagsclassesData structure that makes it easy to interact with an GuildMember#flags bitfield.AttachmentFlagsResolvabletypedefsData that can be resolved to give a guild attachment bitfield. This can be: * A string (see AttachmentFlags.FLAGS) * A attachment flag * An instance of AttachmentFlags * An Array of AttachmentFlagsResolvableAudioDispatcherclassesThe class that sends voice packet data to the voice connection. ```js // Obtained using: client.voice.joinChannel(channel).then(connection => { // You can play a file or a stream here: const dispatcher = connection.playAudio('/home/hydrabolt/audio.mp3'); }); ```AuditLogActiontypedefsThe action of an entry. Here are the available actions: * ALL: null * GUILD_UPDATE: 1 * CHANNEL_CREATE: 10 * CHANNEL_UPDATE: 11 * CHANNEL_DELETE: 12 * CHANNEL_OVERWRITE_CREATE: 13 * CHANNEL_OVERWRITE_UPDATE: 14 * CHANNEL_OVERWRITE_DELETE: 15 * MEMBER_KICK: 20 * MEMBER_PRUNE: 21 * MEMBER_BAN_ADD: 22 * MEMBER_BAN_REMOVE: 23 * MEMBER_UPDATE: 24 * MEMBER_ROLE_UPDATE: 25 * MEMBER_MOVE: 26 * MEMBER_DISCONNECT: 27 * BOT_ADD: 28, * ROLE_CREATE: 30 * ROLE_UPDATE: 31 * ROLE_DELETE: 32 * INVITE_CREATE: 40 * INVITE_UPDATE: 41 * INVITE_DELETE: 42 * WEBHOOK_CREATE: 50 * WEBHOOK_UPDATE: 51 * WEBHOOK_DELETE: 52 * EMOJI_CREATE: 60 * EMOJI_UPDATE: 61 * EMOJI_DELETE: 62 * MESSAGE_DELETE: 72 * MESSAGE_BULK_DELETE: 73 * MESSAGE_PIN: 74 * MESSAGE_UNPIN: 75 * INTEGRATION_CREATE: 80 * INTEGRATION_UPDATE: 81 * INTEGRATION_DELETE: 82 * STAGE_INSTANCE_CREATE: 83 * STAGE_INSTANCE_UPDATE: 84 * STAGE_INSTANCE_DELETE: 85 * STICKER_CREATE: 90 * STICKER_UPDATE: 91 * STICKER_DELETE: 92 * GUILD_SCHEDULED_EVENT_CREATE: 100 * GUILD_SCHEDULED_EVENT_UPDATE: 101 * GUILD_SCHEDULED_EVENT_DELETE: 102 * THREAD_CREATE: 110 * THREAD_UPDATE: 111 * THREAD_DELETE: 112 * APPLICATION_COMMAND_PERMISSION_UPDATE: 121 * AUTO_MODERATION_RULE_CREATE: 140 * AUTO_MODERATION_RULE_UPDATE: 141 * AUTO_MODERATION_RULE_DELETE: 142 * AUTO_MODERATION_BLOCK_MESSAGE: 143 * AUTO_MODERATION_FLAG_TO_CHANNEL: 144 * AUTO_MODERATION_USER_COMMUNICATION_DISABLED: 145AuditLogActionTypetypedefsThe action type of an entry, e.g. `CREATE`. Here are the available types: * CREATE * DELETE * UPDATE * ALLAuditLogChangetypedefsAn entry in the audit log representing a specific change.AuditLogEntryTargettypedefsThe target of an entry. It can be one of: * A guild * A channel * A user * A role * An invite * A webhook * An emoji * A message * An integration * A stage instance * A sticker * A guild scheduled event * A thread * An application command * An auto moderation rule * An object with an id key if target was deleted * An object where the keys represent either the new value or the old valueAuditLogTargetTypetypedefsThe target type of an entry. Here are the available types: * GUILD * CHANNEL * USER * ROLE * INVITE * WEBHOOK * EMOJI * MESSAGE * INTEGRATION * STAGE_INSTANCE * STICKER * THREAD * GUILD_SCHEDULED_EVENT * APPLICATION_COMMAND * AUTO_MODERATIONAuthorizedApplicationDatatypedefsAutocompleteFocusedOptiontypedefsThe full autocomplete option object.AutocompleteInteractionclassesRepresents an autocomplete interaction.AutoModerationActiontypedefsAn object containing information about an auto moderation rule action.AutoModerationActionExecutionclassesRepresents the structure of an executed action when an AutoModerationRule is triggered.AutoModerationActionMetadatatypedefsAdditional data used when an auto moderation rule is executed.AutoModerationActionMetadataOptionstypedefsOptions used to set the metadata of an auto moderation rule action.AutoModerationActionOptionstypedefsOptions used to set the actions of an auto moderation rule.AutoModerationActionTypetypedefsThe type of an AutoModerationActionTypes object: * BLOCK_MESSAGE * SEND_ALERT_MESSAGE * TIMEOUTAutoModerationRuleclassesRepresents an auto moderation rule.AutoModerationRuleCreateOptionstypedefsOptions used to create an auto moderation rule.AutoModerationRuleEditOptionstypedefsOptions used to edit an auto moderation rule.AutoModerationRuleEventTypetypedefsThe type of an AutoModerationRuleEventTypes object: * MESSAGE_SENDAutoModerationRuleKeywordPresetTypetypedefsThe type of an AutoModerationRuleKeywordPresetTypes object: * KEYWORD * SPAM * KEYWORD_PRESET * MENTION_SPAMAutoModerationRuleManagerclassesManages API methods for auto moderation rules and stores their cache.AutoModerationRuleResolvabletypedefsData that can be resolved to give an AutoModerationRule object. This can be: * An AutoModerationRule * A SnowflakeAutoModerationRuleTriggerTypetypedefsThe type of an AutoModerationRuleTriggerTypes object: * KEYWORD * SPAM * KEYWORD_PRESET * MENTION_SPAMAutoModerationTriggerMetadatatypedefsAdditional data used to determine whether an auto moderation rule should be triggered.AutoModerationTriggerMetadataOptionstypedefsOptions used to set the trigger metadata of an auto moderation rule.AvatarDecorationDatatypedefsAwaitMessagesOptionstypedefsAn object containing the same properties as CollectorOptions, but a few more:AwaitModalSubmitOptionstypedefsAn object containing the same properties as CollectorOptions, but a few more:AwaitReactionsOptionstypedefsAn object containing the same properties as CollectorOptions, but a few more:BanOptionstypedefsOptions used to ban a user from a guild.BaseclassesRepresents a data model that is identifiable by a Snowflake (i.e. Discord API data models).Base64ResolvabletypedefsData that resolves to give a Base64 string, typically for image uploading. This can be: * A Buffer * A base64 stringBaseApplicationCommandPermissionsOptionstypedefsOptions for managing permissions for one or more Application Commands When passing these options to a manager where `guildId` is `null`, `guild` is a required parameterBaseClientclassesThe base class for all clients.BaseCommandInteractionclassesRepresents a command interaction.BaseDispatcherclassesBaseFetchOptionstypedefsOptions used to fetch data from DiscordBaseGuildclassesThe base class for Guild, OAuth2Guild and InviteGuild.BaseGuildEmojiclassesParent class for GuildEmoji and GuildPreviewEmoji.BaseGuildEmojiManagerclassesHolds methods to resolve GuildEmojis and stores their cache.BaseGuildTextChannelclassesRepresents a text-based guild channel on Discord.BaseGuildVoiceChannelclassesRepresents a voice-based guild channel on Discord.BaseManagerclassesManages the API methods of a data model.BaseMessageComponentclassesRepresents an interactive component of a Message or Modal. It should not be necessary to construct this directly. See MessageComponentBaseMessageComponentOptionstypedefsOptions for a BaseMessageComponentBaseMessageOptionstypedefsBase options provided when sending.BaseMessageOptionsWithPolltypedefsThe base message options for messages including a poll.BillingManagerclassesManages the API methods of a data model.BitFieldclassesData structure that makes it easy to interact with a bitfield.BitFieldResolvabletypedefsData that can be resolved to give a bitfield. This can be: * A bit number (this can be a number literal or a value taken from BitField.FLAGS) * A string bit number * An instance of BitField * An Array of BitFieldResolvableBroadcastEvalOptionstypedefsOptions for ShardingManager#broadcastEval and ShardClientUtil#broadcastEval.BufferResolvabletypedefsData that can be resolved to give a Buffer. This can be: * A Buffer * The path to a local file * A URL When provided a URL, discord.js will fetch the URL internally in order to create a Buffer. This can pose a security risk when the URL has not been sanitizedBulkBanOptionstypedefsOptions used for bulk banning users from a guild.BulkBanResulttypedefsResult of bulk banning users from a guild.ButtonInteractionclassesRepresents a button interaction.CachedManagerclassesManages the API methods of a data model with a mutable cache of instances.CacheFactorytypedefsCallStateclassesRepresents a callCaptchatypedefsCaptchaSolvertypedefsCategoryChannelclassesRepresents a guild category channel on Discord.CategoryChannelResolvabletypedefsData that can be resolved to give a Category Channel object. This can be: * A CategoryChannel object * A SnowflakeCategoryCreateChannelOptionstypedefsOptions for creating a channel using CategoryChannel#createChannel.ChannelclassesRepresents any channel on Discord.ChannelDatatypedefsThe data for a guild channel.ChannelFlagsclassesData structure that makes it easy to interact with a Channel#flags bitfield.ChannelFlagsResolvabletypedefsData that can be resolved to give a channel flag bitfield. This can be: * A string (see ChannelFlags.FLAGS) * A channel flag * An instance of ChannelFlags * An Array of ChannelFlagsChannelLogsQueryOptionstypedefsThe parameters to pass in when requesting previous messages from a channel. `around`, `before` and `after` are mutually exclusive. All the parameters are optional.ChannelManagerclassesA manager of channels belonging to a clientChannelPositiontypedefsThe data needed for updating a channel's position.ChannelResolvabletypedefsData that can be resolved to give a Channel object. This can be: * A Channel object * A SnowflakeChannelTypetypedefsAll available channel types: * `GUILD_TEXT` - a guild text channel * `DM` - a DM channel * `GUILD_VOICE` - a guild voice channel * `GROUP_DM` - a group DM channel * `GUILD_CATEGORY` - a guild category channel * `GUILD_NEWS` - a guild news channel * `GUILD_STORE` - a guild store channel Store channels are deprecated and will be removed from Discord in March 2022. See [Self-serve Game Selling Deprecation](https://support-dev.discord.com/hc/en-us/articles/6309018858647) for more information. * `GUILD_NEWS_THREAD` - a guild news channel's public thread channel * `GUILD_PUBLIC_THREAD` - a guild text channel's public thread channel * `GUILD_PRIVATE_THREAD` - a guild text channel's private thread channel * `GUILD_STAGE_VOICE` - a guild stage voice channel * `GUILD_DIRECTORY` - the channel in a hub containing guilds * `GUILD_FORUM` - a channel that can only contain threads * `GUILD_MEDIA` - a channel that can only contain threads, similar to `GUILD_FORUM` channels * `UNKNOWN` - a generic channel of unknown type, could be Channel or GuildChannelChannelWebhookCreateOptionstypedefsOptions used to create a Webhook in a guild text-based channel.CipherstypedefsChrome TLS ciphersClientclassesThe main hub for user-account Discord workflows.ClientApplicationAssetTypestypedefsThe types of assets of an application: * SMALL: 1 * BIG: 2ClientFetchInviteOptionstypedefsOptions used when fetching an invite from Discord.ClientOptionstypedefsOptions for a client.ClientPresenceclassesRepresents the client's presence.ClientPresenceStatustypedefsThe status of this presence: * **`online`** - user is online * **`idle`** - user is AFK * **`dnd`** - user is in Do Not DisturbClientUserclassesRepresents the logged in client's Discord user.ClientUserEditDatatypedefsData used to edit the logged in clientClientUserSettingManagerclassesManages API methods for users and stores their cache.ClientVoiceManagerclassesManages voice connections for the client Feat: Support both lib & djs/voiceCloseEventexternalsCollectiblestypedefsCollectionexternalsCollectorclassesAbstract class for defining a new Collector.CollectorFiltertypedefsFilter to be applied to the collector.CollectorOptionstypedefsOptions to be applied to the collector.CollectorResetTimerOptionstypedefsOptions used to reset the timeout and idle timer of a Collector.ColortypedefsA commonly used color: * DEFAULT * WHITE * AQUA * GREEN * BLUE * YELLOW * PURPLE * LUMINOUS_VIVID_PINK * FUCHSIA * GOLD * ORANGE * RED * GREY * NAVY * DARK_AQUA * DARK_GREEN * DARK_BLUE * DARK_PURPLE * DARK_VIVID_PINK * DARK_GOLD * DARK_ORANGE * DARK_RED * DARK_GREY * DARKER_GREY * LIGHT_GREY * DARK_NAVY * BLURPLE * GREYPLE * DARK_BUT_NOT_BLACK * NOT_QUITE_BLACKColorResolvabletypedefsCan be a number, hex string, a Color, or an RGB array like: ```js [255, 0, 255] // purple ```CommandInteractionclassesRepresents a command interaction.CommandInteractionOptiontypedefsRepresents an option of a received command interaction.CommandInteractionOptionResolverclassesA resolver for command interaction options.CommandInteractionResolvedDatatypedefsRepresents the resolved data of a received command interaction.CompanytypedefsConstantstypedefsConstants that can be used in an enum or object-like way.ContainerComponentclassesContainerComponentstypedefsContextMenuCommandBuilderexternalsContextMenuInteractionclassesRepresents a context menu interaction.CreateGuildScheduledEventInviteURLOptionstypedefsOptions used to create an invite URL to a GuildScheduledEventCreateInviteOptionstypedefsOptions used to create an invite to a guild channel.CreateRoleOptionstypedefsOptions used to create a new role.CrosspostedChanneltypedefsCrossposted channel data.CustomStatusclassesCustomStatusOptiontypedefsCustomStatus ObjectCustomStatusOptionstypedefsDataManagerclassesManages the API methods of a data model along with a collection of instances.DataResolverclassesThe DataResolver identifies different objects and tries to resolve a specific piece of information from them.DateResolvabletypedefsData that can be resolved to a Date object. This can be: * A Date object * A number representing a timestamp * An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) stringDeconstructedSnowflaketypedefsA deconstructed snowflake.DefaultMessageNotificationLeveltypedefsThe value set for a guild's default message notifications, e.g. `ALL_MESSAGES`. Here are the available types: * ALL_MESSAGES * ONLY_MENTIONSDefaultReactionEmojitypedefsDirectoryChannelclassesRepresents a channel that displays a directory of guilds.DiscordAPIErrorclassesRepresents an error from the Discord API.DiscordAuthWebsocketclassesDiscord Auth QRDMChannelclassesRepresents a direct message channel between two users.EditGuildTemplateOptionstypedefsOptions used to edit a guild template.EmbedAuthorDatatypedefsThe options to provide for setting an author for a WebEmbed.EmbedFieldtypedefsRepresents a field of a MessageEmbedEmbedFieldDatatypedefsEmbedFooterDatatypedefsThe options to provide for setting a footer for a MessageEmbed.EmbedProviderDatatypedefsThe options to provide for setting an provider for a WebEmbed.EmojiclassesRepresents an emoji, see GuildEmoji and ReactionEmoji.EmojiIdentifierResolvabletypedefsData that can be resolved to give an emoji identifier. This can be: * An EmojiResolvable * The `<a:name:id>`, `<:name:id>`, `a:name:id` or `name:id` emoji identifier string of an emoji * The Unicode representation of an emojiEmojiResolvabletypedefsData that can be resolved into a GuildEmoji object. This can be: * A Snowflake * A GuildEmoji object * A ReactionEmoji objectEndpointstypedefsAn object containing functions that return certain endpoints on the API.ErrorEventexternalsEscapeMarkdownOptionstypedefsOptions used to escape markdown.EventstypedefsThe types of events emitted by the Client: * RATE_LIMIT: rateLimit * INVALID_REQUEST_WARNING: invalidRequestWarning * API_RESPONSE: apiResponse * API_REQUEST: apiRequest * CLIENT_READY: ready * APPLICATION_COMMAND_CREATE: applicationCommandCreate (deprecated) * APPLICATION_COMMAND_DELETE: applicationCommandDelete (deprecated) * APPLICATION_COMMAND_UPDATE: applicationCommandUpdate (deprecated) * APPLICATION_COMMAND_PERMISSIONS_UPDATE: applicationCommandPermissionsUpdate * AUTO_MODERATION_ACTION_EXECUTION: autoModerationActionExecution * AUTO_MODERATION_RULE_CREATE: autoModerationRuleCreate * AUTO_MODERATION_RULE_DELETE: autoModerationRuleDelete * AUTO_MODERATION_RULE_UPDATE: autoModerationRuleUpdate * GUILD_AVAILABLE: guildAvailable * GUILD_CREATE: guildCreate * GUILD_DELETE: guildDelete * GUILD_UPDATE: guildUpdate * GUILD_UNAVAILABLE: guildUnavailable * GUILD_MEMBER_ADD: guildMemberAdd * GUILD_MEMBER_REMOVE: guildMemberRemove * GUILD_MEMBER_UPDATE: guildMemberUpdate * GUILD_MEMBER_AVAILABLE: guildMemberAvailable * GUILD_MEMBERS_CHUNK: guildMembersChunk * GUILD_INTEGRATIONS_UPDATE: guildIntegrationsUpdate * GUILD_ROLE_CREATE: roleCreate * GUILD_ROLE_DELETE: roleDelete * INVITE_CREATE: inviteCreate * INVITE_DELETE: inviteDelete * GUILD_ROLE_UPDATE: roleUpdate * GUILD_EMOJI_CREATE: emojiCreate * GUILD_EMOJI_DELETE: emojiDelete * GUILD_EMOJI_UPDATE: emojiUpdate * GUILD_BAN_ADD: guildBanAdd * GUILD_BAN_REMOVE: guildBanRemove * CHANNEL_CREATE: channelCreate * CHANNEL_DELETE: channelDelete * CHANNEL_UPDATE: channelUpdate * CHANNEL_PINS_UPDATE: channelPinsUpdate * MESSAGE_CREATE: messageCreate * MESSAGE_DELETE: messageDelete * MESSAGE_UPDATE: messageUpdate * MESSAGE_BULK_DELETE: messageDeleteBulk * MESSAGE_REACTION_ADD: messageReactionAdd * MESSAGE_REACTION_REMOVE: messageReactionRemove * MESSAGE_REACTION_REMOVE_ALL: messageReactionRemoveAll * MESSAGE_REACTION_REMOVE_EMOJI: messageReactionRemoveEmoji * THREAD_CREATE: threadCreate * THREAD_DELETE: threadDelete * THREAD_UPDATE: threadUpdate * THREAD_LIST_SYNC: threadListSync * THREAD_MEMBER_UPDATE: threadMemberUpdate * THREAD_MEMBERS_UPDATE: threadMembersUpdate * USER_UPDATE: userUpdate * PRESENCE_UPDATE: presenceUpdate * VOICE_SERVER_UPDATE: voiceServerUpdate * VOICE_STATE_UPDATE: voiceStateUpdate * TYPING_START: typingStart * WEBHOOKS_UPDATE: webhookUpdate * ERROR: error * WARN: warn * DEBUG: debug * CACHE_SWEEP: cacheSweep * SHARD_DISCONNECT: shardDisconnect * SHARD_ERROR: shardError * SHARD_RECONNECTING: shardReconnecting * SHARD_READY: shardReady * SHARD_RESUME: shardResume * INVALIDATED: invalidated * RAW: raw * STAGE_INSTANCE_CREATE: stageInstanceCreate * STAGE_INSTANCE_UPDATE: stageInstanceUpdate * STAGE_INSTANCE_DELETE: stageInstanceDelete * GUILD_STICKER_CREATE: stickerCreate * GUILD_STICKER_DELETE: stickerDelete * GUILD_STICKER_UPDATE: stickerUpdate * GUILD_SCHEDULED_EVENT_CREATE: guildScheduledEventCreate * GUILD_SCHEDULED_EVENT_UPDATE: guildScheduledEventUpdate * GUILD_SCHEDULED_EVENT_DELETE: guildScheduledEventDelete * GUILD_SCHEDULED_EVENT_USER_ADD: guildScheduledEventUserAdd * GUILD_SCHEDULED_EVENT_USER_REMOVE: guildScheduledEventUserRemove * GUILD_AUDIT_LOG_ENTRY_CREATE: guildAuditLogEntryCreate * UNHANDLED_PACKET: unhandledPacket * RELATIONSHIP_ADD: relationshipAdd * RELATIONSHIP_REMOVE: relationshipRemove * RELATIONSHIP_UPDATE: relationshipUpdate * CHANNEL_RECIPIENT_ADD: channelRecipientAdd * CHANNEL_RECIPIENT_REMOVE: channelRecipientRemove * INTERACTION_MODAL_CREATE: interactionModalCreate * CALL_CREATE: callCreate * CALL_UPDATE: callUpdate * CALL_DELETE: callDelete * VOICE_CHANNEL_EFFECT_SEND: voiceChannelEffectSendExplicitContentFilterLeveltypedefsThe value set for the explicit content filter levels for a guild: * DISABLED * MEMBERS_WITHOUT_ROLES * ALL_MEMBERSExternalAssetstypedefsFeaturestypedefsAn array of enabled guild features, here are the possible values: * ANIMATED_ICON * AUTO_MODERATION * BANNER * COMMERCE * COMMUNITY * CREATOR_MONETIZABLE_PROVISIONAL * CREATOR_STORE_PAGE * DISCOVERABLE * FEATURABLE * INVITES_DISABLED * INVITE_SPLASH * MEMBER_VERIFICATION_GATE_ENABLED * NEWS * PARTNERED * PREVIEW_ENABLED * VANITY_URL * VERIFIED * VIP_REGIONS * WELCOME_SCREEN_ENABLED * TICKETED_EVENTS_ENABLED * MONETIZATION_ENABLED `MONETIZATION_ENABLED` has been replaced. See [this pull request](https://github.com/discord/discord-api-docs/pull/5724) for more information. * MORE_STICKERS * THREE_DAY_THREAD_ARCHIVE * SEVEN_DAY_THREAD_ARCHIVE * PRIVATE_THREADS * ROLE_ICONS * RAID_ALERTS_DISABLED * ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE * ROLE_SUBSCRIPTIONS_ENABLEDFetchApplicationCommandOptionstypedefsOptions used to fetch Application Commands from DiscordFetchArchivedThreadOptionstypedefsThe options used to fetch archived threads.FetchAutoModerationRuleOptionstypedefsOptions used to fetch a single auto moderation rule from a guild.FetchAutoModerationRulesOptionstypedefsOptions used to fetch all auto moderation rules from a guild.FetchBanOptionstypedefsOptions used to fetch a single ban from a guild.FetchBansOptionstypedefsOptions used to fetch multiple bans from a guild.FetchChannelOptionstypedefsOptions for fetching a channel from DiscordFetchChannelThreadsOptionstypedefsDiscord.js self-bot specific options field for fetching active threads.FetchedThreadstypedefsThe data returned from a thread fetch that returns multiple threads.FetchGuildOptionstypedefsOptions used to fetch a single guild.FetchGuildScheduledEventOptionstypedefsOptions used to fetch a single guild scheduled event from a guild.FetchGuildScheduledEventsOptionstypedefsOptions used to fetch multiple guild scheduled events from a guild.FetchGuildScheduledEventSubscribersOptionstypedefsOptions used to fetch subscribers of a guild scheduled eventFetchGuildsOptionstypedefsOptions used to fetch multiple guilds.FetchInviteOptionstypedefsOptions used to fetch a single invite from a guild.FetchInvitesOptionstypedefsOptions used to fetch all invites from a guild.FetchMemberOptionstypedefsOptions used to fetch a single member from a guild.FetchMembersOptionstypedefsOptions used to fetch multiple members from a guild.FetchPollAnswerVotersOptionstypedefsOptions used for fetching voters of an answer in a poll.FetchPollVotersOptionstypedefsFetchReactionUsersOptionstypedefsOptions used to fetch users who gave a reaction.FetchRecommendedShardsOptionstypedefsFetchThreadMemberOptionstypedefsOptions used to fetch a thread member.FetchThreadMembersOptionstypedefsOptions used to fetch multiple thread members.FetchThreadMembersWithGuildMemberDataOptionstypedefsOptions used to fetch multiple thread members with guild member data. With `withMember` set to `true`, pagination is enabled.FetchThreadMembersWithoutGuildMemberDataOptionstypedefsOptions used to fetch multiple thread members without guild member data.FetchThreadsOptionstypedefsOptions for fetching multiple threads.FileComponentclassesFileOptionstypedefsfindPortfunctionsFind an available port within a given range.FormattersclassesContains various Discord-specific functions for formatting messages.ForumChannelclassesRepresents a forum channel.ForumLayoutTypetypedefsThe default forum layout to set on the ForumChannel * NOT_SET * LIST_VIEW * GALLERY_VIEWForwardOptionstypedefsGlobalSweepFiltertypedefsGroupDMChannelclassesRepresents a Group DM Channel on Discord.GroupDMChannelEditDatatypedefsThe data for editing a channe;.GuildclassesRepresents a guild (or a server) on Discord. It's recommended to see if a guild is available before performing operations or reading data from it. You can check this with Guild#available.GuildApplicationCommandPermissionDatatypedefsData used for overwriting the permissions for all application commands in a guild.GuildAuditLogsclassesAudit logs entries are held in this class.GuildAuditLogsEntryclassesAudit logs entry.GuildAuditLogsFetchOptionstypedefsOptions used to fetch audit logs.GuildBanclassesRepresents a ban in a guild on Discord.GuildBanManagerclassesManages API methods for GuildBans and stores their cache.GuildBanResolvabletypedefsData that resolves to give a GuildBan object. This can be: * A GuildBan object * A User resolvableGuildBoostclassesRepresents a guild boost in a guild on Discord.GuildChannelclassesRepresents a guild channel from any of the following: - TextChannel - VoiceChannel - CategoryChannel - NewsChannel - StoreChannel - StageChannel - ForumChannel - MediaChannelGuildChannelCloneOptionstypedefsOptions used to clone a guild channel.GuildChannelCreateOptionstypedefsOptions used to create a new channel in a guild.GuildChannelManagerclassesManages API methods for GuildChannels and stores their cache.GuildChannelOverwriteOptionstypedefsExtra information about the overwriteGuildChannelResolvabletypedefsData that can be resolved to give a Guild Channel object. This can be: * A GuildChannel object * A ThreadChannel object * A SnowflakeGuildCreateOptionstypedefsOptions used to create a guild.GuildEditDatatypedefsThe data for editing a guild.GuildEmojiclassesRepresents a custom emoji.GuildEmojiCreateOptionstypedefsOptions used for creating an emoji in a guild.GuildEmojiEditDatatypedefsData for editing an emoji.GuildEmojiManagerclassesManages API methods for GuildEmojis and stores their cache.GuildEmojiRoleManagerclassesManages API methods for roles belonging to emojis and stores their cache.GuildForumTagtypedefsGuildForumTagDatatypedefsGuildForumTagEmojitypedefsGuildForumThreadCreateOptionstypedefsOptions for creating a thread.GuildForumThreadManagerclassesManages API methods for threads in forum channels and stores their cache.GuildForumThreadMessageCreateOptionstypedefsGuildInvitableChannelResolvabletypedefsData that can be resolved to a channel that an invite can be created on. This can be: * TextChannel * VoiceChannel * NewsChannel * StoreChannel * StageChannel * SnowflakeGuildInviteManagerclassesManages API methods for GuildInvites and stores their cache.GuildManagerclassesManages API methods for Guilds and stores their cache.GuildMemberclassesRepresents a member of a guild on Discord.GuildMemberEditDatatypedefsThe data for editing a guild member.GuildMemberFlagsclassesData structure that makes it easy to interact with an GuildMember#flags bitfield.GuildMemberFlagsResolvabletypedefsData that can be resolved to give a guild member flag bitfield. This can be: * A string (see GuildMemberFlags.FLAGS) * A guild member flag * An instance of GuildMemberFlags * An Array of GuildMemberFlagsResolvableGuildMemberManagerclassesManages API methods for GuildMembers and stores their cache.GuildMemberResolvabletypedefsData that resolves to give a GuildMember object. This can be: * A GuildMember object * A User resolvableGuildMemberRoleManagerclassesManages API methods for roles of a GuildMember and stores their cache.GuildMembersChunktypedefsRepresents the properties of a guild members chunkGuildPreviewclassesRepresents the data about the guild any bot can preview, connected to the specified guild.GuildPreviewEmojiclassesRepresents an instance of an emoji belonging to a public guild obtained through Discord's preview endpoint.GuildPruneMembersOptionstypedefsOptions used for pruning guild members. It's recommended to set options.count to `false` for large guilds.GuildResolvabletypedefsData that resolves to give a Guild object. This can be: * A Guild object * A GuildChannel object * A GuildEmoji object * A Role object * A Snowflake * An Invite objectGuildRolePositiontypedefsThe data needed for updating a guild role's positionGuildScheduledEventclassesRepresents a scheduled event in a Guild.GuildScheduledEventCreateOptionstypedefsOptions used to create a guild scheduled event.GuildScheduledEventEditOptionstypedefsOptions used to edit a guild scheduled event.GuildScheduledEventEntityMetadatatypedefsRepresents the additional metadata for a GuildScheduledEventGuildScheduledEventEntityMetadataOptionstypedefsOptions used to set entity metadata of a guild scheduled event.GuildScheduledEventEntityTypetypedefsThe entity type of a GuildScheduledEvent: * NONE * STAGE_INSTANCE * VOICE * EXTERNALGuildScheduledEventManagerclassesManages API methods for GuildScheduledEvents and stores their cache.GuildScheduledEventPrivacyLeveltypedefsPrivacy level of a GuildScheduledEvent object: * GUILD_ONLYGuildScheduledEventRecurrenceRuletypedefsRepresents the recurrence rule for a GuildScheduledEvent.GuildScheduledEventRecurrenceRuleFrequencyexternalsGuildScheduledEventRecurrenceRuleMonthexternalsGuildScheduledEventRecurrenceRuleNWeekdaytypedefsGuildScheduledEventRecurrenceRuleOptionstypedefsOptions for setting a recurrence rule for a guild scheduled event.GuildScheduledEventRecurrenceRuleWeekdayexternalsGuildScheduledEventResolvabletypedefsData that resolves to give a GuildScheduledEvent object. This can be: * A Snowflake * A GuildScheduledEvent objectGuildScheduledEventStatustypedefsThe status of a GuildScheduledEvent: * SCHEDULED * ACTIVE * COMPLETED * CANCELEDGuildScheduledEventUsertypedefsRepresents a subscriber of a GuildScheduledEventGuildSearchMembersOptionstypedefsOptions used for searching guild members.GuildSettingManagerclassesManages API methods for users and stores their cache.GuildStickerCreateOptionstypedefsOptions for creating a guild sticker.GuildStickerEditDatatypedefsData for editing a sticker.GuildStickerManagerclassesManages API methods for Guild Stickers and stores their cache.GuildTemplateclassesRepresents the template for a guild.GuildTemplateResolvabletypedefsData that can be resolved to give a template code. This can be: * A template code * A template URLGuildTextChannelResolvabletypedefsData that can be resolved to a GuildTextChannel object. This can be: * A TextChannel * A NewsChannel * A SnowflakeGuildTextThreadCreateOptionstypedefsOptions for creating a thread. Only one of `startMessage` or `type` can be defined.GuildTextThreadManagerclassesManages API methods for ThreadChannel objects and stores their cache.GuildVoiceChannelResolvabletypedefsData that can be resolved to a GuildVoiceChannel object. This can be: * A VoiceChannel * A StageChannel * A SnowflakeGuildWidgetSettingstypedefsData for the Guild Widget Settings objectGuildWidgetSettingsDatatypedefsThe Guild Widget Settings objectHasApplicationCommandPermissionsOptionstypedefsOptions used to check the existence of permissions on a command The `command` parameter is not optional when the managers `commandId` is `null`HolographicStyletypedefsHolographic color values for role styling. When using `tertiaryColor`, the API enforces these specific values for holographic effect. * PRIMARY: 11127295 (0xA9FFFF) * SECONDARY: 16759788 (0xFFCCCC) * TERTIARY: 16761760 (0xFFE0A0)HTTPAttachmentDatatypedefsThe attachment data that is sent to DiscordHTTPErrorclassesRepresents an HTTP error from a request.HTTPErrorDatatypedefsThe HTTP data that was sent to DiscordHTTPMethodexternalsHTTPOptionstypedefsHTTP optionsImageURLOptionstypedefsOptions for Image URLs.IncidentActionstypedefsIncident actions of a guild.IncidentActionsEditOptionstypedefsOptions used to set incident actions. Supplying `null` to any option will disable the action.InflateexternalsIntegrationclassesRepresents a guild integration.IntegrationAccounttypedefsThe information account for an integrationIntegrationApplicationclassesRepresents an Integration's OAuth2 Application.IntegrationExpireBehaviortypedefsThe behavior of expiring subscribers for Integrations. This can be: * REMOVE_ROLE * KICKIntegrationTypetypedefsThe type of an Integration. This can be: * `twitch` * `youtube` * `discord` * `guild_subscription`IntentsclassesData structure that makes it easy to calculate intents.IntentsResolvabletypedefsData that can be resolved to give a permission number. This can be: * A string (see Intents.FLAGS) * An intents flag * An instance of Intents * An array of IntentsResolvableInteractionclassesRepresents an interaction.InteractionCollectorclassesCollects interactions. Will automatically stop if the message (messageDelete or messageDeleteBulk), channel (channelDelete), or guild (guildDelete) is deleted. Interaction collectors that do not specify `time` or `idle` may be prone to always running. Ensure your interaction collectors end via either of these options or manual cancellation.InteractionCollectorOptionstypedefsInteractionDeferReplyOptionstypedefsOptions for deferring the reply to an Interaction.InteractionDeferUpdateOptionstypedefsOptions for deferring and updating the reply to a MessageComponentInteraction.InteractionEditReplyOptionstypedefsOptions that can be passed into InteractionResponses#editReply.InteractionReplyOptionstypedefsOptions for a reply to an Interaction.InteractionResponsesinterfacesInterface for classes that support shared interaction response types.InteractionResponseTypetypedefsThe type of an interaction response: * PONG * CHANNEL_MESSAGE_WITH_SOURCE * DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE * DEFERRED_MESSAGE_UPDATE * UPDATE_MESSAGE * APPLICATION_COMMAND_AUTOCOMPLETE_RESULT * MODALInteractionTypetypedefsThe type of an Interaction object: * PING * APPLICATION_COMMAND * MESSAGE_COMPONENT * APPLICATION_COMMAND_AUTOCOMPLETE * MODAL_SUBMITInteractionUpdateOptionstypedefsOptions for updating the message received from a MessageComponentInteraction.InteractionWebhookclassesRepresents a webhook for an InteractioninterfaceAddressfunctionsGet the interface address for a given socket type.InterfaceAddressestypedefsInvalidRequestWarningDatatypedefsInviteclassesRepresents an invitation to a guild channel.InviteFlagsclassesData structure that makes it easy to interact with an InviteFlags#flags bitfield.InviteGenerationOptionstypedefsOptions for Client#generateInvite.InviteGuildclassesRepresents a guild received from an invite, includes welcome screen data if available.InviteResolvabletypedefsData that can be resolved to give an invite code. This can be: * An invite code * An invite URLInviteScopetypedefsA valid scope to request when generating an invite link. Scopes that require whitelist are not considered valid for this generator * `applications.builds.read`: allows reading build data for a users applications * `applications.commands`: allows this bot to create commands in the server * `applications.entitlements`: allows reading entitlements for a users applications * `applications.store.update`: allows reading and updating of store data for a users applications * `bot`: makes the bot join the selected guild * `connections`: makes the endpoint for getting a users connections available * `email`: allows the `/users/@me` endpoint return with an email * `identify`: allows the `/users/@me` endpoint without an email * `guilds`: makes the `/users/@me/guilds` endpoint available for a user * `guilds.join`: allows the bot to join the user to any guild it is in using Guild#addMember * `gdm.join`: allows joining the user to a group dm * `webhook.incoming`: generates a webhook to a channel * `role_connections.write`: allows your app to update a user's connection and metadata for the appInviteStageInstanceclassesRepresents the data about a public StageInstance in an Invite.InviteTargetUsersJobStatustypedefsProcessing status for a targeted-invite user list.InviteTypetypedefsThe type of the invite: * 0: GUILD * 1: GROUP_DM * 2: FRIENDJoinChannelConfigtypedefsLabelComponentclassesRepresents a label and its nested modal input component.LifetimeFilterOptionstypedefsOptions for generating a filter function based on lifetimeLimitedCollectionclassesA Collection which holds a max amount of entries and sweeps periodically.LimitedCollectionOptionstypedefsOptions for defining the behavior of a LimitedCollectionLocaletypedefsA Discord locale string, possible values are: * en-US (English, US) * en-GB (English, UK) * bg (Bulgarian) * zh-CN (Chinese, China) * zh-TW (Chinese, Taiwan) * hr (Croatian) * cs (Czech) * da (Danish) * nl (Dutch) * fi (Finnish) * fr (French) * de (German) * el (Greek) * hi (Hindi) * hu (Hungarian) * it (Italian) * ja (Japanese) * ko (Korean) * lt (Lithuanian) * no (Norwegian) * pl (Polish) * pt-BR (Portuguese, Brazilian) * ro (Romanian, Romania) * ru (Russian) * es-ES (Spanish) * sv-SE (Swedish) * th (Thai) * tr (Turkish) * uk (Ukrainian) * vi (Vietnamese)makeDiscordjsErrorfunctionsExtend an error of some sort into a DiscordjsError.MakeErrorOptionstypedefsOptions used to make an error object.MaxBulkDeletableMessageAgetypedefsMax bulk deletable message ageMediaChannelclassesRepresents a media channel.MediaGalleryComponentclassesMediaGalleryItemclassesMediaPlayerclassesPlayer for a Voice Connection.MembershipStatetypedefsThe value set for a team member's membership state: * INVITED * ACCEPTEDmessagefunctionsFormat the message for an error.MessageclassesRepresents a message on Discord.MessageActionRowclassesRepresents an action row containing message components.MessageActionRowComponenttypedefsComponents that can be placed in an action row * MessageButton * MessageSelectMenu * TextInputComponentMessageActionRowComponentOptionstypedefsOptions for components that can be placed in an action row * MessageButtonOptions * MessageSelectMenuOptions * TextInputComponentOptionsMessageActionRowComponentResolvabletypedefsData that can be resolved into components that can be placed in an action row * MessageActionRowComponent * MessageActionRowComponentOptionsMessageActionRowOptionstypedefsMessageActivitytypedefsActivity sent in a message.MessageActivityTypeexternalsMessageAttachmentclassesRepresents an attachment in a message.MessageButtonclassesRepresents a button message component.MessageButtonOptionstypedefsMessageButtonStyletypedefsThe style of a message button * PRIMARY * SECONDARY * SUCCESS * DANGER * LINKMessageButtonStyleResolvabletypedefsData that can be resolved to a MessageButtonStyle. This can be * MessageButtonStyle * numberMessageCalltypedefsA call associated with a messageMessageCollectorclassesCollects messages on a channel. Will automatically stop if the channel (channelDelete), thread (threadDelete), or guild (guildDelete) is deleted.MessageCollectorOptionstypedefsMessageComponenttypedefsComponents that can be sent in a payload. These can be: * MessageActionRow * MessageButton * MessageSelectMenu * TextInputComponentMessageComponentInteractionclassesRepresents a message component interaction.MessageComponentOptionstypedefsData that can be resolved into options for a component. This can be: * MessageActionRowOptions * MessageButtonOptions * MessageSelectMenuOptions * TextInputComponentOptionsMessageComponentTypetypedefsThe type of a message component * ACTION_ROW * BUTTON * STRING_SELECT * TEXT_INPUT * USER_SELECT * ROLE_SELECT * MENTIONABLE_SELECT * CHANNEL_SELECT * SECTION * TEXT_DISPLAY * THUMBNAIL * MEDIA_GALLERY * FILE * SEPARATOR * CONTAINER * LABEL * FILE_UPLOAD * RADIO_GROUP * CHECKBOX_GROUP * CHECKBOXMessageComponentTypeResolvabletypedefsData that can be resolved to a MessageComponentType. This can be: * MessageComponentType * string * numberMessageContextMenuInteractionclassesRepresents a message context menu interaction.MessageEditOptionstypedefsOptions that can be passed into Message#edit.MessageEmbedclassesRepresents an embed in a message (image/video preview, rich embed, etc.)MessageEmbedAuthortypedefsRepresents the author field of a MessageEmbedMessageEmbedFootertypedefsRepresents the footer field of a MessageEmbedMessageEmbedImagetypedefsRepresents the image of a MessageEmbedMessageEmbedOptionstypedefsRepresents the possible options for a MessageEmbedMessageEmbedProvidertypedefsRepresents the provider of a MessageEmbedMessageEmbedThumbnailtypedefsRepresents the thumbnail of a MessageEmbedMessageEmbedVideotypedefsRepresents the video of a MessageEmbedMessageEventexternalsMessageFiletypedefsMessageFlagsclassesData structure that makes it easy to interact with a Message#flags bitfield.MessageInteractiontypedefsPartial data of the interaction that a message is a reply toMessageManagerclassesManages API methods for Messages and holds their cache.MessageMentionOptionstypedefsOptions provided to control parsing of mentions by DiscordMessageMentionsclassesKeeps track of mentions in a Message.MessageMentionsHasOptionstypedefsOptions used to check for a mention.MessageMentionTypestypedefsTypes of mentions to enable in MessageMentionOptions. - `roles` - `users` - `everyone`MessageOptionstypedefsOptions provided when sending or editing a message.MessagePayloadclassesRepresents a message to be sent to the API.MessageReactionclassesRepresents a reaction to a message.MessageReactionEventDetailstypedefsProvides additional information about altered reactionMessageReactionResolvabletypedefsData that can be resolved to a MessageReaction object. This can be: * A MessageReaction * A Snowflake * The Unicode representation of an emojiMessageReferencetypedefsReference data sent in a message that contains ids identifying the referenced message. This can be present in the following types of message: * Crossposted messages (IS_CROSSPOST message flag) * CHANNEL_FOLLOW_ADD * CHANNEL_PINNED_MESSAGE * REPLY * THREAD_STARTER_MESSAGEMessageReferenceTypetypedefsThe type of a message reference, e.g. `DEFAULT`. Here are the available types: * DEFAULT * FORWARDMessageResolvabletypedefsData that can be resolved to a Message object. This can be: * A Message * A SnowflakeMessageSearchOptionstypedefsMessageSearchResulttypedefsMessageSelectMenuclassesRepresents a select menu message componentMessageSelectMenuOptionstypedefsMessageSelectOptiontypedefsMessageSelectOptionDatatypedefsMessageTargettypedefsA target for a message.MessageTypetypedefsThe type of a message, e.g. `DEFAULT`. Here are the available types: * DEFAULT * RECIPIENT_ADD * RECIPIENT_REMOVE * CALL * CHANNEL_NAME_CHANGE * CHANNEL_ICON_CHANGE * CHANNEL_PINNED_MESSAGE * GUILD_MEMBER_JOIN * USER_PREMIUM_GUILD_SUBSCRIPTION * USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_1 * USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_2 * USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_3 * CHANNEL_FOLLOW_ADD * GUILD_DISCOVERY_DISQUALIFIED * GUILD_DISCOVERY_REQUALIFIED * GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING * GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING * THREAD_CREATED * REPLY * APPLICATION_COMMAND * THREAD_STARTER_MESSAGE * GUILD_INVITE_REMINDER * CONTEXT_MENU_COMMAND * AUTO_MODERATION_ACTION * ROLE_SUBSCRIPTION_PURCHASE * INTERACTION_PREMIUM_UPSELL * STAGE_START * STAGE_END * STAGE_SPEAKER * STAGE_RAISE_HAND * STAGE_TOPIC * GUILD_APPLICATION_PREMIUM_SUBSCRIPTION * PREMIUM_REFERRAL * GUILD_INCIDENT_ALERT_MODE_ENABLED * GUILD_INCIDENT_ALERT_MODE_DISABLED * GUILD_INCIDENT_REPORT_RAID * GUILD_INCIDENT_REPORT_FALSE_ALARM * GUILD_DEADCHAT_REVIVE_PROMPT * CUSTOM_GIFT * GUILD_GAMING_STATS_PROMPT * PURCHASE_NOTIFICATION * POLL_RESULT * CHANGELOG * NITRO_NOTIFICATIONMFALeveltypedefsThe required MFA level for a guild * NONE * ELEVATEDModalclassesRepresents a modal (form) to be shown in response to an interactionModalInputComponentclassesRepresents one of Discord's v14 modal-only input components. This includes file uploads, radio groups, checkbox groups, and checkboxes.ModalSubmitFieldsResolverclassesA resolver for modal submit interaction text inputs.ModalSubmitInteractionclassesRepresents a modal submit interaction.MultipleShardRespawnOptionstypedefsOptions used to respawn all shards.MultipleShardSpawnOptionstypedefsOptions used to spawn multiple shards.NameplateDatatypedefsNameplatePaletteexternalsNewsChannelclassesRepresents a guild news channel on Discord.NSFWLeveltypedefsNSFW level of a Guild: * DEFAULT * EXPLICIT * SAFE * AGE_RESTRICTEDOAuth2AuthorizeOptionstypedefsOAuth2GuildclassesA partial guild received when using GuildManager#fetch to fetch multiple guilds.OpcodestypedefsThe Opcodes sent to the Gateway: * DISPATCH: 0 * HEARTBEAT: 1 * IDENTIFY: 2 * STATUS_UPDATE: 3 * VOICE_STATE_UPDATE: 4 * VOICE_GUILD_PING: 5 * RESUME: 6 * RECONNECT: 7 * REQUEST_GUILD_MEMBERS: 8 * INVALID_SESSION: 9 * HELLO: 10 * HEARTBEAT_ACK: 11 * GUILD_SYNC: 12 [Unused] * DM_UPDATE: 13 # Send => used to get dm features * GUILD_SUBSCRIPTIONS: 14 # Send => discord responds back with GUILD_MEMBER_LIST_UPDATE type SYNC... * LOBBY_CONNECT: 15 * LOBBY_DISCONNECT: 16 * LOBBY_VOICE_STATE_UPDATE: 17 # Receive * STREAM_CREATE: 18 * STREAM_DELETE: 19 * STREAM_WATCH: 20 * STREAM_PING: 21 # Send * STREAM_SET_PAUSED: 22 * LFG_SUBSCRIPTIONS: 23 [Unused] * REQUEST_GUILD_APPLICATION_COMMANDS: 24 [Unused] * EMBEDDED_ACTIVITY_LAUNCH: 25 => Launch an embedded activity in a voice channel or call. * EMBEDDED_ACTIVITY_CLOSE: 26 => Stop an embedded activity. * EMBEDDED_ACTIVITY_UPDATE: 27 => Update an embedded activity. * REQUEST_FORUM_UNREADS: 28 => Request forum channel unread counts. * REMOTE_COMMAND: 29 => Send a remote command to an embedded (Xbox, PlayStation) voice session. * GET_DELETED_ENTITY_IDS_NOT_MATCHING_HASH: 30 => Request deleted entity IDs not matching a given hash for a guild. * REQUEST_SOUNDBOARD_SOUNDS: 31 * SPEED_TEST_CREATE: 32 => Create a voice speed test. * SPEED_TEST_DELETE: 33 => Delete a voice speed test. * REQUEST_LAST_MESSAGES: 34 => Request last messages for a guild's channels. * SEARCH_RECENT_MEMBERS: 35 => ~ Opcode 8 (Member Safety) * REQUEST_CHANNEL_STATUSES: 36 => Request Voice Channel status. * GUILD_SUBSCRIPTIONS_BULK: 37 => ~ Opcode 14 * REQUEST_CHANNEL_INFO: 43 => Request ephemeral voice channel information.OptionsclassesContains various utilities for client options.OverwriteDatatypedefsData that can be used for a permission overwriteOverwriteResolvabletypedefsData that can be resolved into RawOverwriteData. This can be: * PermissionOverwrites * OverwriteDataOverwriteTypetypedefsAn overwrite type: * role * memberPartialtypedefsA `Partial` object is a representation of any existing object. This object contains between 0 and all of the original objects parameters. This is true regardless of whether the parameters are optional in the base object.PartialChannelDatatypedefsPartial data for a Channel.PartialModalActionRowtypedefsPartialOverwriteDatatypedefsPartial overwrite data.PartialRoleDatatypedefsPartial data for a Role.PartialTextInputDatatypedefsPartialTypetypedefsThe type of Structure allowed to be a partial: * USER * CHANNEL (only affects DMChannels) * GUILD_MEMBER * MESSAGE * REACTION * GUILD_SCHEDULED_EVENT Partials require you to put checks in place when handling data. See the "Partial Structures" topic on the [guide](https://discordjs.guide/popular-topics/partials.html) for more information.PermissionOverwriteManagerclassesManages API methods for guild channel permission overwrites and stores their cache.PermissionOverwriteOptionstypedefsAn object mapping permission flags to `true` (enabled), `null` (unset) or `false` (disabled). ```js { 'SEND_MESSAGES': true, 'EMBED_LINKS': null, 'ATTACH_FILES': false, } ```PermissionOverwritesclassesRepresents a permission overwrite for a role or member in a guild channel.PermissionResolvabletypedefsData that can be resolved to give a permission number. This can be: * A string (see Permissions.FLAGS) * A permission number * An instance of Permissions * An Array of PermissionResolvablePermissionsclassesData structure that makes it easy to interact with a permission bitfield. All GuildMembers have a set of permissions in their guild, and each channel in the guild may also have PermissionOverwrites for the member that override their default permissions.PlayInterfaceclassesAn interface class to allow you to play audio over VoiceConnections.PollclassesRepresents a PollPollAnswerclassesRepresents an answer to a PollPollAnswerDatatypedefsRepresents the data for a poll answer.PollAnswerVoterManagerclassesManages users who voted on a poll answer.PollDatatypedefsRepresents the data for a poll.PollLayoutTypeexternalsPollLayoutTypetypedefsDifferent layouts for MessagePoll will come in the future. For now though, this value will always be `DEFAULT`. * DEFAULT * IMAGE_ONLY_ANSWERSPollQuestionMediatypedefsThe media for a poll's questionPremiumTiertypedefsThe premium tier (Server Boost level) of a guild: * NONE * TIER_1 * TIER_2 * TIER_3PremiumUsageFlagsclassesData structure that makes it easy to interact with an PremiumUsageFlags#flags bitfield.PresenceclassesRepresents a user's presence.PresenceDatatypedefsData resembling a raw Discord presence.PresenceManagerclassesManages API methods for Presences and holds their cache.PresenceResolvabletypedefsData that can be resolved to a Presence object. This can be: * A Presence * A UserResolvable * A SnowflakePresenceStatustypedefsThe status of this presence: * **`online`** - user is online * **`idle`** - user is AFK * **`offline`** - user is offline or invisible * **`dnd`** - user is in Do Not DisturbPresenceStatusDatatypedefsA user's status. Must be one of: * `online` * `idle` * `invisible` * `dnd` (do not disturb)PrivacyLeveltypedefsPrivacy level of a StageInstance object: * PUBLIC * GUILD_ONLYProxyAgentOptionstypedefsProxyAgent options.PurchasedFlagsclassesData structure that makes it easy to interact with an PurchasedFlags#flags bitfield.randomPortfunctionsGet a random available port.randomPortsfunctionsGet multiple random available ports.RateLimitDatatypedefsRate limit dataRateLimitErrorclassesRepresents a RateLimit error from a request.RateLimitQueueFiltertypedefsWhether this rate limit should throw an ErrorRawEmojitypedefsRepresents raw emoji data from the APIRawOverwriteDatatypedefsThe raw data for a permission overwriteReactionCollectorclassesCollects reactions on messages. Will automatically stop if the message (messageDelete or messageDeleteBulk), channel (channelDelete), thread (threadDelete), or guild (guildDelete) is deleted.ReactionCollectorOptionstypedefsReactionCountDetailsDatatypedefsThe reaction count details object contains information about super and normal reaction counts.ReactionEmojiclassesRepresents a limited emoji set used for both custom and unicode emojis. Custom emojis will use this class opposed to the Emoji class when the client doesn't know enough information about them.ReactionManagerclassesManages API methods for reactions and holds their cache.ReactionTypeexternalsReactionTypetypedefsThe type of reaction * NORMAL * BURSTReactionUserManagerclassesManages API methods for users who reacted to a reaction and stores their cache.ReceiveStreamOptionstypedefsOptions passed to `VoiceReceiver#createStream`.RecorderclassesRepresents a FFmpeg handlerregisterfunctionsRegister an error code and message.RelationshipJSONDatatypedefsRelationshipManagerclassesManages API methods for Relationships and stores their cache.RelationshipTypetypedefsRelationship Enums: * 0: NONE * 1: FRIEND * 2: BLOCKED * 3: PENDING_INCOMING * 4: PENDING_OUTGOING * 5: IMPLICITRelationshipUpdateObjecttypedefsRemoveApplicationCommandPermissionsOptionstypedefsOptions used to remove permissions from a command The `command` parameter is not optional when the managers `commandId` is `null`ReplyMessageOptionstypedefsOptions provided when sending a message as an inline reply.ReplyOptionstypedefsOptions for sending a message with a reply.ResolvedOverwriteOptionstypedefsResponseexternalsRichButtontypedefsRichPartytypedefsRichPresenceclassesRichPresenceAssetsclassesAssets for a rich presenceRichPresenceImagetypedefsSupport: - cdn.discordapp.com - media.discordapp.net - Assets ID (https://discord.com/api/v9/oauth2/applications/{application_id}/assets) - Media Proxy (mp:external/{hash}) - Twitch (twitch:{username}) - YouTube (youtube:{video_id}) - Spotify (spotify:{image_id})RoleclassesRepresents a role on Discord.RoleColorstypedefsRoleColorsResolvabletypedefsRoleDatatypedefsThe data for a role.RoleFlagsclassesData structure that makes it easy to interact with an GuildMember#flags bitfield.RoleFlagsResolvabletypedefsData that can be resolved to give a role flag bitfield. This can be: * A string (see RoleFlags.FLAGS) * A role flag * An instance of RoleFlags * An Array of RoleFlagsResolvableRoleManagerclassesManages API methods for roles and stores their cache.RoleResolvabletypedefsData that can be resolved to a Role object. This can be: * A Role * A SnowflakeRtpPacketexternalsSectionComponentclassesSelectMenuComponentTypetypedefsThe types of components that are select menus. The available types are: * STRING_MENU * USER_SELECT * ROLE_SELECT * MENTIONABLE_SELECT * CHANNEL_SELECTSelectMenuInteractionclassesRepresents a select menu interaction.SeparatorComponentclassesSessionclassesRepresents a Client OAuth2 Application Team.SessionClientInfotypedefsSessionManagerclassesManages API methods for users and stores their cache.SetApplicationCommandPermissionsOptionstypedefsOptions used to set permissions for one or more Application Commands in a guild One of `command` AND `permissions`, OR `fullPermissions` is required. `fullPermissions` is not a valid option when passing to a manager where `commandId` is non-nullSetChannelPositionOptionstypedefsOptions used to set the position of a channel.SetParentOptionstypedefsOptions used to set the parent of a channel.SetRolePositionOptionstypedefsOptions used to set the position of a role.ShardclassesA self-contained shard created by the ShardingManager. Each one has a ChildProcess that contains an instance of the bot and its Client. When its child process/worker exits for any reason, the shard will spawn a new one to replace it as necessary.ShardClientUtilclassesHelper class for sharded clients spawned as a child process/worker, such as from a ShardingManager. Utilizes IPC to send and receive data to/from the master process and other shards.ShardEventstypedefsThe types of events emitted by a Shard: * CLOSE: close * DESTROYED: destroyed * INVALID_SESSION: invalidSession * READY: ready * RESUMED: resumed * ALL_READY: allReadyShardingManagerclassesThis is a utility class that makes multi-process sharding of a bot an easy and painless experience. It works by spawning a self-contained ChildProcess or Worker for each individual shard, each containing its own instance of your bot's Client. They all have a line of communication with the master process, and there are several useful methods that utilize it in order to simplify tasks that are normally difficult with sharding. It can spawn a specific number of shards or the amount that Discord suggests for the bot, and takes a path to your main bot script to launch for each one.ShardingManagerModetypedefsThe mode to spawn shards with for a ShardingManager. Can be either one of: * 'process' to use child processes * 'worker' to use [Worker threads](https://nodejs.org/api/worker_threads.html)ShardingManagerOptionstypedefsThe options to spawn shards with for a ShardingManager.ShardRespawnOptionstypedefsOptions used to respawn a shard.SlashCommandBuilderexternalsSnowflaketypedefsA Twitter snowflake, except the epoch is 2015-01-01T00:00:00.000Z. If we have a snowflake '266241948824764416' we can represent it as binary: ``` 64 22 17 12 0 000000111011000111100001101001000101000000 00001 00000 000000000000 number of milliseconds since Discord epoch worker pid increment ```SnowflakeUtilclassesA container for useful snowflake-related methods.SortOrderTypetypedefsSort ThreadOnlyChannel posts by creation time or activity * LATEST_ACTIVITY * CREATION_DATESpeakingclassesData structure that makes it easy to interact with a VoiceConnection#speaking and guildMemberSpeaking event bitfields.SplitOptionstypedefsOptions for splitting a message.SpotifyMetadatatypedefsSpotifyRPCclassesStageChannelclassesRepresents a guild stage channel on Discord.StageChannelResolvabletypedefsData that can be resolved to a Stage Channel object. This can be: * A StageChannel * A SnowflakeStageInstanceclassesRepresents a stage instance.StageInstanceCreateOptionstypedefsOptions used to create a stage instance.StageInstanceEditOptionstypedefsOptions used to edit an existing stage instance.StageInstanceManagerclassesManages API methods for StageInstance objects and holds their cache.StartThreadOptionstypedefsOptions for starting a thread on a message.StaticImageURLOptionstypedefsOptions for static Image URLs.StatustypedefsThe current status of the client. Here are the available statuses: * READY: 0 * CONNECTING: 1 * RECONNECTING: 2 * IDLE: 3 * NEARLY: 4 * DISCONNECTED: 5 * WAITING_FOR_GUILDS: 6 * IDENTIFYING: 7 * RESUMING: 8StickerclassesRepresents a Sticker.StickerFormatTypetypedefsThe value set for a sticker's format type: * PNG * APNG * LOTTIE * GIFStickerPackclassesRepresents a pack of standard stickers.StickerResolvabletypedefsData that resolves to give a Sticker object. This can be: * A Sticker object * A SnowflakeStickerTypetypedefsThe value set for a sticker's type: * STANDARD * GUILDStoreChannelclassesRepresents a guild store channel on Discord. Store channels have been removed from Discord. See [Self-serve Game Selling Deprecation](https://support-dev.discord.com/hc/en-us/articles/6309018858647) for more information.StreamexternalsStreamConnectionclassesRepresents a connection to a guild's voice server. ```js // Obtained using: client.voice.joinChannel(channel) .then(connection => connection.createStreamConnection()) .then(connection => { }); ```StreamConnectionReadonlyclassesRepresents a connection to a guild's voice server. ```js // Obtained using: client.voice.joinChannel(channel) .then(connection => connection.createStreamConnection()) .then(connection => { }); ```StreamOptionstypedefsOptions that can be passed to stream-playing methods:StreamTypetypedefsAn option passed as part of `StreamOptions` specifying the type of the stream. * `unknown`: The default type, streams/input will be passed through to ffmpeg before encoding. Will play most streams. * `converted`: Play a stream of 16bit signed stereo PCM data, skipping ffmpeg. * `opus`: Play a stream of opus packets, skipping ffmpeg. You lose the ability to alter volume. * `ogg/opus`: Play an ogg file with the opus encoding, skipping ffmpeg. You lose the ability to alter volume. * `webm/opus`: Play a webm file with opus audio, skipping ffmpeg. You lose the ability to alter volume.SweeperKeytypedefsThe name of an item to be swept in Sweepers * `applicationCommands` - both global and guild commands * `autoModerationRules` * `bans` * `emojis` * `invites` - accepts the `lifetime` property, using it will sweep based on expires timestamp * `guildMembers` * `messages` - accepts the `lifetime` property, using it will sweep based on edited or created timestamp * `presences` * `reactions` * `stageInstances` * `stickers` * `threadMembers` * `threads` - accepts the `lifetime` property, using it will sweep archived threads based on archived timestamp * `users` * `voiceStates`SweeperOptionstypedefsOptions for Sweepers defining the behavior of cache sweepingSweepersclassesA container for all cache sweeping intervals and their associated sweep methods.SweepEventOptionstypedefsConfiguration options for emitting the cache sweep client eventSweepFiltertypedefsSweepOptionstypedefsOptions for sweeping a single type of item from cacheSystemChannelFlagsclassesData structure that makes it easy to interact with a Guild#systemChannelFlags bitfield. Note that all event message types are enabled by default, and by setting their corresponding flags you are disabling themSystemChannelFlagsResolvabletypedefsData that can be resolved to give a system channel flag bitfield. This can be: * A string (see SystemChannelFlags.FLAGS) * A system channel flag * An instance of SystemChannelFlags * An Array of SystemChannelFlagsResolvableSystemMessageTypetypedefsThe types of messages that are `System`. The available types are `MessageTypes` excluding: * DEFAULT * REPLY * APPLICATION_COMMAND * CONTEXT_MENU_COMMANDTargetTypetypedefsThe type of the invite target: * 1: STREAM * 2: EMBEDDED_APPLICATION * 3: ROLE_SUBSCRIPTIONS * 4: CREATOR_PAGETargetUsersFileResolvabletypedefsData that can be resolved to a targeted-invite CSV file. An array is serialized with the required `user_id` header.TeamclassesRepresents a Client OAuth2 Application Team.TeamMemberclassesRepresents a Client OAuth2 Application Team Member.TeamMemberRoleexternalsTextBasedChannelinterfacesInterface for classes that have text-channel-like features.TextBasedChannelstypedefsThe channels that are text-based. * DMChannel * TextChannel * NewsChannel * ThreadChannel * VoiceChannel * StageChannelTextBasedChannelsResolvabletypedefsData that resolves to give a text-based channel. This can be: * A text-based channel * A snowflakeTextBasedChannelTypestypedefsThe types of channels that are text-based. The available types are: * DM * GUILD_TEXT * GUILD_NEWS * GUILD_NEWS_THREAD * GUILD_PUBLIC_THREAD * GUILD_PRIVATE_THREAD * GUILD_VOICE * GUILD_STAGE_VOICETextChannelclassesRepresents a guild text channel on Discord.TextChannelResolvabletypedefsData that can be resolved to a Text Channel object. This can be: * A TextChannel * A SnowflakeTextDisplayComponentclassesTextInputComponentclassesRepresents a text input component in a modalTextInputComponentOptionstypedefsTextInputStyletypedefsThe style of a text input component * SHORT * PARAGRAPHTextInputStyleResolvabletypedefsData that can be resolved to a TextInputStyle. This can be * TextInputStyle * numberThreadAutoArchiveDurationtypedefsA number that is allowed to be the duration (in minutes) of inactivity after which a thread is automatically archived. This can be: * `60` (1 hour) * `1440` (1 day) * `4320` (3 days) * `10080` (7 days) * `'MAX'` (7 days) This option is deprecated and will be removed in the next major version.ThreadChannelclassesRepresents a thread channel on Discord.ThreadChannelResolvabletypedefsData that can be resolved to a Thread Channel object. This can be: * A ThreadChannel object * A SnowflakeThreadChannelTypestypedefsThe types of channels that are threads. The available types are: * GUILD_NEWS_THREAD * GUILD_PUBLIC_THREAD * GUILD_PRIVATE_THREADThreadEditDatatypedefsThe options used to edit a thread channelThreadManagerclassesManages API methods for ThreadChannel objects and stores their cache.ThreadMemberclassesRepresents a Member for a Thread.ThreadMemberFlagsclassesData structure that makes it easy to interact with a ThreadMember#flags bitfield.ThreadMemberManagerclassesManages API methods for GuildMembers and stores their cache.ThreadMemberResolvabletypedefsData that resolves to give a ThreadMember object. This can be: * A ThreadMember object * A User resolvableThreadOnlyChannelclassesRepresents a channel that only contains threadsThumbnailComponentclassesTimestampStylesStringtypedefsA message formatting timestamp style, as defined in [here](https://discord.com/developers/docs/reference#message-formatting-timestamp-styles). * `t` Short time format, consisting of hours and minutes, e.g. 16:20. * `T` Long time format, consisting of hours, minutes, and seconds, e.g. 16:20:30. * `d` Short date format, consisting of day, month, and year, e.g. 20/04/2021. * `D` Long date format, consisting of day, month, and year, e.g. 20 April 2021. * `f` Short date-time format, consisting of short date and short time formats, e.g. 20 April 2021 16:20. * `F` Long date-time format, consisting of long date and short time formats, e.g. Tuesday, 20 April 2021 16:20. * `R` Relative time format, consisting of a relative duration format, e.g. 2 months ago.TLSOptionstypedefsTLS connection options.TopLevelComponenttypedefsTypingclassesRepresents a typing state for a user in a channel.UnfurledMediaItemclassesUserclassesRepresents a user on Discord.UserContextMenuInteractionclassesRepresents a user context menu interaction.UserFlagsclassesData structure that makes it easy to interact with a User#flags bitfield.UserManagerclassesManages API methods for users and stores their cache.UserNoteManagerclassesManages API methods for Client and stores their cache.UserPrimaryGuildtypedefsUserRawtypedefsUserResolvabletypedefsData that resolves to give a User object. This can be: * A User object * A Snowflake * A Message object (resolves to the message author) * A GuildMember object * A ThreadMember objectUtilclassesContains various general-purpose utility methods.VanitytypedefsAn object containing information about a guild's vanity invite.VerificationLeveltypedefsThe value set for the verification levels for a guild: * NONE * LOW * MEDIUM * HIGH * VERY_HIGHVideoCodectypedefsVideo codec * `VP8` * `VP9` (Not supported for encoding & decoding) * `H264` * `H265` (Not supported for encoding & decoding) * `AV1` (Not supported for encoding & decoding)VideoDispatcherclassesThe class that sends video packet data to the voice connection. ```js // Obtained using: client.voice.joinChannel(channel).then(connection => { // You can play a file or a stream here: const dispatcher = connection.playVideo('/home/hydrabolt/video.mp4', { fps: 60, preset: 'ultrafast' }); }); ```VideoOptionstypedefsOptions that can be passed to stream-playing methods:VideoQualityModetypedefsThe camera video quality mode of a VoiceChannel: * AUTO * FULLVoiceBasedChannelTypestypedefsThe types of channels that are voice-based. The available types are: * GUILD_VOICE * GUILD_STAGE_VOICEVoiceChannelclassesRepresents a guild voice channel on Discord.VoiceChannelEffectclassesRepresents an effect used in a VoiceChannel.VoiceChannelEffectSendAnimationTypeexternalsVoiceChannelResolvabletypedefsData that can be resolved to a Voice Channel object. This can be: * A VoiceChannel * A SnowflakeVoiceConnectionclassesRepresents a connection to a guild's voice server. ```js // Obtained using: client.voice.joinChannel(channel) .then(connection => { }); ```VoiceConnectionUDPClientclassesRepresents a UDP client for a Voice Connection.VoiceOpcodestypedefsVoiceReceiverclassesReceives audio packets from a voice connection.VoiceRegionclassesRepresents a Discord voice region for guilds.VoiceStateclassesRepresents the voice state for a Guild Member.VoiceStateManagerclassesManages API methods for VoiceStates and stores their cache.VoiceStatustypedefsThe current status of a voice connection. Here are the available statuses: * CONNECTED: 0 * CONNECTING: 1 * AUTHENTICATING: 2 * RECONNECTING: 3 * DISCONNECTED: 4VoiceWebSocketclassesRepresents a Voice Connection's WebSocket.VolumeInterfaceclassesAn interface class for volume transformation.WebEmbedclassesSend Embedlink to Discord Only works with Discord Web and Discord Client (no custom theme installed) - No Timestamp, Footer, Fields, Author iconURL - Video with Embed working - Can only choose between image and thumbnail - Description limit 350 charactersWebEmbedAuthortypedefsRepresents the author field of a WebEmbedWebEmbedImagetypedefsRepresents the image of a WebEmbedWebEmbedOptionstypedefsRepresents the possible options for a WebEmbedWebEmbedProvidertypedefsRepresents the provider of a WebEmbedWebEmbedVideotypedefsRepresents the video of a WebEmbedWebhookclassesRepresents a webhook.WebhookClientclassesThe webhook client.WebhookClientDatatypedefsThe data for the webhook client containing either an id and token or just a URLWebhookEditDatatypedefsOptions used to edit a Webhook.WebhookEditMessageOptionstypedefsOptions that can be passed into editMessage.WebhookFetchMessageOptionstypedefsOptions that can be passed into fetchMessage.WebhookMessageOptionstypedefsOptions that can be passed into send.WebhookTypetypedefsThe value set for a webhook's type: * Incoming * Channel Follower * ApplicationWebSocketManagerclassesThe WebSocket manager for this client. This class forwards raw dispatch events, read more about it here https://discord.com/developers/docs/topics/gatewayWebsocketOptionstypedefsWebSocket options (these are left as snake_case to match the API)WebSocketShardclassesRepresents a Shard's WebSocket connectionWelcomeChannelclassesRepresents a channel link in a guild's welcome screen.WelcomeChannelDatatypedefsWelcome channel dataWelcomeScreenclassesRepresents a welcome screen.WelcomeScreenEditDatatypedefsWelcome screen edit dataWidgetclassesRepresents a Widget.WidgetActivitytypedefsActivity sent in a WidgetMember.WidgetChanneltypedefsRepresents a channel in a WidgetWidgetMemberclassesRepresents a WidgetMember.WritableStreamexternalsWSCodestypedefsThe types of WebSocket error codes: * 1000: WS_CLOSE_REQUESTED * 1011: INTERNAL_ERROR * 4004: TOKEN_INVALID * 4010: SHARDING_INVALID * 4011: SHARDING_REQUIRED * 4012: INVALID_API_VERSION * 4013: INVALID_INTENTS * 4014: DISALLOWED_INTENTSWSEventTypetypedefsThe type of a WebSocket message event, e.g. `MESSAGE_CREATE`. Here are the available events: * READY * RESUMED * APPLICATION_COMMAND_CREATE (deprecated) * APPLICATION_COMMAND_DELETE (deprecated) * APPLICATION_COMMAND_PERMISSIONS_UPDATE * APPLICATION_COMMAND_UPDATE (deprecated) * AUTO_MODERATION_ACTION_EXECUTION * AUTO_MODERATION_RULE_CREATE * AUTO_MODERATION_RULE_DELETE * AUTO_MODERATION_RULE_UPDATE * GUILD_CREATE * GUILD_DELETE * GUILD_UPDATE * INVITE_CREATE * INVITE_DELETE * GUILD_MEMBER_ADD * GUILD_MEMBER_REMOVE * GUILD_MEMBER_UPDATE * GUILD_MEMBERS_CHUNK * GUILD_INTEGRATIONS_UPDATE * GUILD_ROLE_CREATE * GUILD_ROLE_DELETE * GUILD_ROLE_UPDATE * GUILD_BAN_ADD * GUILD_BAN_REMOVE * GUILD_EMOJIS_UPDATE * CHANNEL_CREATE * CHANNEL_DELETE * CHANNEL_UPDATE * CHANNEL_PINS_UPDATE * MESSAGE_CREATE * MESSAGE_DELETE * MESSAGE_UPDATE * MESSAGE_DELETE_BULK * MESSAGE_REACTION_ADD * MESSAGE_REACTION_REMOVE * MESSAGE_REACTION_REMOVE_ALL * MESSAGE_REACTION_REMOVE_EMOJI * THREAD_CREATE * THREAD_UPDATE * THREAD_DELETE * THREAD_LIST_SYNC * THREAD_MEMBER_UPDATE * THREAD_MEMBERS_UPDATE * USER_UPDATE * PRESENCE_UPDATE * TYPING_START * VOICE_STATE_UPDATE * VOICE_SERVER_UPDATE * WEBHOOKS_UPDATE * STAGE_INSTANCE_CREATE * STAGE_INSTANCE_UPDATE * STAGE_INSTANCE_DELETE * GUILD_STICKERS_UPDATE * GUILD_SCHEDULED_EVENT_CREATE * GUILD_SCHEDULED_EVENT_UPDATE * GUILD_SCHEDULED_EVENT_DELETE * GUILD_SCHEDULED_EVENT_USER_ADD * GUILD_SCHEDULED_EVENT_USER_REMOVE * GUILD_AUDIT_LOG_ENTRY_CREATE

How to read a page

• Classes document constructors, properties, methods, and emitted events.
• Interfaces group behavior mixed into multiple concrete structures.
• Typedefs describe option objects, callbacks, payloads, and unions.
• Functions document standalone helpers.
• Externals name types supplied by Discord API packages, Node.js, or other dependencies.

Private and deprecated members remain visible when they are present in source documentation, and are labeled accordingly. Prefer public, non-deprecated APIs for new code.

Most-used entry points

• Client — gateway, managers, login, lifecycle, and account helpers
• ClientOptions — cache, partial, REST, gateway, presence, captcha, and TOTP options
• TextBasedChannel — send, collectors, webhooks, and application-command helpers
• Message — message data and mutation methods
• Guild — guild data, managers, and account actions
• User — user identity and DM helpers
• Events — modern event constants
• Exports and aliases — package-root compatibility map