@buape/carbon 0.1.3 → 0.3.0

package/docs/classes/Guild.mdx

@@ -1,157 +0,0 @@
----
-title: Guild
----
-
-## Extends
-
-- `Base`
-
-## Constructors
-
-### new Guild()
-
-> **new Guild**(`client`, `rawDataOrId`): [`Guild`](/carbon/api/classes/Guild)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `client` | [`Client`](/carbon/api/classes/Client) |
-| `rawDataOrId` | `string` \| `APIGuild` |
-
-#### Returns
-
-[`Guild`](/carbon/api/classes/Guild)
-
-#### Overrides
-
-`Base.constructor`
-
-## Properties
-
-| Property | Type | Description | Inherited from |
-| ------ | ------ | ------ | ------ |
-| `client` | [`Client`](/carbon/api/classes/Client) | - | `Base.client` |
-| `description?` | `null` \| `string` | The description of the guild. | - |
-| `icon?` | `null` \| `string` | The icon hash of the guild. You can use [Guild.iconUrl](/carbon/api/classes/Guild#iconurl) to get the URL of the icon. | - |
-| `id` | `string` | The ID of the guild | - |
-| `name?` | `string` | The name of the guild. | - |
-| `ownerId?` | `string` | The ID of the owner of the guild. | - |
-| `partial` | `boolean` | Whether the guild is a partial guild (meaning it does not have all the data). If this is true, you should use [Guild.fetch](/carbon/api/classes/Guild#fetch) to get the full data of the guild. | - |
-| `splash?` | `null` \| `string` | The splash hash of the guild. You can use [Guild.splashUrl](/carbon/api/classes/Guild#splashurl) to get the URL of the splash. | - |
-
-## Accessors
-
-### iconUrl
-
-> `get` **iconUrl**(): `null` \| `string`
-
-Get the URL of the guild's icon
-
-#### Returns
-
-`null` \| `string`
-
-***
-
-### roles
-
-> `get` **roles**(): [`Role`](/carbon/api/classes/Role)[]
-
-Get all roles in the guild
-
-#### Returns
-
-[`Role`](/carbon/api/classes/Role)[]
-
-***
-
-### splashUrl
-
-> `get` **splashUrl**(): `null` \| `string`
-
-Get the URL of the guild's splash
-
-#### Returns
-
-`null` \| `string`
-
-## Methods
-
-### createRole()
-
-> **createRole**(`data`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Role`](/carbon/api/classes/Role)\>
-
-Create a role in the guild
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `data` | `RESTPostAPIGuildRoleJSONBody` |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Role`](/carbon/api/classes/Role)\>
-
-***
-
-### fetch()
-
-> **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
-
-Fetch updated data for this guild.
-If the guild is partial, this will fetch all the data for the guild and populate the fields.
-If the guild is not partial, all fields will be updated with new values from Discord.
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
-
-***
-
-### fetchChannel()
-
-> **fetchChannel**(`channelId`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`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)\>
-
-Fetch a channel from the guild by ID
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `channelId` | `string` |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`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)\>
-
-***
-
-### fetchMember()
-
-> **fetchMember**(`memberId`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`GuildMember`\>
-
-Get a member in the guild by ID
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `memberId` | `string` |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`GuildMember`\>
-
-***
-
-### leave()
-
-> **leave**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`unknown`\>
-
-Leave the guild
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`unknown`\>

package/docs/classes/GuildAnnouncementChannel.mdx

@@ -1,377 +0,0 @@
----
-title: GuildAnnouncementChannel
----
-
-Represents a guild announcement channel.
-
-## Extends
-
-- [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel)\<`ChannelType.GuildAnnouncement`\>
-
-## Constructors
-
-### new GuildAnnouncementChannel()
-
-> **new GuildAnnouncementChannel**(`client`, `rawDataOrId`): [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `client` | [`Client`](/carbon/api/classes/Client) |
-| `rawDataOrId` | `string` \| `APINewsChannel` |
-
-#### Returns
-
-[`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel)
-
-#### Inherited from
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`constructor`](/carbon/api/classes/BaseGuildTextChannel#constructors)
-
-## Properties
-
-| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
-| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
-| `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`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 | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`flags` |
-| `guildId?` | `public` | `string` | `undefined` | The ID of the guild this channel is in | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`guildId` |
-| `id` | `public` | `string` | `undefined` | The id of the channel. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`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. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`lastMessageId` |
-| `lastPinTimestamp?` | `public` | `null` \| `string` | `undefined` | The timestamp of the last pin in the channel. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`lastPinTimestamp` |
-| `name?` | `public` | `string` | `undefined` | The name of the channel. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`name` |
-| `nsfw?` | `public` | `boolean` | `undefined` | Whether the channel is marked as nsfw. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`nsfw` |
-| `parentId?` | `public` | `null` \| `string` | `undefined` | The ID of the parent category for the channel. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`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. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`partial` |
-| `position?` | `public` | `number` | `undefined` | The position of the channel in the channel list. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`position` |
-| `rateLimitPerUser?` | `public` | `null` \| `number` | `undefined` | The rate limit per user for the channel, in seconds. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`rateLimitPerUser` |
-| `rawData` | `protected` | `null` \| `APINewsChannel` | `null` | The raw data of the channel. | - | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`rawData` |
-| `type` | `public` | `GuildAnnouncement` | `ChannelType.GuildAnnouncement` | The type of the channel. | [`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).`type` | - |
-
-## Accessors
-
-### guild
-
-> `get` **guild**(): [`Guild`](/carbon/api/classes/Guild)
-
-The guild this channel is in
-
-#### Returns
-
-[`Guild`](/carbon/api/classes/Guild)
-
-#### Inherited from
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`guild`](/carbon/api/classes/BaseGuildTextChannel#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)
-
-#### Inherited from
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`lastMessage`](/carbon/api/classes/BaseGuildTextChannel#lastmessage)
-
-## 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
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`createInvite`](/carbon/api/classes/BaseGuildTextChannel#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
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`fetch`](/carbon/api/classes/BaseGuildTextChannel#fetch)
-
-***
-
-### follow()
-
-> **follow**(`targetChannel`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `targetChannel` | `string` \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
-
-***
-
-### 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
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`getInvites`](/carbon/api/classes/BaseGuildTextChannel#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)[]\>
-
-#### Inherited from
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`getPinnedMessages`](/carbon/api/classes/BaseGuildTextChannel#getpinnedmessages)
-
-***
-
-### 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
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`send`](/carbon/api/classes/BaseGuildTextChannel#send)
-
-***
-
-### setData()
-
-> `protected` **setData**(`data`): `void`
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `data` | `APIGuildChannel`\<`GuildAnnouncement`\> |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setData`](/carbon/api/classes/BaseGuildTextChannel#setdata)
-
-***
-
-### setMoreSpecificData()
-
-> `protected` **setMoreSpecificData**(): `void`
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setMoreSpecificData`](/carbon/api/classes/BaseGuildTextChannel#setmorespecificdata)
-
-***
-
-### 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
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setName`](/carbon/api/classes/BaseGuildTextChannel#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
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setNsfw`](/carbon/api/classes/BaseGuildTextChannel#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
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setParent`](/carbon/api/classes/BaseGuildTextChannel#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
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setPosition`](/carbon/api/classes/BaseGuildTextChannel#setposition)
-
-***
-
-### setSpecificData()
-
-> `protected` **setSpecificData**(`data`): `void`
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `data` | `APIGuildTextChannel`\<`GuildAnnouncement`\> |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`setSpecificData`](/carbon/api/classes/BaseGuildTextChannel#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`\>\>
-
-#### Inherited from
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`startThread`](/carbon/api/classes/BaseGuildTextChannel#startthread)
-
-***
-
-### 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
-
-[`BaseGuildTextChannel`](/carbon/api/classes/BaseGuildTextChannel).[`triggerTyping`](/carbon/api/classes/BaseGuildTextChannel#triggertyping)