@buape/carbon 0.1.0

package/docs/classes/BaseGuildTextChannel.mdx

@@ -0,0 +1,360 @@
+---
+title: BaseGuildTextChannel
+---
+
+## Extends
+
+- [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel)\<`Type`\>
+
+## Extended by
+
+- [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel)
+- [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel)
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `Type` *extends* `GuildTextChannelType` |
+
+## Constructors
+
+### new BaseGuildTextChannel()
+
+> **new BaseGuildTextChannel**\<`Type`\>(`client`, `rawDataOrId`): [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel)\<`Type`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) |
+| `rawDataOrId` | `string` \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGroupDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildCategoryChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildForumChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildMediaChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildStageVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APINewsChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APITextChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIThreadChannel`, `object`\> |
+
+#### Returns
+
+[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel)\<`Type`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`constructor`](/carbon/api/classes/BaseGuildChannel#constructors)
+
+## Properties
+
+| Property | Modifier | Type | Default value | Description | Inherited from |
+| ------ | ------ | ------ | ------ | ------ | ------ |
+| `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`client` |
+| `flags?` | `public` | `null` \| `number` | `undefined` | The flags of the channel in a bitfield. **See** https://discord.com/developers/docs/resources/channel#channel-object-channel-flags | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`flags` |
+| `guildId?` | `public` | `string` | `undefined` | The ID of the guild this channel is in | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`guildId` |
+| `id` | `public` | `string` | `undefined` | The id of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`id` |
+| `lastMessageId?` | `public` | `null` \| `string` | `undefined` | The ID of the last message sent in the channel. **Remarks** This might not always resolve to a message. The ID still stays a part of the channel's data, even if the message is deleted. | - |
+| `lastPinTimestamp?` | `public` | `null` \| `string` | `undefined` | The timestamp of the last pin in the channel. | - |
+| `name?` | `public` | `string` | `undefined` | The name of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`name` |
+| `nsfw?` | `public` | `boolean` | `undefined` | Whether the channel is marked as nsfw. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`nsfw` |
+| `parentId?` | `public` | `null` \| `string` | `undefined` | The ID of the parent category for the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`parentId` |
+| `partial` | `public` | `boolean` | `undefined` | Whether the channel is a partial channel (meaning it does not have all the data). If this is true, you should use [BaseChannel.fetch](/carbon/api/classes/BaseChannel#fetch) to get the full data of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`partial` |
+| `position?` | `public` | `number` | `undefined` | The position of the channel in the channel list. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`position` |
+| `rateLimitPerUser?` | `public` | `null` \| `number` | `undefined` | The rate limit per user for the channel, in seconds. | - |
+| `rawData` | `protected` | `null` \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGroupDMChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildCategoryChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildForumChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildMediaChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildStageVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIGuildVoiceChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APINewsChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APITextChannel`, `object`\> \| [`Extract`](https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union)\<`APIThreadChannel`, `object`\> | `null` | The raw data of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`rawData` |
+| `type?` | `public` | `Type` | `undefined` | The type of the channel. | [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).`type` |
+
+## Accessors
+
+### guild
+
+> `get` **guild**(): [`Guild`](/carbon/api/classes/Guild)
+
+The guild this channel is in
+
+#### Returns
+
+[`Guild`](/carbon/api/classes/Guild)
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`guild`](/carbon/api/classes/BaseGuildChannel#guild)
+
+***
+
+### lastMessage
+
+> `get` **lastMessage**(): `null` \| [`Message`](/carbon/api/classes/Message)
+
+The last message sent in the channel.
+
+#### Remarks
+
+This might not always resolve to a message. The ID still stays a part of the channel's data, even if the message is deleted.
+This will always return a partial message, so you can use [Message.fetch](/carbon/api/classes/Message#fetch) to get the full message data.
+
+#### Returns
+
+`null` \| [`Message`](/carbon/api/classes/Message)
+
+## Methods
+
+### createInvite()
+
+> **createInvite**(`options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
+
+Create an invite for the channel
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options`? | `RESTPostAPIChannelInviteJSONBody` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`APIExtendedInvite`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`createInvite`](/carbon/api/classes/BaseGuildChannel#createinvite)
+
+***
+
+### fetch()
+
+> **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Fetches the channel from the API.
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+The channel data.
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`fetch`](/carbon/api/classes/BaseGuildChannel#fetch)
+
+***
+
+### getInvites()
+
+> **getInvites**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
+
+Get the invites for the channel
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`RESTGetAPIGuildInvitesResult`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`getInvites`](/carbon/api/classes/BaseGuildChannel#getinvites)
+
+***
+
+### getPinnedMessages()
+
+> **getPinnedMessages**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Message`](/carbon/api/classes/Message)[]\>
+
+Get the pinned messages in the channel
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Message`](/carbon/api/classes/Message)[]\>
+
+***
+
+### send()
+
+> **send**(`message`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Send a message to the channel
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `APIMessage` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`send`](/carbon/api/classes/BaseGuildChannel#send)
+
+***
+
+### setData()
+
+> `protected` **setData**(`data`): `void`
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `APIGuildChannel`\<`Type`\> |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setData`](/carbon/api/classes/BaseGuildChannel#setdata)
+
+***
+
+### setMoreSpecificData()
+
+> `abstract` `protected` **setMoreSpecificData**(`data`): `void`
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `APIGuildTextChannel`\<`Type`\> |
+
+#### Returns
+
+`void`
+
+***
+
+### setName()
+
+> **setName**(`name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the name of the channel
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `name` | `string` | The new name of the channel |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setName`](/carbon/api/classes/BaseGuildChannel#setname)
+
+***
+
+### setNsfw()
+
+> **setNsfw**(`nsfw`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set whether the channel is nsfw
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `nsfw` | `boolean` | The new nsfw status of the channel |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setNsfw`](/carbon/api/classes/BaseGuildChannel#setnsfw)
+
+***
+
+### setParent()
+
+> **setParent**(`parent`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the parent ID of the channel
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `parent` | `string` \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) | The new category channel or ID to set |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setParent`](/carbon/api/classes/BaseGuildChannel#setparent)
+
+***
+
+### setPosition()
+
+> **setPosition**(`position`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the position of the channel
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `position` | `number` | The new position of the channel |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setPosition`](/carbon/api/classes/BaseGuildChannel#setposition)
+
+***
+
+### setSpecificData()
+
+> `protected` **setSpecificData**(`data`): `void`
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `APIGuildTextChannel`\<`Type`\> |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`setSpecificData`](/carbon/api/classes/BaseGuildChannel#setspecificdata)
+
+***
+
+### startThread()
+
+> **startThread**(`data`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\>\>
+
+Start a thread without an associated start message.
+If you want to start a thread with a start message, use [Message.startThread](/carbon/api/classes/Message#startthread)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `RESTPostAPIChannelThreadsJSONBody` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\>\>
+
+***
+
+### triggerTyping()
+
+> **triggerTyping**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Trigger a typing indicator in the channel (this will expire after 10 seconds)
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel).[`triggerTyping`](/carbon/api/classes/BaseGuildChannel#triggertyping)

package/docs/classes/BaseInteraction.mdx

@@ -0,0 +1,127 @@
+---
+title: BaseInteraction
+---
+
+This is the base type interaction, all interaction types extend from this
+
+## Extends
+
+- `Base`
+
+## Extended by
+
+- [`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction)
+- [`AutocompleteInteraction`](/carbon/api/classes/AutocompleteInteraction)
+- [`CommandInteraction`](/carbon/api/classes/CommandInteraction)
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* `APIInteraction` |
+
+## Constructors
+
+### new BaseInteraction()
+
+> **new BaseInteraction**\<`T`\>(`client`, `data`): [`BaseInteraction`](/carbon/api/classes/BaseInteraction)\<`T`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) |
+| `data` | `T` |
+
+#### Returns
+
+[`BaseInteraction`](/carbon/api/classes/BaseInteraction)\<`T`\>
+
+#### Overrides
+
+`Base.constructor`
+
+## Properties
+
+| Property | Type | Default value | Description | Inherited from |
+| ------ | ------ | ------ | ------ | ------ |
+| `_deferred` | `boolean` | `false` | **`Internal`** Whether the interaction is deferred already | - |
+| `client` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | `Base.client` |
+| `rawData` | `T` | `undefined` | The raw data of the interaction | - |
+| `type` | `InteractionType` | `undefined` | The type of interaction | - |
+| `userId` | `undefined` \| `string` | `undefined` | The user who sent the interaction | - |
+
+## 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)
+
+***
+
+### guild
+
+> `get` **guild**(): `null` \| [`Guild`](/carbon/api/classes/Guild)
+
+#### Returns
+
+`null` \| [`Guild`](/carbon/api/classes/Guild)
+
+***
+
+### message
+
+> `get` **message**(): `null` \| [`Message`](/carbon/api/classes/Message)
+
+#### Returns
+
+`null` \| [`Message`](/carbon/api/classes/Message)
+
+***
+
+### user
+
+> `get` **user**(): `null` \| [`User`](/carbon/api/classes/User)
+
+#### Returns
+
+`null` \| [`User`](/carbon/api/classes/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`\>
+
+***
+
+### 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`\>

package/docs/classes/Button.mdx

@@ -0,0 +1,99 @@
+---
+title: Button
+---
+
+## Extends
+
+- `BaseButton`
+
+## Constructors
+
+### new Button()
+
+> **new Button**(`data`?): [`Button`](/carbon/api/classes/Button)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data`? | `object` |
+| `data.additionalData`? | [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) |
+
+#### Returns
+
+[`Button`](/carbon/api/classes/Button)
+
+#### Inherited from
+
+`BaseButton.constructor`
+
+## Properties
+
+| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
+| `additionalData` | `public` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | `null` | - | - | `BaseButton.additionalData` |
+| `customId` | `abstract` | `string` | `undefined` | The custom ID of the component | - | `BaseButton.customId` |
+| `defer` | `public` | `boolean` | `false` | Whether the component response should be automatically deferred | - | `BaseButton.defer` |
+| `disabled` | `public` | `boolean` | `false` | The disabled state of the button | - | `BaseButton.disabled` |
+| `emoji?` | `public` | `object` | `undefined` | The emoji of the button | - | `BaseButton.emoji` |
+| `emoji.animated?` | `public` | `boolean` | `undefined` | - | - | - |
+| `emoji.id?` | `public` | `string` | `undefined` | - | - | - |
+| `emoji.name` | `public` | `string` | `undefined` | - | - | - |
+| `ephemeral` | `public` | `boolean` | `false` | Whether the component response should be ephemeral | - | `BaseButton.ephemeral` |
+| `label` | `abstract` | `string` | `undefined` | The label of the button | - | `BaseButton.label` |
+| `style` | `abstract` | `Primary` \| `Secondary` \| `Success` \| `Danger` | `undefined` | The style of the button | `BaseButton.style` | - |
+| `type` | `public` | `ComponentType` | `ComponentType.Button` | The type of the component | - | `BaseButton.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
+
+`BaseButton.createId`
+
+***
+
+### run()
+
+> `abstract` **run**(`interaction`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `interaction` | [`ButtonInteraction`](/carbon/api/classes/ButtonInteraction) |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### serialize()
+
+> **serialize**(): `APIButtonComponent`
+
+#### Returns
+
+`APIButtonComponent`
+
+#### Overrides
+
+`BaseButton.serialize`