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
Constructors
new AutocompleteOptionsHandler()
new AutocompleteOptionsHandler(
client,options):AutocompleteOptionsHandler
Parameters
| Parameter | Type |
|---|---|
client | Client |
options | APIApplicationCommandInteractionDataOption[] |
Returns
Inherited from
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
client | public | Client | - | OptionsHandler.client |
raw | readonly | APIApplicationCommandInteractionDataBasicOption[] | The raw options that were in the interaction data, before they were parsed. | OptionsHandler.raw |
Methods
getBoolean()
getBoolean(key, required)
getBoolean(
key,required?):undefined|boolean
Get the value of a boolean option.
Parameters
| Parameter | Type | Description |
|---|---|---|
key | string | The name of the option to get the value of. |
required? | false | Whether the option is required. |
Returns
undefined | boolean
The value of the option, or undefined if the option was not provided and it is not required.
Inherited from
getBoolean(key, required)
getBoolean(
key,required):boolean
Parameters
| Parameter | Type |
|---|---|
key | string |
required | true |
Returns
boolean
Inherited from
getChannel()
getChannel(key, required)
getChannel(
key,required?):Promise<undefined|null|GuildCategoryChannel<false> |DmChannel<false> |GroupDmChannel<false> |GuildTextChannel<false> |GuildVoiceChannel<false> |GuildAnnouncementChannel<false> |GuildThreadChannel<ThreadChannelType,false> |GuildStageChannel<false> |GuildForumChannel<false> |GuildMediaChannel>
Get the value of a channel option.
Parameters
| Parameter | Type | Description |
|---|---|---|
key | string | The name of the option to get the value of. |
required? | false | Whether the option is required. |
Returns
Promise<undefined | null | GuildCategoryChannel<false> | DmChannel<false> | GroupDmChannel<false> | GuildTextChannel<false> | GuildVoiceChannel<false> | GuildAnnouncementChannel<false> | GuildThreadChannel<ThreadChannelType, false> | GuildStageChannel<false> | GuildForumChannel<false> | GuildMediaChannel>
The value of the option, or undefined if the option was not provided and it is not required.
Inherited from
getChannel(key, required)
getChannel(
key,required):Promise<null|GuildCategoryChannel<false> |DmChannel<false> |GroupDmChannel<false> |GuildTextChannel<false> |GuildVoiceChannel<false> |GuildAnnouncementChannel<false> |GuildThreadChannel<ThreadChannelType,false> |GuildStageChannel<false> |GuildForumChannel<false> |GuildMediaChannel>
Parameters
| Parameter | Type |
|---|---|
key | string |
required | true |
Returns
Promise<null | GuildCategoryChannel<false> | DmChannel<false> | GroupDmChannel<false> | GuildTextChannel<false> | GuildVoiceChannel<false> | GuildAnnouncementChannel<false> | GuildThreadChannel<ThreadChannelType, false> | GuildStageChannel<false> | GuildForumChannel<false> | GuildMediaChannel>
Inherited from
getFocused()
getFocused():
undefined|null|string|number|boolean
Get the focused option (the one that is being autocompleted)
Returns
undefined | null | string | number | boolean
getInteger()
getInteger(key, required)
getInteger(
key,required?):undefined|number
Get the value of an integer option.
Parameters
| Parameter | Type | Description |
|---|---|---|
key | string | The name of the option to get the value of. |
required? | false | Whether the option is required. |
Returns
undefined | number
The value of the option, or undefined if the option was not provided and it is not required.
Inherited from
getInteger(key, required)
getInteger(
key,required):number
Parameters
| Parameter | Type |
|---|---|
key | string |
required | true |
Returns
number
Inherited from
getMentionable()
getMentionable(key, required)
getMentionable(
key,required?):Promise<undefined|User<false> |Role<true>>
Get the value of a mentionable option.
Parameters
| Parameter | Type | Description |
|---|---|---|
key | string | The name of the option to get the value of. |
required? | false | Whether the option is required. |
Returns
Promise<undefined | User<false> | Role<true>>
The value of the option, or undefined if the option was not provided and it is not required.
Inherited from
getMentionable(key, required)
getMentionable(
key,required):Promise<User<false> |Role<true>>
Parameters
| Parameter | Type |
|---|---|
key | string |
required | true |
Returns
Promise<User<false> | Role<true>>
Inherited from
getNumber()
getNumber(key, required)
getNumber(
key,required?):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. |
required? | false | Whether the option is required. |
Returns
undefined | number
The value of the option, or undefined if the option was not provided and it is not required.
Inherited from
getNumber(key, required)
getNumber(
key,required):number
Parameters
| Parameter | Type |
|---|---|
key | string |
required | true |
Returns
number
Inherited from
getRole()
getRole(key, required)
getRole(
key,required?):undefined|Role<true>
Get the value of a role option.
Parameters
| Parameter | Type | Description |
|---|---|---|
key | string | The name of the option to get the value of. |
required? | false | Whether the option is required. |
Returns
undefined | Role<true>
The value of the option, or undefined if the option was not provided and it is not required.
Inherited from
getRole(key, required)
getRole(
key,required):Role<true>
Parameters
| Parameter | Type |
|---|---|
key | string |
required | true |
Returns
Role<true>
Inherited from
getString()
getString(key, required)
getString(
key,required?):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. |
required? | false | Whether the option is required. |
Returns
undefined | string
The value of the option, or undefined if the option was not provided and it is not required.
Inherited from
getString(key, required)
getString(
key,required):string
Parameters
| Parameter | Type |
|---|---|
key | string |
required | true |
Returns
string
Inherited from
getUser()
getUser(key, required)
getUser(
key,required?):undefined|User<true>
Get the value of a user option.
Parameters
| Parameter | Type | Description |
|---|---|---|
key | string | The name of the option to get the value of. |
required? | false | Whether the option is required. |
Returns
undefined | User<true>
The value of the option, or undefined if the option was not provided and it is not required.
Inherited from
getUser(key, required)
getUser(
key,required):User<true>
Parameters
| Parameter | Type |
|---|---|
key | string |
required | true |
Returns
User<true>