Class ChatInputCommandOptions

A resolver for command interaction options.

Hierarchy (View Summary)

CommandInteractionOptionResolver
- ChatInputCommandOptions

Index

Constructors

constructor

new ChatInputCommandOptions(
    client: default,
    options: CommandInteractionOption[],
    resolved?:
        | APIInteractionDataResolved
        | APIMessageApplicationCommandInteractionDataResolved
        | APIUserInteractionDataResolved,
): ChatInputCommandOptions
Parameters
- client: default
- options: CommandInteractionOption[]
- Optionalresolved:
      | APIInteractionDataResolved
      | APIMessageApplicationCommandInteractionDataResolved
      | APIUserInteractionDataResolved
Returns ChatInputCommandOptions
Inherited from CommandInteractionOptionResolver.constructor
- Defined in src/structures/Interaction/ApplicationCommandInteraction/BaseOptionResolver.ts:138

Properties

_hoistedOptions

_hoistedOptions: CommandInteractionOption[]

The bottom-level options for the interaction. If there is a subcommand (or subcommand and group), this is the options for the subcommand.

`Readonly`client

client: default

`Readonly`data

data: CommandInteractionOption[]

resolved

resolved: InteractionResolvedData

The resolved data from the interaction (users, members, roles, channels, messages).

Methods

get

get(name: string, required?: boolean): null | CommandInteractionOption
Gets an option by its name.
Parameters
- name: string
  The name of the option.
- required: boolean = false
  Whether to throw if the option is not found.
Returns null | CommandInteractionOption
The option, or null if not found.
Inherited from CommandInteractionOptionResolver.get
- Defined in src/structures/Interaction/ApplicationCommandInteraction/BaseOptionResolver.ts:186

getAttachment

getAttachment(name: string, required?: boolean): null | Attachment
Gets an attachment option.
Parameters
- name: string
  The name of the option.
- required: boolean = false
  Whether to throw an error if not present. Defaults to false.
Returns null | Attachment
The resolved attachment, or null.
Example
```
<interaction>.getMentionable("role");
```
- Defined in src/structures/Interaction/ApplicationCommandInteraction/ChatInputCommandInteraction.ts:223

getBoolean

getBoolean(name: string, required?: boolean): null | boolean
Gets a boolean option value.
Parameters
- name: string
  The name of the option.
- required: boolean = false
  Whether to throw an error if the option is not found. Defaults to false.
Returns null | boolean
The boolean value, or null if not set.
Example
```
<interaction>.getBoolean("admin");
```
- Defined in src/structures/Interaction/ApplicationCommandInteraction/ChatInputCommandInteraction.ts:96

getChannel

getChannel(
    name: string,
    required?: boolean,
    channelTypes?: ChannelType[],
): null | APIInteractionDataResolvedChannel
Gets a channel option.
Parameters
- name: string
  The name of the option.
- required: boolean = false
  Whether to throw an error if not found. Defaults to false.
- channelTypes: ChannelType[] = []
  Allowed channel types.
Returns null | APIInteractionDataResolvedChannel
The resolved channel, or null.
Example
```
<interaction>.getChannel("channel", true, [ChannelType.GuildText]);
```
- Defined in src/structures/Interaction/ApplicationCommandInteraction/ChatInputCommandInteraction.ts:271

getInteger

getInteger(name: string, required?: boolean): null | number
Gets an integer option value.
Parameters
- name: string
  The name of the option.
- required: boolean = false
  Whether to throw an error if the option is not found. Defaults to false.
Returns null | number
The integer value, or null if not set.
Example
```
<interaction>.getInteger("age");
```
- Defined in src/structures/Interaction/ApplicationCommandInteraction/ChatInputCommandInteraction.ts:141

getMember

getMember(name: string): null | APIInteractionDataResolvedGuildMember
Gets a member option.
Parameters
- name: string
  The name of the option.
Returns null | APIInteractionDataResolvedGuildMember
The resolved member, or null.
Example
```
<interaction>.getMember("user");
```
Inherited from CommandInteractionOptionResolver.getMember
- Defined in src/structures/Interaction/ApplicationCommandInteraction/BaseOptionResolver.ts:261

