Carbon

@buape/carbon

Classes

ClassDescription
AnySelectMenu-
AnySelectMenuInteractionThis is the base type interaction, all interaction types extend from this
ApplicationAuthorizedListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
ApplicationCommandPermissionsUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
AutocompleteInteractionThis is the base type interaction, all interaction types extend from this
AutocompleteOptionsHandlerThis class is used to parse the options of a command, and provide errors for any missing or invalid options. It is used internally by the Command class.
AutoModerationActionExecutionListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
AutoModerationRuleCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
AutoModerationRuleDeleteListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
AutoModerationRuleUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
BaseChannel-
BaseCommandRepresents the base data of a command that the user creates
BaseComponent-
BaseComponentInteractionThis is the base type interaction, all interaction types extend from this
BaseError-
BaseGuildChannel-
BaseGuildTextChannel-
BaseInteractionThis is the base type interaction, all interaction types extend from this
BaseListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
Button-
ButtonInteractionThis is the base type interaction, all interaction types extend from this
ChannelCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
ChannelDeleteListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
ChannelPinsUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
ChannelSelectMenu-
ChannelSelectMenuInteractionThis is the base type interaction, all interaction types extend from this
ChannelUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
ClientThe main client used to interact with Discord
CommandRepresents a standard command that the user creates
CommandHandler-
CommandInteractionRepresents a command interaction
CommandWithSubcommandGroupsRepresents a subcommand group command that the user creates. You make this instead of a Command class when you want to have subcommand groups in your options.
CommandWithSubcommandsRepresents a subcommand command that the user creates. You make this instead of a Command class when you want to have subcommands in your options.
ComponentHandler-
DiscordError-
DmChannelRepresents a DM between two users.
EmbedRepresents an embed in a message.
EntitlementCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
EntitlementDeleteListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
EntitlementUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
FieldsHandlerThis class is used to parse the options of a command, and provide errors for any missing or invalid options. It is used internally by the Command class.
GroupDmChannelRepresents a group DM channel.
Guild-
GuildAnnouncementChannelRepresents a guild announcement channel.
GuildAuditLogEntryCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildBanAddListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildBanRemoveListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildCategoryChannelRepresents a guild category channel.
GuildCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildDeleteListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildEmojisUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildForumChannelRepresents a guild forum channel.
GuildIntegrationsUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildMediaChannelRepresents a guild media channel (a forum channel)
GuildMember-
GuildMemberAddListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildMemberRemoveListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildMembersChunkListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildMemberUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildRoleCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildRoleDeleteListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildRoleUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildScheduledEventCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildScheduledEventDeleteListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildScheduledEventUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildScheduledEventUserAddListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildScheduledEventUserRemoveListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildSoundboardSoundCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildSoundboardSoundDeleteListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildSoundboardSoundsUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildSoundboardSoundUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildStageChannel-
GuildStageOrVoiceChannel-
GuildStickersUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildTextChannel-
GuildThreadChannel-
GuildThreadOnlyChannel-
GuildUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
GuildVoiceChannel-
IntegrationCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
IntegrationDeleteListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
IntegrationUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
LinkButton-
MentionableSelectMenu-
MentionableSelectMenuInteractionThis is the base type interaction, all interaction types extend from this
Message-
MessageCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
MessagePollVoteAddListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
MessagePollVoteRemoveListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
MessageReactionAddListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
MessageReactionRemoveAllListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
MessageReactionRemoveEmojiListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
MessageReactionRemoveListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
MessageUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
Modal-
ModalHandler-
ModalInteractionThis is the base type interaction, all interaction types extend from this
OptionsHandlerThis class is used to parse the options of a command, and provide errors for any missing or invalid options. It is used internally by the Command class.
PluginThe base class for all plugins
PremiumButton-
PresenceUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
QuestUserEnrollmentListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
RateLimitErrorA RateLimitError is thrown when the bot is rate limited by Discord, and you don't have requests set to queue.
ReadyListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
RequestClientThis is the main class that handles making requests to the Discord API. It is used internally by Carbon, and you should not need to use it directly, but feel free to if you feel like living dangerously.
ResumedListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
Role-
RoleSelectMenu-
RoleSelectMenuInteractionThis is the base type interaction, all interaction types extend from this
Row-
StageInstanceCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
StageInstanceDeleteListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
StageInstanceUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
StringSelectMenu-
StringSelectMenuInteractionThis is the base type interaction, all interaction types extend from this
SubscriptionCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
SubscriptionDeleteListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
SubscriptionUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
TextInput-
ThreadCreateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
ThreadDeleteListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
ThreadListSyncListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
ThreadMembersUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
ThreadMemberUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
ThreadUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
TypingStartListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
User-
UserSelectMenu-
UserSelectMenuInteractionThis is the base type interaction, all interaction types extend from this
UserUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
VoiceChannelEffectSendListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
VoiceServerUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
VoiceStateUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.
WebhooksUpdateListenerBase class for creating event listeners that handle Discord gateway events. This abstract class defines the structure for event listeners and provides type safety for event handling.

Interfaces

InterfaceDescription
ClientOptionsThe options used for initializing the client
Context-
Route-
TransformedError-

Type Aliases

Type AliasDescription
AllowedMentions-
AnyChannel-
AnySelectMenuComponentType-
ArrayOrSingle-
CommandOptions-
ComponentAdditionalData-
DiscordRawError-
IfPartial-
InteractionDefaults-
ListenerEventData-
ListenerEventRawData-
ListenerEventType-
MessagePayload/** * The data that is sent to Discord when sending a message. * If you pass just a string, it will be treated as the content of the message.
MessagePayloadFileThe data for a file to send in an interaction
QueuedRequest-
RawOptions-
RequestClientOptionsThe options used to initialize the RequestClient
RequestData-

Variables

Functions

On this page