@buape/carbon 0.1.0

package/docs/classes/ButtonInteraction.mdx

@@ -0,0 +1,141 @@
+---
+title: ButtonInteraction
+---
+
+This is the base type interaction, all interaction types extend from this
+
+## Extends
+
+- [`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction)
+
+## Constructors
+
+### new ButtonInteraction()
+
+> **new ButtonInteraction**(`client`, `data`): [`ButtonInteraction`](/carbon/api/classes/ButtonInteraction)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) |
+| `data` | `APIMessageComponentButtonInteraction` |
+
+#### Returns
+
+[`ButtonInteraction`](/carbon/api/classes/ButtonInteraction)
+
+#### Overrides
+
+[`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).[`constructor`](/carbon/api/classes/BaseComponentInteraction#constructors)
+
+## Properties
+
+| Property | Type | Default value | Description | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ | ------ | ------ |
+| `_deferred` | `boolean` | `false` | **`Internal`** Whether the interaction is deferred already | - | [`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).`_deferred` |
+| `client` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | - | [`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).`client` |
+| `componentType` | `ComponentType` | `undefined` | - | - | [`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).`componentType` |
+| `customId` | `string` | `undefined` | - | [`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).`customId` | - |
+| `rawData` | `APIMessageComponentInteraction` | `undefined` | The raw data of the interaction | - | [`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).`rawData` |
+| `type` | `InteractionType` | `undefined` | The type of interaction | - | [`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).`type` |
+| `userId` | `undefined` \| `string` | `undefined` | The user who sent the interaction | - | [`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).`userId` |
+
+## Accessors
+
+### channel
+
+> `get` **channel**(): `null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)
+
+#### Returns
+
+`null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)
+
+#### Inherited from
+
+[`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).[`channel`](/carbon/api/classes/BaseComponentInteraction#channel)
+
+***
+
+### guild
+
+> `get` **guild**(): `null` \| [`Guild`](/carbon/api/classes/Guild)
+
+#### Returns
+
+`null` \| [`Guild`](/carbon/api/classes/Guild)
+
+#### Inherited from
+
+[`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).[`guild`](/carbon/api/classes/BaseComponentInteraction#guild)
+
+***
+
+### message
+
+> `get` **message**(): `null` \| [`Message`](/carbon/api/classes/Message)
+
+#### Returns
+
+`null` \| [`Message`](/carbon/api/classes/Message)
+
+#### Inherited from
+
+[`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).[`message`](/carbon/api/classes/BaseComponentInteraction#message)
+
+***
+
+### user
+
+> `get` **user**(): `null` \| [`User`](/carbon/api/classes/User)
+
+#### Returns
+
+`null` \| [`User`](/carbon/api/classes/User)
+
+#### Inherited from
+
+[`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).[`user`](/carbon/api/classes/BaseComponentInteraction#user)
+
+## Methods
+
+### defer()
+
+> **defer**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+**`Internal`**
+
+Defer the interaction response. This is used automatically by commands that are set to defer.
+If the interaction is already deferred, this will do nothing.
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).[`defer`](/carbon/api/classes/BaseComponentInteraction#defer)
+
+***
+
+### reply()
+
+> **reply**(`data`, `options`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Reply to an interaction.
+If the interaction is deferred, this will edit the original response.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | [`InteractionReplyData`](/carbon/api/type-aliases/InteractionReplyData) | The response data |
+| `options` | [`InteractionReplyOptions`](/carbon/api/type-aliases/InteractionReplyOptions) | - |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).[`reply`](/carbon/api/classes/BaseComponentInteraction#reply)

package/docs/classes/ChannelSelectMenu.mdx

@@ -0,0 +1,122 @@
+---
+title: ChannelSelectMenu
+---
+
+## Extends
+
+- [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu)
+
+## Constructors
+
+### new ChannelSelectMenu()
+
+> **new ChannelSelectMenu**(`data`?): [`ChannelSelectMenu`](/carbon/api/classes/ChannelSelectMenu)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data`? | `object` |
+| `data.additionalData`? | [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) |
+
+#### Returns
+
+[`ChannelSelectMenu`](/carbon/api/classes/ChannelSelectMenu)
+
+#### Inherited from
+
+[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`constructor`](/carbon/api/classes/AnySelectMenu#constructors)
+
+## Properties
+
+| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
+| `additionalData` | `public` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | `null` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`additionalData` |
+| `channelTypes?` | `public` | `ChannelType`[] | `undefined` | - | - | - |
+| `customId` | `abstract` | `string` | `undefined` | The custom ID of the component | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`customId` |
+| `defaultValues?` | `public` | `APISelectMenuDefaultValue`\<`Channel`\>[] | `undefined` | - | - | - |
+| `defer` | `public` | `boolean` | `false` | Whether the component response should be automatically deferred | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`defer` |
+| `disabled?` | `public` | `boolean` | `undefined` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`disabled` |
+| `ephemeral` | `public` | `boolean` | `false` | Whether the component response should be ephemeral | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`ephemeral` |
+| `maxValues?` | `public` | `number` | `undefined` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`maxValues` |
+| `minValues?` | `public` | `number` | `undefined` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`minValues` |
+| `placeholder?` | `public` | `string` | `undefined` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`placeholder` |
+| `type` | `public` | `ChannelSelect` | `ComponentType.ChannelSelect` | The type of the component | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`type` | - |
+
+## Methods
+
+### createId()
+
+> **createId**(`additionalData`): `string`
+
+Create a custom ID to use for this component that embeds additional data that you want to be handed
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `additionalData` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | The additional data that you want to be passed in this component's custom ID |
+
+#### Returns
+
+`string`
+
+The custom ID to use
+
+#### Inherited from
+
+[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`createId`](/carbon/api/classes/AnySelectMenu#createid)
+
+***
+
+### run()
+
+> `abstract` **run**(`interaction`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `interaction` | [`ChannelSelectMenuInteraction`](/carbon/api/classes/ChannelSelectMenuInteraction) |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Overrides
+
+[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`run`](/carbon/api/classes/AnySelectMenu#run)
+
+***
+
+### serialize()
+
+> **serialize**(): `APISelectMenuComponent`
+
+#### Returns
+
+`APISelectMenuComponent`
+
+#### Inherited from
+
+[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`serialize`](/carbon/api/classes/AnySelectMenu#serialize)
+
+***
+
+### serializeOptions()
+
+> **serializeOptions**(): `object`
+
+#### Returns
+
+`object`
+
+| Name | Type |
+| ------ | ------ |
+| `channel_types` | `undefined` \| `ChannelType`[] |
+| `default_values` | `undefined` \| `APISelectMenuDefaultValue`\<`Channel`\>[] |
+| `type` | `ChannelSelect` |
+
+#### Overrides
+
+[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`serializeOptions`](/carbon/api/classes/AnySelectMenu#serializeoptions)

package/docs/classes/ChannelSelectMenuInteraction.mdx

@@ -0,0 +1,157 @@
+---
+title: ChannelSelectMenuInteraction
+---
+
+This is the base type interaction, all interaction types extend from this
+
+## Extends
+
+- [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction)
+
+## Constructors
+
+### new ChannelSelectMenuInteraction()
+
+> **new ChannelSelectMenuInteraction**(`client`, `data`): [`ChannelSelectMenuInteraction`](/carbon/api/classes/ChannelSelectMenuInteraction)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) |
+| `data` | `APIMessageComponentSelectMenuInteraction` |
+
+#### Returns
+
+[`ChannelSelectMenuInteraction`](/carbon/api/classes/ChannelSelectMenuInteraction)
+
+#### Overrides
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`constructor`](/carbon/api/classes/AnySelectMenuInteraction#constructors)
+
+## Properties
+
+| Property | Type | Default value | Description | Inherited from |
+| ------ | ------ | ------ | ------ | ------ |
+| `_deferred` | `boolean` | `false` | **`Internal`** Whether the interaction is deferred already | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`_deferred` |
+| `client` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`client` |
+| `componentType` | `ComponentType` | `undefined` | - | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`componentType` |
+| `customId` | `string` | `undefined` | - | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`customId` |
+| `rawData` | `APIMessageComponentInteraction` | `undefined` | The raw data of the interaction | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`rawData` |
+| `type` | `InteractionType` | `undefined` | The type of interaction | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`type` |
+| `userId` | `undefined` \| `string` | `undefined` | The user who sent the interaction | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`userId` |
+
+## Accessors
+
+### channel
+
+> `get` **channel**(): `null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)
+
+#### Returns
+
+`null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`channel`](/carbon/api/classes/AnySelectMenuInteraction#channel)
+
+***
+
+### guild
+
+> `get` **guild**(): `null` \| [`Guild`](/carbon/api/classes/Guild)
+
+#### Returns
+
+`null` \| [`Guild`](/carbon/api/classes/Guild)
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`guild`](/carbon/api/classes/AnySelectMenuInteraction#guild)
+
+***
+
+### message
+
+> `get` **message**(): `null` \| [`Message`](/carbon/api/classes/Message)
+
+#### Returns
+
+`null` \| [`Message`](/carbon/api/classes/Message)
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`message`](/carbon/api/classes/AnySelectMenuInteraction#message)
+
+***
+
+### user
+
+> `get` **user**(): `null` \| [`User`](/carbon/api/classes/User)
+
+#### Returns
+
+`null` \| [`User`](/carbon/api/classes/User)
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`user`](/carbon/api/classes/AnySelectMenuInteraction#user)
+
+***
+
+### values
+
+> `get` **values**(): `string`[]
+
+The raw IDs of the selected options (either role/string/channel IDs or the IDs you provided in your options)
+
+#### Returns
+
+`string`[]
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`values`](/carbon/api/classes/AnySelectMenuInteraction#values)
+
+## Methods
+
+### defer()
+
+> **defer**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+**`Internal`**
+
+Defer the interaction response. This is used automatically by commands that are set to defer.
+If the interaction is already deferred, this will do nothing.
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`defer`](/carbon/api/classes/AnySelectMenuInteraction#defer)
+
+***
+
+### reply()
+
+> **reply**(`data`, `options`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Reply to an interaction.
+If the interaction is deferred, this will edit the original response.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | [`InteractionReplyData`](/carbon/api/type-aliases/InteractionReplyData) | The response data |
+| `options` | [`InteractionReplyOptions`](/carbon/api/type-aliases/InteractionReplyOptions) | - |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`reply`](/carbon/api/classes/AnySelectMenuInteraction#reply)

package/docs/classes/Client.mdx

@@ -0,0 +1,48 @@
+---
+title: Client
+---
+
+The main client used to interact with Discord
+
+## Constructors
+
+### new Client()
+
+> **new Client**(`options`, `commands`): [`Client`](/carbon/api/classes/Client)
+
+Creates a new client
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`ClientOptions`](/carbon/api/type-aliases/ClientOptions) | The options used to initialize the client |
+| `commands` | [`BaseCommand`](/carbon/api/classes/BaseCommand)[] | The commands that the client has registered |
+
+#### Returns
+
+[`Client`](/carbon/api/classes/Client)
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `commandHandler` | [`CommandHandler`](/carbon/api/classes/CommandHandler) | - |
+| `commands` | [`BaseCommand`](/carbon/api/classes/BaseCommand)[] | The commands that the client has registered |
+| `componentHandler` | [`ComponentHandler`](/carbon/api/classes/ComponentHandler) | The handler for the component interactions sent from Discord |
+| `options` | [`ClientOptions`](/carbon/api/type-aliases/ClientOptions) | The options used to initialize the client |
+| `rest` | `RequestClient` | The rest client used to interact with the Discord API |
+| `router` | `AutoRouterType`\<`IRequestStrict`, `any`[], `any`\> | The router used to handle requests |
+
+## Methods
+
+### deployCommands()
+
+> **deployCommands**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Deploy the commands registered to Discord.
+This is automatically called when running in NodeJS mode.
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

package/docs/classes/Command.mdx

@@ -0,0 +1,111 @@
+---
+title: Command
+---
+
+Represents a standard command that the user creates
+
+## Extends
+
+- [`BaseCommand`](/carbon/api/classes/BaseCommand)
+
+## Constructors
+
+### new Command()
+
+> **new Command**(): [`Command`](/carbon/api/classes/Command)
+
+#### Returns
+
+[`Command`](/carbon/api/classes/Command)
+
+#### Inherited from
+
+[`BaseCommand`](/carbon/api/classes/BaseCommand).[`constructor`](/carbon/api/classes/BaseCommand#constructors)
+
+## Properties
+
+| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
+| `components?` | `public` | [`BaseComponent`](/carbon/api/classes/BaseComponent)[] | `[]` | All the components that the command is able to use. You mount these here so the handler can access them | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`components` |
+| `contexts` | `public` | `InteractionContextType`[] | `undefined` | **`Beta`** The contexts this command can be used in API types are not finalized | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`contexts` |
+| `defer` | `public` | `boolean` | `false` | Whether the command response should be automatically deferred | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`defer` |
+| `description` | `abstract` | `string` | `undefined` | A description of the command | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`description` |
+| `ephemeral` | `public` | `boolean` | `false` | Whether the command response should be ephemeral | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`ephemeral` |
+| `integrationTypes` | `public` | `ApplicationIntegrationType`[] | `undefined` | **`Beta`** The places this command can be used in API types are not finalized | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`integrationTypes` |
+| `name` | `abstract` | `string` | `undefined` | The name of the command (e.g. "ping" for /ping) | - | [`BaseCommand`](/carbon/api/classes/BaseCommand).`name` |
+| `options?` | `public` | [`CommandOptions`](/carbon/api/type-aliases/CommandOptions) | `undefined` | The options that the user passes along with the command in Discord | - | - |
+| `type` | `public` | `ApplicationCommandType` | `ApplicationCommandType.ChatInput` | The type of command, either ChatInput, User, or Message. User and Message are context menu commands. **Default** `ChatInput` | [`BaseCommand`](/carbon/api/classes/BaseCommand).`type` | - |
+
+## Methods
+
+### autocomplete()
+
+> **autocomplete**(`interaction`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+The function that is called when the command's autocomplete is triggered.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `interaction` | [`AutocompleteInteraction`](/carbon/api/classes/AutocompleteInteraction) | The interaction that triggered the autocomplete |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Remarks
+
+You are expected to `override` this function to provide your own autocomplete functionality.
+
+***
+
+### run()
+
+> `abstract` **run**(`interaction`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+The function that is called when the command is ran
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `interaction` | [`CommandInteraction`](/carbon/api/classes/CommandInteraction) | The interaction that triggered the command |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### serialize()
+
+> **serialize**(): `RESTPostAPIChatInputApplicationCommandsJSONBody` \| `RESTPostAPIContextMenuApplicationCommandsJSONBody`
+
+**`Internal`**
+
+Serializes the command into a JSON object that can be sent to Discord
+
+#### Returns
+
+`RESTPostAPIChatInputApplicationCommandsJSONBody` \| `RESTPostAPIContextMenuApplicationCommandsJSONBody`
+
+#### Inherited from
+
+[`BaseCommand`](/carbon/api/classes/BaseCommand).[`serialize`](/carbon/api/classes/BaseCommand#serialize)
+
+***
+
+### serializeOptions()
+
+> **serializeOptions**(): `undefined` \| [`CommandOptions`](/carbon/api/type-aliases/CommandOptions)
+
+**`Internal`**
+
+#### Returns
+
+`undefined` \| [`CommandOptions`](/carbon/api/type-aliases/CommandOptions)
+
+#### Overrides
+
+[`BaseCommand`](/carbon/api/classes/BaseCommand).[`serializeOptions`](/carbon/api/classes/BaseCommand#serializeoptions)

package/docs/classes/CommandHandler.mdx

@@ -0,0 +1,65 @@
+---
+title: CommandHandler
+---
+
+## Extends
+
+- `Base`
+
+## Constructors
+
+### new CommandHandler()
+
+> **new CommandHandler**(`client`): [`CommandHandler`](/carbon/api/classes/CommandHandler)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) |
+
+#### Returns
+
+[`CommandHandler`](/carbon/api/classes/CommandHandler)
+
+#### Inherited from
+
+`Base.constructor`
+
+## Properties
+
+| Property | Type | Inherited from |
+| ------ | ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) | `Base.client` |
+
+## Methods
+
+### handleAutocompleteInteraction()
+
+> **handleAutocompleteInteraction**(`rawInteraction`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`false` \| `void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `rawInteraction` | `APIApplicationCommandAutocompleteInteraction` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`false` \| `void`\>
+
+***
+
+### handleCommandInteraction()
+
+> **handleCommandInteraction**(`rawInteraction`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`false` \| `void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `rawInteraction` | `APIApplicationCommandInteraction` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`false` \| `void`\>