@buape/carbon 0.2.0 → 0.3.1

package/docs/classes/BaseComponentInteraction.mdx

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

package/docs/classes/BaseGuildChannel.mdx

@@ -1,262 +0,0 @@
----
-title: BaseGuildChannel
----
-
-## Extends
-
-- [`BaseChannel`](/carbon/api/classes/BaseChannel)\<`Type`\>
-
-## Extended by
-
-- [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel)
-- [`GuildThreadOnlyChannel`](/carbon/api/classes/GuildThreadOnlyChannel)
-- [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel)
-- [`GuildStageOrVoiceChannel`](/carbon/api/classes/GuildStageOrVoiceChannel)
-- [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel)
-- [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel)
-- [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)
-
-## Type Parameters
-
-| Type Parameter |
-| ------ |
-| `Type` *extends* `GuildChannelType` |
-
-## Constructors
-
-### new BaseGuildChannel()
-
-> **new BaseGuildChannel**\<`Type`\>(`client`, `rawDataOrId`): [`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel)\<`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
-
-[`BaseGuildChannel`](/carbon/api/classes/BaseGuildChannel)\<`Type`\>
-
-#### Inherited from
-
-[`BaseChannel`](/carbon/api/classes/BaseChannel).[`constructor`](/carbon/api/classes/BaseChannel#constructors)
-
-## Properties
-
-| Property | Modifier | Type | Default value | Description | Inherited from |
-| ------ | ------ | ------ | ------ | ------ | ------ |
-| `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`BaseChannel`](/carbon/api/classes/BaseChannel).`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 | [`BaseChannel`](/carbon/api/classes/BaseChannel).`flags` |
-| `guildId?` | `public` | `string` | `undefined` | The ID of the guild this channel is in | - |
-| `id` | `public` | `string` | `undefined` | The id of the channel. | [`BaseChannel`](/carbon/api/classes/BaseChannel).`id` |
-| `name?` | `public` | `string` | `undefined` | The name of the channel. | - |
-| `nsfw?` | `public` | `boolean` | `undefined` | Whether the channel is marked as nsfw. | - |
-| `parentId?` | `public` | `null` \| `string` | `undefined` | The ID of the parent category for the channel. | - |
-| `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. | [`BaseChannel`](/carbon/api/classes/BaseChannel).`partial` |
-| `position?` | `public` | `number` | `undefined` | The position of the channel in the channel list. | - |
-| `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. | [`BaseChannel`](/carbon/api/classes/BaseChannel).`rawData` |
-| `type?` | `public` | `Type` | `undefined` | The type of the channel. | [`BaseChannel`](/carbon/api/classes/BaseChannel).`type` |
-
-## Accessors
-
-### guild
-
-> `get` **guild**(): [`Guild`](/carbon/api/classes/Guild)
-
-The guild this channel is in
-
-#### Returns
-
-[`Guild`](/carbon/api/classes/Guild)
-
-## 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`\>
-
-***
-
-### 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
-
-[`BaseChannel`](/carbon/api/classes/BaseChannel).[`fetch`](/carbon/api/classes/BaseChannel#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`\>
-
-***
-
-### 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`\>
-
-***
-
-### setData()
-
-> `protected` **setData**(`data`): `void`
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `data` | `APIGuildChannel`\<`Type`\> |
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[`BaseChannel`](/carbon/api/classes/BaseChannel).[`setData`](/carbon/api/classes/BaseChannel#setdata)
-
-***
-
-### 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`\>
-
-***
-
-### 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`\>
-
-***
-
-### 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`\>
-
-***
-
-### 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`\>
-
-***
-
-### setSpecificData()
-
-> `abstract` `protected` **setSpecificData**(`data`): `void`
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `data` | [`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
-
-`void`
-
-#### Inherited from
-
-[`BaseChannel`](/carbon/api/classes/BaseChannel).[`setSpecificData`](/carbon/api/classes/BaseChannel#setspecificdata)
-
-***
-
-### 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`\>