getMentionable

getMentionable(
name: string,
required?: boolean,
): null | APIUser | APIRole | APIInteractionDataResolvedGuildMember
Gets a mentionable option (user, member, or role).
Parameters
- name: string
  The name of the option.
- required: boolean = false
  Whether to throw an error if not found. Defaults to false.
Returns null | APIUser | APIRole | APIInteractionDataResolvedGuildMember
The resolved user, member, or role, or null.
Example
```
<interaction>.getMentionable("role");
```
- Defined in src/structures/Interaction/ApplicationCommandInteraction/ChatInputCommandInteraction.ts:245

getNumber

getNumber(name: string, required?: boolean): null | number
Gets a number option value.
Parameters
- name: string
  The name of the option.
- required: boolean = false
  Whether to throw an error if not found. Defaults to false.
Returns null | number
The number value, or null.
Example
```
<interaction>.getNumber("score");
```
- Defined in src/structures/Interaction/ApplicationCommandInteraction/ChatInputCommandInteraction.ts:163

getRole

getRole(name: string, required?: boolean): null | APIRole
Gets a role option.
Parameters
- name: string
  The name of the option.
- required: boolean = false
  Whether to throw an error if not found. Defaults to false.
Returns null | APIRole
The resolved role, or null.
Example
```
<interaction>.getRole("role");
```
- Defined in src/structures/Interaction/ApplicationCommandInteraction/ChatInputCommandInteraction.ts:198

getString

getString(name: string, required?: boolean): null | string
Gets a string option value.
Parameters
- name: string
  The name of the option.
- required: boolean = false
  Whether to throw an error if the option is not found. Defaults to false.
Returns null | string
The string value, or null if not set.
Example
```
<interaction>.getString("username");
```
- Defined in src/structures/Interaction/ApplicationCommandInteraction/ChatInputCommandInteraction.ts:119

getSubcommand

getSubcommand(required?: boolean): null | string
Gets the selected subcommand.
Parameters
- required: boolean = true
  Whether to throw an error if there is no subcommand.
Returns null | string
The name of the selected subcommand, or null if not set and not required.
- Defined in src/structures/Interaction/ApplicationCommandInteraction/ChatInputCommandInteraction.ts:60

getSubcommandGroup

getSubcommandGroup(required?: boolean): null | string
Gets the selected subcommand group.
Parameters
- required: boolean = false
  Whether to throw an error if there is no subcommand group.
Returns null | string
The name of the selected subcommand group, or null if not set and not required.
- Defined in src/structures/Interaction/ApplicationCommandInteraction/ChatInputCommandInteraction.ts:75

getUser

getUser(name: string, required?: boolean): null | APIUser
Parameters
- name: string
- required: boolean = false
Returns null | APIUser
Inherited from CommandInteractionOptionResolver.getUser
- Defined in src/structures/Interaction/ApplicationCommandInteraction/BaseOptionResolver.ts:236

Class ChatInputCommandOptions

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ChatInputCommandOptions

Properties

_hoistedOptions

Readonlyclient

Readonlydata

resolved

Methods

get

Parameters

Returns null | CommandInteractionOption

getAttachment

Parameters

Returns null | Attachment

Example

getBoolean

Parameters

Returns null | boolean

Example

getChannel

Parameters

Returns null | APIInteractionDataResolvedChannel

Example

getInteger

Parameters

Returns null | number

Example

getMember

Parameters

Returns null | APIInteractionDataResolvedGuildMember

Example

getMentionable

Parameters

Returns null | APIUser | APIRole | APIInteractionDataResolvedGuildMember

Example

getNumber

Parameters

Returns null | number

Example

getRole

Parameters

Returns null | APIRole

Example

getString

Parameters

Returns null | string

Example

getSubcommand

Parameters

Returns null | string

getSubcommandGroup

Parameters

Returns null | string

getUser

Parameters

Returns null | APIUser

Settings

On This Page

`Readonly`client

`Readonly`data