@buape/carbon
Classes
| Class | Description |
|---|---|
| AnySelectMenu | - |
| AnySelectMenuInteraction | This is the base type interaction, all interaction types extend from this |
| ApplicationAuthorizedListener | Base 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. |
| ApplicationCommandPermissionsUpdateListener | Base 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. |
| AutocompleteInteraction | This is the base type interaction, all interaction types extend from this |
| AutocompleteOptionsHandler | This 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. |
| AutoModerationActionExecutionListener | Base 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. |
| AutoModerationRuleCreateListener | Base 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. |
| AutoModerationRuleDeleteListener | Base 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. |
| AutoModerationRuleUpdateListener | Base 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 | - |
| BaseCommand | Represents the base data of a command that the user creates |
| BaseComponent | - |
| BaseComponentInteraction | This is the base type interaction, all interaction types extend from this |
| BaseError | - |
| BaseGuildChannel | - |
| BaseGuildTextChannel | - |
| BaseInteraction | This is the base type interaction, all interaction types extend from this |
| BaseListener | Base 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. |
| BaseMessageInteractiveComponent | - |
| BaseModalComponent | - |
| Button | - |
| ButtonInteraction | This is the base type interaction, all interaction types extend from this |
| ChannelCreateListener | Base 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. |
| ChannelDeleteListener | Base 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. |
| ChannelPinsUpdateListener | Base 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 | - |
| ChannelSelectMenuInteraction | This is the base type interaction, all interaction types extend from this |
| ChannelUpdateListener | Base 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. |
| Client | The main client used to interact with Discord |
| Command | Represents a standard command that the user creates |
| CommandHandler | - |
| CommandInteraction | Represents a command interaction |
| CommandWithSubcommandGroups | Represents 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. |
| CommandWithSubcommands | Represents 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 | - |
| Container | - |
| DiscordError | - |
| DmChannel | Represents a DM between two users. |
| Embed | Represents an embed in a message. |
| EntitlementCreateListener | Base 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. |
| EntitlementDeleteListener | Base 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. |
| EntitlementUpdateListener | Base 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. |
| FieldsHandler | This 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. |
| File | Each file component can only display 1 attached file, but you can upload multiple files and add them to different file components within your payload. |
| GroupDmChannel | Represents a group DM channel. |
| Guild | - |
| GuildAnnouncementChannel | Represents a guild announcement channel. |
| GuildAuditLogEntryCreateListener | Base 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. |
| GuildBanAddListener | Base 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. |
| GuildBanRemoveListener | Base 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. |
| GuildCategoryChannel | Represents a guild category channel. |
| GuildCreateListener | Base 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. |
| GuildDeleteListener | Base 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. |
| GuildEmojisUpdateListener | Base 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. |
| GuildForumChannel | Represents a guild forum channel. |
| GuildIntegrationsUpdateListener | Base 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. |
| GuildMediaChannel | Represents a guild media channel (a forum channel) |
| GuildMember | - |
| GuildMemberAddListener | Base 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. |
| GuildMemberRemoveListener | Base 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. |
| GuildMembersChunkListener | Base 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. |
| GuildMemberUpdateListener | Base 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. |
| GuildRoleCreateListener | Base 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. |
| GuildRoleDeleteListener | Base 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. |
| GuildRoleUpdateListener | Base 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. |
| GuildScheduledEventCreateListener | Base 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. |
| GuildScheduledEventDeleteListener | Base 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. |
| GuildScheduledEventUpdateListener | Base 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. |
| GuildScheduledEventUserAddListener | Base 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. |
| GuildScheduledEventUserRemoveListener | Base 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. |
| GuildSoundboardSoundCreateListener | Base 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. |
| GuildSoundboardSoundDeleteListener | Base 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. |
| GuildSoundboardSoundsUpdateListener | Base 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. |
| GuildSoundboardSoundUpdateListener | Base 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 | - |
| GuildStickersUpdateListener | Base 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 | - |
| GuildUpdateListener | Base 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 | - |
| IntegrationCreateListener | Base 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. |
| IntegrationDeleteListener | Base 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. |
| IntegrationUpdateListener | Base 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 | - |
| MediaGallery | A media gallery component can display between 1 and 10 images. Each image can be a direct online URL or an attachment://<name> reference. |
| MentionableSelectMenu | - |
| MentionableSelectMenuInteraction | This is the base type interaction, all interaction types extend from this |
| Message | - |
| MessageCreateListener | Base 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. |
| MessagePollVoteAddListener | Base 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. |
| MessagePollVoteRemoveListener | Base 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. |
| MessageReactionAddListener | Base 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. |
| MessageReactionRemoveAllListener | Base 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. |
| MessageReactionRemoveEmojiListener | Base 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. |
| MessageReactionRemoveListener | Base 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. |
| MessageUpdateListener | Base 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 | - |
| ModalInteraction | This is the base type interaction, all interaction types extend from this |
| OptionsHandler | This 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. |
| Plugin | The base class for all plugins |
| PremiumButton | - |
| PresenceUpdateListener | Base 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. |
| QuestUserEnrollmentListener | Base 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. |
| RateLimitError | A RateLimitError is thrown when the bot is rate limited by Discord, and you don't have requests set to queue. |
| ReadyListener | Base 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. |
| RequestClient | This 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. |
| ResumedListener | Base 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 | - |
| RoleSelectMenuInteraction | This is the base type interaction, all interaction types extend from this |
| Row | - |
| Section | - |
| Separator | - |
| StageInstanceCreateListener | Base 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. |
| StageInstanceDeleteListener | Base 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. |
| StageInstanceUpdateListener | Base 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 | - |
| StringSelectMenuInteraction | This is the base type interaction, all interaction types extend from this |
| SubscriptionCreateListener | Base 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. |
| SubscriptionDeleteListener | Base 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. |
| SubscriptionUpdateListener | Base 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. |
| TextDisplay | - |
| TextInput | - |
| ThreadCreateListener | Base 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. |
| ThreadDeleteListener | Base 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. |
| ThreadListSyncListener | Base 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. |
| ThreadMembersUpdateListener | Base 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. |
| ThreadMemberUpdateListener | Base 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. |
| ThreadUpdateListener | Base 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. |
| Thumbnail | - |
| TypingStartListener | Base 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 | - |
| UserSelectMenuInteraction | This is the base type interaction, all interaction types extend from this |
| UserUpdateListener | Base 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. |
| VoiceChannelEffectSendListener | Base 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. |
| VoiceServerUpdateListener | Base 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. |
| VoiceStateUpdateListener | Base 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. |
| WebhooksUpdateListener | Base 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
| Interface | Description |
|---|---|
| ClientOptions | The options used for initializing the client |
| Context | - |
| Route | - |
| TransformedError | - |
Type Aliases
| Type Alias | Description |
|---|---|
| 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. |
| MessagePayloadFile | The data for a file to send in an interaction |
| QueuedRequest | - |
| RawOptions | - |
| RequestClientOptions | The options used to initialize the RequestClient |
| RequestData | - |
| TopLevelComponents | - |
Variables
| Variable | Description |
|---|---|
| GatewayEvent | - |
| ListenerEvent | - |
| Permission | - |
| subtleCrypto | - |
| WebhookEvent | - |
Functions
| Function | Description |
|---|---|
| channelFactory | - |
| concatUint8Arrays | - |
| errorMapper | - |
| serializePayload | - |
| splitCustomId | - |
| valueToUint8Array | - |