/
docs
/
packages
/
discord.js
/
main
/
Embed%3AClass
Search...
K
discord.js
discord.js
brokers
builders
collection
core
formatters
next
proxy
rest
util
voice
ws
main
main
Classes
ActionRow
ActionRowBuilder
Activity
ActivityFlagsBitField
AnnouncementChannel
AnonymousGuild
Application
ApplicationCommand
ApplicationCommandManager
ApplicationCommandPermissionsManager
ApplicationEmoji
ApplicationEmojiManager
ApplicationFlagsBitField
ApplicationRoleConnectionMetadata
Attachment
AttachmentBuilder
AttachmentFlagsBitField
AutocompleteInteraction
AutoModerationActionExecution
AutoModerationRule
AutoModerationRuleManager
Base
BaseChannel
BaseClient
BaseGuild
BaseGuildEmoji
BaseGuildEmojiManager
BaseGuildTextChannel
BaseGuildVoiceChannel
BaseInteraction
BaseManager
BaseSelectMenuComponent
BitField
ButtonBuilder
ButtonComponent
ButtonInteraction
CachedManager
CategoryChannel
CategoryChannelChildManager
ChannelFlagsBitField
ChannelManager
ChannelSelectMenuBuilder
ChannelSelectMenuComponent
ChannelSelectMenuInteraction
ChatInputCommandInteraction
Client
ClientApplication
ClientPresence
ClientUser
ClientVoiceManager
Collector
CommandInteraction
CommandInteractionOptionResolver
Component
ContextMenuCommandInteraction
DataManager
DirectoryChannel
DiscordjsError
DiscordjsRangeError
DiscordjsTypeError
DMChannel
DMMessageManager
Embed
EmbedBuilder
Emoji
Entitlement
EntitlementManager
ForumChannel
Guild
GuildApplicationCommandManager
GuildAuditLogs
GuildAuditLogsEntry
GuildBan
GuildBanManager
GuildChannel
GuildChannelManager
GuildEmoji
GuildEmojiManager
GuildEmojiRoleManager
GuildForumThreadManager
GuildInviteManager
GuildManager
GuildMember
GuildMemberFlagsBitField
GuildMemberManager
GuildMemberRoleManager
GuildMessageManager
GuildOnboarding
GuildOnboardingPrompt
GuildOnboardingPromptOption
GuildPreview
GuildPreviewEmoji
GuildScheduledEvent
GuildScheduledEventManager
GuildStickerManager
GuildTemplate
GuildTextThreadManager
Integration
IntegrationApplication
IntentsBitField
InteractionCollector
InteractionResponse
InteractionWebhook
Invite
InviteGuild
LimitedCollection
MediaChannel
MentionableSelectMenuBuilder
MentionableSelectMenuComponent
MentionableSelectMenuInteraction
Message
MessageCollector
MessageComponentInteraction
MessageContextMenuCommandInteraction
MessageFlagsBitField
MessageManager
MessageMentions
MessagePayload
MessageReaction
ModalBuilder
ModalSubmitFields
ModalSubmitInteraction
OAuth2Guild
Options
PartialGroupDMChannel
PartialGroupDMMessageManager
PermissionOverwriteManager
PermissionOverwrites
PermissionsBitField
Poll
PollAnswer
Presence
PresenceManager
ReactionCollector
ReactionEmoji
ReactionManager
ReactionUserManager
RichPresenceAssets
Role
RoleFlagsBitField
RoleManager
RoleSelectMenuBuilder
RoleSelectMenuComponent
RoleSelectMenuInteraction
Shard
ShardClientUtil
ShardingManager
SKU
SKUFlagsBitField
StageChannel
StageInstance
StageInstanceManager
Sticker
StickerPack
StringSelectMenuBuilder
StringSelectMenuComponent
StringSelectMenuInteraction
StringSelectMenuOptionBuilder
Sweepers
SystemChannelFlagsBitField
Team
TeamMember
TextChannel
TextInputBuilder
TextInputComponent
ThreadChannel
ThreadManager
ThreadMember
ThreadMemberFlagsBitField
ThreadMemberManager
ThreadOnlyChannel
Typing
User
UserContextMenuCommandInteraction
UserFlagsBitField
UserManager
UserSelectMenuBuilder
UserSelectMenuComponent
UserSelectMenuInteraction
VoiceChannel
VoiceChannelEffect
VoiceRegion
VoiceState
VoiceStateManager
Webhook
WebhookClient
WelcomeChannel
WelcomeScreen
Widget
WidgetMember
Functions
cleanCodeBlockContent
cleanContent
createComponent
createComponentBuilder
discordSort
fetchRecommendedShardCount
flatten
parseEmoji
parseWebhookURL
resolveColor
resolveSKUId
verifyString
Enums
DiscordjsErrorCodes
Events
Partials
ShardEvents
Status
Interfaces
ActionRowData
ActionRowModalData
ActivitiesOptions
ActivityOptions
AddGuildMemberOptions
AddOrRemoveGuildMemberRoleOptions
ApplicationCommandAttachmentOption
ApplicationCommandAutocompleteNumericOption
ApplicationCommandAutocompleteNumericOptionData
ApplicationCommandAutocompleteStringOption
ApplicationCommandAutocompleteStringOptionData
ApplicationCommandBooleanOption
ApplicationCommandBooleanOptionData
ApplicationCommandChannelOption
ApplicationCommandChannelOptionData
ApplicationCommandChoicesData
ApplicationCommandChoicesOption
ApplicationCommandMentionableOption
ApplicationCommandMentionableOptionData
ApplicationCommandNonOptions
ApplicationCommandNonOptionsData
ApplicationCommandNumericOption
ApplicationCommandNumericOptionData
ApplicationCommandOptionChoiceData
ApplicationCommandPermissions
ApplicationCommandPermissionsUpdateData
ApplicationCommandRoleOption
ApplicationCommandRoleOptionData
ApplicationCommandStringOption
ApplicationCommandStringOptionData
ApplicationCommandSubCommand
ApplicationCommandSubCommandData
ApplicationCommandSubGroup
ApplicationCommandSubGroupData
ApplicationCommandUserOption
ApplicationCommandUserOptionData
ApplicationEmojiCreateOptions
ApplicationEmojiEditOptions
ApplicationRoleConnectionMetadataEditOptions
AttachmentData
AttachmentPayload
AutocompleteFocusedOption
AutoModerationAction
AutoModerationActionMetadata
AutoModerationActionMetadataOptions
AutoModerationActionOptions
AutoModerationRuleCreateOptions
AutoModerationRuleEditOptions
AutoModerationTriggerMetadata
AutoModerationTriggerMetadataOptions
AvatarDecorationData
AwaitMessageCollectorOptionsParams
AwaitMessageComponentOptions
AwaitMessagesOptions
AwaitModalSubmitOptions
AwaitReactionsOptions
BanOptions
BaseApplicationCommandData
BaseApplicationCommandOptionsData
BaseButtonComponentData
BaseComponentData
BaseFetchOptions
BaseFetchPollAnswerVotersOptions
BaseGuildTextChannel
BaseGuildVoiceChannel
BaseMessageOptions
BaseMessageOptionsWithPoll
BaseModalData
BaseSelectMenuComponentData
BulkBanResult
Caches
CategoryCreateChannelOptions
ChannelCreationOverwrites
ChannelPosition
ChannelSelectMenuComponentData
ChannelWebhookCreateOptions
ChatInputApplicationCommandData
ClientApplicationEditOptions
ClientApplicationInstallParams
ClientEvents
ClientFetchInviteOptions
ClientOptions
ClientPresenceStatusData
ClientUserEditOptions
CollectorEventTypes
CollectorOptions
CollectorResetTimerOptions
CommandInteractionOption
CommandInteractionResolvedData
CrosspostedChannel
DefaultReactionEmoji
DMChannel
EditApplicationCommandPermissionsMixin
EmbedAssetData
EmbedAuthorData
EmbedData
EmbedField
EmbedFooterData
FetchApplicationCommandOptions
FetchArchivedThreadOptions
FetchAutoModerationRuleOptions
FetchAutoModerationRulesOptions
FetchBanOptions
FetchBansOptions
FetchChannelOptions
FetchedThreads
FetchedThreadsMore
FetchEntitlementsOptions
FetchGuildApplicationCommandFetchOptions
FetchGuildOptions
FetchGuildScheduledEventOptions
FetchGuildScheduledEventsOptions
FetchGuildScheduledEventSubscribersOptions
FetchGuildsOptions
FetchInviteOptions
FetchInvitesOptions
FetchMemberOptions
FetchMembersOptions
FetchMessageOptions
FetchMessagesOptions
FetchPollAnswerVotersOptions
FetchReactionUsersOptions
FetchRecommendedShardCountOptions
FetchThreadMemberOptions
FetchThreadMembersWithGuildMemberDataOptions
FetchThreadMembersWithoutGuildMemberDataOptions
FetchThreadOwnerOptions
FetchThreadsOptions
GuildAuditLogsEntryExtraField
GuildAuditLogsEntryTargetField
GuildAuditLogsFetchOptions
GuildChannelCloneOptions
GuildChannelCreateOptions
GuildChannelEditOptions
GuildChannelOverwriteOptions
GuildCreateOptions
GuildEditOptions
GuildEmojiCreateOptions
GuildEmojiEditOptions
GuildEntitlementCreateOptions
GuildForumTag
GuildForumTagData
GuildForumTagEmoji
GuildForumThreadCreateOptions
GuildForumThreadMessageCreateOptions
GuildListMembersOptions
GuildMember
GuildMemberEditOptions
GuildMembersChunk
GuildOnboardingEditOptions
GuildOnboardingPromptData
GuildOnboardingPromptOptionData
GuildPruneMembersOptions
GuildScheduledEventCreateOptions
GuildScheduledEventEditOptions
GuildScheduledEventEntityMetadata
GuildScheduledEventEntityMetadataOptions
GuildScheduledEventInviteURLCreateOptions
GuildScheduledEventRecurrenceRule
GuildScheduledEventRecurrenceRuleNWeekday
GuildScheduledEventRecurrenceRuleOptions
GuildScheduledEventUser
GuildSearchMembersOptions
GuildStickerCreateOptions
GuildStickerEditOptions
GuildTemplateEditOptions
GuildTextThreadCreateOptions
GuildWidgetSettings
GuildWidgetSettingsData
IconData
IntegrationAccount
IntegrationTypesConfigurationContext
InteractionButtonComponentData
InteractionCollectorOptions
InteractionDeferReplyOptions
InteractionDeferUpdateOptions
InteractionEditReplyOptions
InteractionReplyOptions
InteractionUpdateOptions
InteractionWebhook
InviteCreateOptions
InviteGenerationOptions
LifetimeFilterOptions
LifetimeSweepOptions
LimitedCollectionOptions
LinkButtonComponentData
MappedChannelCategoryTypes
MappedComponentBuilderTypes
MappedComponentTypes
MappedInteractionTypes
MentionableSelectMenuComponentData
MessageActivity
MessageApplicationCommandData
MessageCall
MessageChannelCollectorOptionsParams
MessageChannelComponentCollectorOptions
MessageCollectorOptions
MessageCollectorOptionsParams
MessageComponentCollectorOptions
MessageCreateOptions
MessageEditAttachmentData
MessageEditOptions
MessageInteraction
MessageInteractionMetadata
MessageMentionOptions
MessageMentionsHasOptions
MessageReactionEventDetails
MessageReference
MessageReplyOptions
MessageSelectOption
MessageSnapshot
ModalComponentData
ModalMessageModalSubmitInteraction
ModalSubmitInteractionCollectorOptions
MultipleShardRespawnOptions
MultipleShardSpawnOptions
OverwriteData
PartialChannelData
PartialDMChannel
PartialEmoji
PartialEmojiOnlyId
PartialGuildMember
PartialGuildScheduledEvent
PartialMessage
PartialMessageReaction
PartialOverwriteData
PartialRecipient
PartialRoleData
PartialTextBasedChannelFields
PartialThreadMember
PartialUser
PollAnswerData
PollData
PollQuestionMedia
PresenceData
PrivateThreadChannel
PublicThreadChannel
ReactionCollectorOptions
ReactionCountDetailsData
RecursiveReadonlyArray
ReplyOptions
ResolvedOverwriteOptions
RoleCreateOptions
RoleData
RoleEditOptions
RolePosition
RoleSelectMenuComponentData
RoleSubscriptionData
RoleTagData
SelectMenuComponentOptionData
SetChannelPositionOptions
SetParentOptions
SetRolePositionOptions
ShardEventTypes
ShardingManagerOptions
StageInstanceCreateOptions
StageInstanceEditOptions
StartThreadOptions
StickerPackFetchOptions
StringMappedInteractionTypes
StringSelectMenuComponentData
SweeperDefinitions
SweepOptions
TextBasedChannelFields
TextInputComponentData
TextInputModalData
ThreadChannel
ThreadEditOptions
ThreadOnlyChannel
User
UserApplicationCommandData
UserEntitlementCreateOptions
UserSelectMenuComponentData
Vanity
VoiceStateEditOptions
Webhook
WebhookClient
WebhookClientDataIdWithToken
WebhookClientDataURL
WebhookClientOptions
WebhookCreateOptions
WebhookDeleteOptions
WebhookEditOptions
WebhookFetchMessageOptions
WebhookMessageCreateOptions
WebhookMessageEditOptions
WelcomeChannelData
WelcomeScreenEditOptions
WidgetActivity
WidgetChannel
Types
ActionRowComponent
ActionRowComponentData
ActionRowComponentOptions
ActivityFlagsString
AllowedPartial
AllowedThreadTypeForAnnouncementChannel
AllowedThreadTypeForTextChannel
AnnouncementChannelResolvable
AnyComponent
AnyThreadChannel
ApplicationCommandData
ApplicationCommandDataResolvable
ApplicationCommandOption
ApplicationCommandOptionData
ApplicationCommandPermissionIdResolvable
ApplicationCommandResolvable
ApplicationFlagsResolvable
ApplicationFlagsString
ApplicationResolvable
AttachmentFlagsString
AuditLogChange
AutoModerationRuleResolvable
Base64Resolvable
Base64String
BitFieldResolvable
BooleanCache
BufferResolvable
ButtonComponentData
CacheConstructors
CacheFactory
CacheType
CacheTypeReducer
CacheWithLimitsOptions
CategoryChannelResolvable
CategoryChannelType
CategoryChildChannel
Channel
ChannelFlagsResolvable
ChannelFlagsString
ChannelMention
ChannelPermissionConstant
ChannelResolvable
ClientPresenceStatus
ClientStatus
CollectedInteraction
CollectedMessageInteraction
CollectionSweepFilter
CollectorFilter
ColorResolvable
CommandOptionChannelResolvableType
CommandOptionChoiceResolvableType
CommandOptionDataTypeResolvable
CommandOptionNonChoiceResolvableType
CommandOptionNumericResolvableType
CommandOptionSubOptionResolvableType
ComponentData
ComponentEmojiResolvable
Constructable
DateResolvable
EmojiIdentifierResolvable
EmojiResolvable
EntitlementResolvable
EnumLike
FetchThreadMembersOptions
ForumThreadChannel
GatewayIntentsString
GlobalSweepFilter
GuildAuditLogsActionType
GuildAuditLogsResolvable
GuildAuditLogsTargets
GuildAuditLogsTargetType
GuildBanResolvable
GuildBasedChannel
GuildCacheMessage
GuildChannelResolvable
GuildChannelTypes
GuildInvitableChannelResolvable
GuildMemberFlagsResolvable
GuildMemberFlagsString
GuildMemberResolvable
GuildResolvable
GuildScheduledEventManagerFetchResult
GuildScheduledEventManagerFetchSubscribersResult
GuildScheduledEventResolvable
GuildScheduledEventSetStatusArg
GuildTemplateResolvable
GuildTextBasedChannel
GuildTextBasedChannelTypes
GuildTextChannelResolvable
GuildVoiceChannelResolvable
HexColorString
If
IntegrationType
IntegrationTypesConfiguration
IntegrationTypesConfigurationParameters
Interaction
InviteResolvable
MappedGuildChannelTypes
MessageActionRowComponent
MessageActionRowComponentData
MessageActionRowComponentResolvable
MessageComponent
MessageComponentType
MessageFlagsString
MessageMentionTypes
MessagePayloadOption
MessageReactionResolvable
MessageResolvable
MessageTarget
ModalActionRowComponent
ModalActionRowComponentData
NonSystemMessageType
NonThreadGuildBasedChannel
OmitPartialGroupDMChannel
OverwriteResolvable
Partialize
PermissionFlags
PermissionOverwriteOptions
PermissionOverwriteResolvable
PermissionResolvable
PermissionsString
PresenceResolvable
PresenceStatus
PresenceStatusData
RepliableInteraction
RoleFlagsString
RoleMention
RolePermissionConstant
RoleResolvable
SelectMenuInteraction
SelectMenuType
SendableChannels
SendableChannelTypes
Serialized
ShardingManagerMode
SKUFlagsString
SKUResolvable
StageChannelResolvable
StageInstanceResolvable
StickerResolvable
SweeperKey
SweeperOptions
SystemChannelFlagsResolvable
SystemChannelFlagsString
TextBasedChannel
TextBasedChannelResolvable
TextBasedChannels
TextBasedChannelTypes
TextChannelResolvable
TextThreadChannel
ThreadChannelResolvable
ThreadChannelType
ThreadMemberFlagsString
ThreadMemberResolvable
UndeletableMessageType
UserFlagsString
UserMention
UserResolvable
VoiceBasedChannel
VoiceBasedChannelTypes
VoiceChannelResolvable
WebhookClientData
WrapBooleanCache
Variables
Colors
Constants
version
Embed
export class
Embed
export class
Embed
Summary
Represents an embed.
Properties
Readonly
author
:
EmbedAuthorData
|
null
The author of this embed.
Readonly
color
:
number
|
null
The color of this embed.
Readonly
data
:
Readonly
<
APIEmbed
>
The API embed data.
Readonly
description
:
string
|
null
The description of this embed.
Readonly
fields
:
APIEmbedField
[]
An array of fields of this embed.
Readonly
footer
:
EmbedFooterData
|
null
The footer of this embed.
Readonly
hexColor
:
string
|
null
The hex color of this embed.
Readonly
image
:
EmbedAssetData
|
null
The image of this embed.
Readonly
length
:
number
The accumulated length for the embed title, description, fields, footer text, and author name.
Readonly
provider
:
APIEmbedProvider
|
null
The provider of this embed.
Readonly
thumbnail
:
EmbedAssetData
|
null
The thumbnail of this embed.
Readonly
timestamp
:
string
|
null
The timestamp of this embed. This is in an ISO 8601 format.
Readonly
title
:
string
|
null
The title of this embed.
Readonly
url
:
string
|
null
The URL of this embed.
Readonly
video
:
EmbedAssetData
|
null
The video of this embed.
Methods
equals(other)
:
boolean
Whether the given embeds are equal.
Parameters
Name
Type
Optional
Description
other
Embed
|
APIEmbed
No
The embed to compare against
toJSON()
:
APIEmbed
Returns the API-compatible JSON for this embed.