@buape/carbon 0.1.3 → 0.3.0

package/docs/classes/AnySelectMenuInteraction.mdx

@@ -1,175 +0,0 @@
----
-title: AnySelectMenuInteraction
----
-
-This is the base type interaction, all interaction types extend from this
-
-## Extends
-
-- [`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction)
-
-## Extended by
-
-- [`ChannelSelectMenuInteraction`](/carbon/api/classes/ChannelSelectMenuInteraction)
-- [`MentionableSelectMenuInteraction`](/carbon/api/classes/MentionableSelectMenuInteraction)
-- [`RoleSelectMenuInteraction`](/carbon/api/classes/RoleSelectMenuInteraction)
-- [`StringSelectMenuInteraction`](/carbon/api/classes/StringSelectMenuInteraction)
-- [`UserSelectMenuInteraction`](/carbon/api/classes/UserSelectMenuInteraction)
-
-## Constructors
-
-### new AnySelectMenuInteraction()
-
-> **new AnySelectMenuInteraction**(`client`, `data`): [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `client` | [`Client`](/carbon/api/classes/Client) |
-| `data` | `APIMessageComponentSelectMenuInteraction` |
-
-#### Returns
-
-[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction)
-
-#### 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)
-
-***
-
-### member
-
-> `get` **member**(): `null` \| `GuildMember`
-
-#### Returns
-
-`null` \| `GuildMember`
-
-#### Inherited from
-
-[`BaseComponentInteraction`](/carbon/api/classes/BaseComponentInteraction).[`member`](/carbon/api/classes/BaseComponentInteraction#member)
-
-***
-
-### 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)
-
-***
-
-### 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`[]
-
-## 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/AutocompleteInteraction.mdx

@@ -1,166 +0,0 @@
----
-title: AutocompleteInteraction
----
-
-This is the base type interaction, all interaction types extend from this
-
-## Extends
-
-- [`BaseInteraction`](/carbon/api/classes/BaseInteraction)\<`APIApplicationCommandAutocompleteInteraction`\>
-
-## Constructors
-
-### new AutocompleteInteraction()
-
-> **new AutocompleteInteraction**(`client`, `data`, `command`?): [`AutocompleteInteraction`](/carbon/api/classes/AutocompleteInteraction)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `client` | [`Client`](/carbon/api/classes/Client) |
-| `data` | `APIApplicationCommandAutocompleteInteraction` |
-| `command`? | [`BaseCommand`](/carbon/api/classes/BaseCommand) |
-
-#### Returns
-
-[`AutocompleteInteraction`](/carbon/api/classes/AutocompleteInteraction)
-
-#### 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` |
-| `options?` | [`AutocompleteOptionsHandler`](/carbon/api/classes/AutocompleteOptionsHandler) | `undefined` | This is the options of the commands, parsed from the interaction data. | - |
-| `rawData` | `APIApplicationCommandAutocompleteInteraction` | `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`\>
-
-#### Overrides
-
-[`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`defer`](/carbon/api/classes/BaseInteraction#defer)
-
-***
-
-### reply()
-
-> **reply**(): [`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.
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
-
-#### Overrides
-
-[`BaseInteraction`](/carbon/api/classes/BaseInteraction).[`reply`](/carbon/api/classes/BaseInteraction#reply)
-
-***
-
-### respond()
-
-> **respond**(`choices`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
-
-Respond with the choices for an autocomplete interaction
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `choices` | `object`[] |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

package/docs/classes/AutocompleteOptionsHandler.mdx

@@ -1,243 +0,0 @@
----
-title: 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.
-
-## Extends
-
-- [`OptionsHandler`](/carbon/api/classes/OptionsHandler)
-
-## Constructors
-
-### new AutocompleteOptionsHandler()
-
-> **new AutocompleteOptionsHandler**(`client`, `options`): [`AutocompleteOptionsHandler`](/carbon/api/classes/AutocompleteOptionsHandler)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `client` | [`Client`](/carbon/api/classes/Client) |
-| `options` | `APIApplicationCommandInteractionDataBasicOption`[] |
-
-#### Returns
-
-[`AutocompleteOptionsHandler`](/carbon/api/classes/AutocompleteOptionsHandler)
-
-#### Inherited from
-
-[`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`constructor`](/carbon/api/classes/OptionsHandler#constructors)
-
-## Properties
-
-| Property | Modifier | Type | Default value | Description | Inherited from |
-| ------ | ------ | ------ | ------ | ------ | ------ |
-| `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`OptionsHandler`](/carbon/api/classes/OptionsHandler).`client` |
-| `errors` | `readonly` | `string`[] | `[]` | The errors that were encountered while parsing the options. | [`OptionsHandler`](/carbon/api/classes/OptionsHandler).`errors` |
-| `raw` | `readonly` | `APIApplicationCommandInteractionDataBasicOption`[] | `undefined` | The raw options that were in the interaction data, before they were parsed. | [`OptionsHandler`](/carbon/api/classes/OptionsHandler).`raw` |
-
-## Methods
-
-### getBoolean()
-
-> **getBoolean**(`key`): `undefined` \| `true`
-
-Get the value of a boolean option.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The name of the option to get the value of. |
-
-#### Returns
-
-`undefined` \| `true`
-
-The value of the option, or undefined if the option was not provided.
-
-#### Inherited from
-
-[`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getBoolean`](/carbon/api/classes/OptionsHandler#getboolean)
-
-***
-
-### getChannel()
-
-> **getChannel**(`key`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| `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)\>
-
-Get the value of a channel option.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The name of the option to get the value of. |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| `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)\>
-
-The value of the option, or undefined if the option was not provided.
-
-#### Inherited from
-
-[`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getChannel`](/carbon/api/classes/OptionsHandler#getchannel)
-
-***
-
-### getFocused()
-
-> **getFocused**(): `undefined` \| `null` \| `string` \| `number` \| `true`
-
-Get the focused option (the one that is being autocompleted)
-
-#### Returns
-
-`undefined` \| `null` \| `string` \| `number` \| `true`
-
-***
-
-### getInteger()
-
-> **getInteger**(`key`): `undefined` \| `string` \| `number` \| `true`
-
-Get the value of an integer option.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The name of the option to get the value of. |
-
-#### Returns
-
-`undefined` \| `string` \| `number` \| `true`
-
-The value of the option, or undefined if the option was not provided.
-
-#### Inherited from
-
-[`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getInteger`](/carbon/api/classes/OptionsHandler#getinteger)
-
-***
-
-### getMentionable()
-
-> **getMentionable**(`key`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| [`Role`](/carbon/api/classes/Role) \| [`User`](/carbon/api/classes/User)\>
-
-Get the value of a mentionable option.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The name of the option to get the value of. |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| [`Role`](/carbon/api/classes/Role) \| [`User`](/carbon/api/classes/User)\>
-
-The value of the option, or undefined if the option was not provided.
-
-#### Inherited from
-
-[`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getMentionable`](/carbon/api/classes/OptionsHandler#getmentionable)
-
-***
-
-### getNumber()
-
-> **getNumber**(`key`): `undefined` \| `number`
-
-Get the value of a number option.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The name of the option to get the value of. |
-
-#### Returns
-
-`undefined` \| `number`
-
-The value of the option, or undefined if the option was not provided.
-
-#### Inherited from
-
-[`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getNumber`](/carbon/api/classes/OptionsHandler#getnumber)
-
-***
-
-### getRole()
-
-> **getRole**(`key`): `undefined` \| [`Role`](/carbon/api/classes/Role)
-
-Get the value of a role option.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The name of the option to get the value of. |
-
-#### Returns
-
-`undefined` \| [`Role`](/carbon/api/classes/Role)
-
-The value of the option, or undefined if the option was not provided.
-
-#### Inherited from
-
-[`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getRole`](/carbon/api/classes/OptionsHandler#getrole)
-
-***
-
-### getString()
-
-> **getString**(`key`): `undefined` \| `string`
-
-Get the value of a string option.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The name of the option to get the value of. |
-
-#### Returns
-
-`undefined` \| `string`
-
-The value of the option, or undefined if the option was not provided.
-
-#### Inherited from
-
-[`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getString`](/carbon/api/classes/OptionsHandler#getstring)
-
-***
-
-### getUser()
-
-> **getUser**(`key`): `undefined` \| [`User`](/carbon/api/classes/User)
-
-Get the value of a user option.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The name of the option to get the value of. |
-
-#### Returns
-
-`undefined` \| [`User`](/carbon/api/classes/User)
-
-The value of the option, or undefined if the option was not provided.
-
-#### Inherited from
-
-[`OptionsHandler`](/carbon/api/classes/OptionsHandler).[`getUser`](/carbon/api/classes/OptionsHandler#getuser)