Class InteractionOptionsWrapper

A wrapper for interaction options.

Hierarchy

InteractionOptionsWrapper

Constructors

constructor

new InteractionOptionsWrapper(data: InteractionOptions[], resolved: null | ApplicationCommandInteractionResolvedData): InteractionOptionsWrapper
Parameters
- data: InteractionOptions[]
- resolved: null | ApplicationCommandInteractionResolvedData
Returns InteractionOptionsWrapper
- Defined in lib/util/InteractionOptionsWrapper.ts:34

Properties

raw

raw: InteractionOptions[]

The raw options from Discord.

resolved

resolved: null | ApplicationCommandInteractionResolvedData

The resolved data for this options instance.

Methods

getAttachment

getAttachment(name: string, required?: false): undefined | Attachment
Get an attachment option value.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present or the attachment cannot be found.
Returns undefined | Attachment
- Defined in lib/util/InteractionOptionsWrapper.ts:76
getAttachment(name: string, required: true): Attachment
Parameters
- name: string
- required: true
Returns Attachment
- Defined in lib/util/InteractionOptionsWrapper.ts:77

getAttachmentOption

getAttachmentOption(name: string, required?: false): undefined | InteractionOptionsAttachment
Get an attachment option.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | InteractionOptionsAttachment
- Defined in lib/util/InteractionOptionsWrapper.ts:98
getAttachmentOption(name: string, required: true): InteractionOptionsAttachment
Parameters
- name: string
- required: true
Returns InteractionOptionsAttachment
- Defined in lib/util/InteractionOptionsWrapper.ts:99

getBoolean

getBoolean(name: string, required?: false): undefined | boolean
Get a boolean option value.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | boolean
- Defined in lib/util/InteractionOptionsWrapper.ts:109
getBoolean(name: string, required: true): boolean
Parameters
- name: string
- required: true
Returns boolean
- Defined in lib/util/InteractionOptionsWrapper.ts:110

getBooleanOption

getBooleanOption(name: string, required?: false): undefined | InteractionOptionsBoolean
Get a boolean option.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | InteractionOptionsBoolean
- Defined in lib/util/InteractionOptionsWrapper.ts:121
getBooleanOption(name: string, required: true): InteractionOptionsBoolean
Parameters
- name: string
- required: true
Returns InteractionOptionsBoolean
- Defined in lib/util/InteractionOptionsWrapper.ts:122

getChannel

getChannel(name: string, required?: false): undefined | InteractionResolvedChannel
Get a channel option value.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present or the channel cannot be found.
Returns undefined | InteractionResolvedChannel
- Defined in lib/util/InteractionOptionsWrapper.ts:132
getChannel(name: string, required: true): InteractionResolvedChannel
Parameters
- name: string
- required: true
Returns InteractionResolvedChannel
- Defined in lib/util/InteractionOptionsWrapper.ts:133

getChannelOption

getChannelOption(name: string, required?: false): undefined | InteractionOptionsChannel
Get a channel option.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | InteractionOptionsChannel
- Defined in lib/util/InteractionOptionsWrapper.ts:154
getChannelOption(name: string, required: true): InteractionOptionsChannel
Parameters
- name: string
- required: true
Returns InteractionOptionsChannel
- Defined in lib/util/InteractionOptionsWrapper.ts:155

getCompleteChannel

getCompleteChannel<T>(name: string, required?: false): undefined | T
Get a channel option's complete channel. This will only succeed if the channel is cached. If the channel is private and isn't cached, an InteractionResolvedChannel instance will still be returned.
Type Parameters
- T extends PrivateChannel | AnyGuildChannel | InteractionResolvedChannel = PrivateChannel | AnyGuildChannel | InteractionResolvedChannel
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present or the channel cannot be found.
Returns undefined | T
- Defined in lib/util/InteractionOptionsWrapper.ts:165
getCompleteChannel<T>(name: string, required: true): T
Type Parameters
- T extends PrivateChannel | AnyGuildChannel | InteractionResolvedChannel = PrivateChannel | AnyGuildChannel | InteractionResolvedChannel
Parameters
- name: string
- required: true
Returns T
- Defined in lib/util/InteractionOptionsWrapper.ts:166

getFocused

getFocused<T>(required?: false): undefined | T
Get the focused option (in an autocomplete interaction).
Type Parameters
- T extends InteractionOptionsString | InteractionOptionsInteger | InteractionOptionsNumber
Parameters
- Optional required: false
  
  If true, an error will be thrown if no focused option is present.
Returns undefined | T
- Defined in lib/util/InteractionOptionsWrapper.ts:183
getFocused<T>(required: true): T
Type Parameters
- T extends InteractionOptionsString | InteractionOptionsInteger | InteractionOptionsNumber
Parameters
- required: true
Returns T
- Defined in lib/util/InteractionOptionsWrapper.ts:184

getInteger

getInteger(name: string, required?: false): undefined | number
Get an integer option value.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | number
- Defined in lib/util/InteractionOptionsWrapper.ts:194
getInteger(name: string, required: true): number
Parameters
- name: string
- required: true
Returns number
- Defined in lib/util/InteractionOptionsWrapper.ts:195

getIntegerOption

getIntegerOption(name: string, required?: false): undefined | InteractionOptionsInteger
Get an integer option.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | InteractionOptionsInteger
- Defined in lib/util/InteractionOptionsWrapper.ts:205
getIntegerOption(name: string, required: true): InteractionOptionsInteger
Parameters
- name: string
- required: true
Returns InteractionOptionsInteger
- Defined in lib/util/InteractionOptionsWrapper.ts:206

getMember

getMember(name: string, required?: false): undefined | Member
Get a user option value (as a member).
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present, or if the member cannot be found.
Returns undefined | Member
- Defined in lib/util/InteractionOptionsWrapper.ts:216
getMember(name: string, required: true): Member
Parameters
- name: string
- required: true
Returns Member
- Defined in lib/util/InteractionOptionsWrapper.ts:217

getMentionable

getMentionable<T>(name: string, required?: false): undefined | T
Get a mentionable option value (channel, user, role).
Type Parameters
- T extends Role | User | InteractionResolvedChannel = Role | User | InteractionResolvedChannel
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present, or if the value cannot be found.
Returns undefined | T
- Defined in lib/util/InteractionOptionsWrapper.ts:238
getMentionable<T>(name: string, required: true): T
Type Parameters
- T extends Role | User | InteractionResolvedChannel = Role | User | InteractionResolvedChannel
Parameters
- name: string
- required: true
Returns T
- Defined in lib/util/InteractionOptionsWrapper.ts:239

getMentionableOption

getMentionableOption(name: string, required?: false): undefined | InteractionOptionsMentionable
Get a mentionable option.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | InteractionOptionsMentionable
- Defined in lib/util/InteractionOptionsWrapper.ts:263
getMentionableOption(name: string, required: true): InteractionOptionsMentionable
Parameters
- name: string
- required: true
Returns InteractionOptionsMentionable
- Defined in lib/util/InteractionOptionsWrapper.ts:264

getNumber

getNumber(name: string, required?: false): undefined | number
Get a number option value.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | number
- Defined in lib/util/InteractionOptionsWrapper.ts:274
getNumber(name: string, required: true): number
Parameters
- name: string
- required: true
Returns number
- Defined in lib/util/InteractionOptionsWrapper.ts:275

getNumberOption

getNumberOption(name: string, required?: false): undefined | InteractionOptionsNumber
Get a number option.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | InteractionOptionsNumber
- Defined in lib/util/InteractionOptionsWrapper.ts:285
getNumberOption(name: string, required: true): InteractionOptionsNumber
Parameters
- name: string
- required: true
Returns InteractionOptionsNumber
- Defined in lib/util/InteractionOptionsWrapper.ts:286

getRole

getRole(name: string, required?: false): undefined | Role
Get a role option value.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present, or if the role cannot be found.
Returns undefined | Role
- Defined in lib/util/InteractionOptionsWrapper.ts:296
getRole(name: string, required: true): Role
Parameters
- name: string
- required: true
Returns Role
- Defined in lib/util/InteractionOptionsWrapper.ts:297

getRoleOption

getRoleOption(name: string, required?: false): undefined | InteractionOptionsRole
Get a role option.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | InteractionOptionsRole
- Defined in lib/util/InteractionOptionsWrapper.ts:318
getRoleOption(name: string, required: true): InteractionOptionsRole
Parameters
- name: string
- required: true
Returns InteractionOptionsRole
- Defined in lib/util/InteractionOptionsWrapper.ts:319

getString

getString<T>(name: string, required?: false): undefined | T
Get a string option value.
Type Parameters
- T extends string = string
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | T
- Defined in lib/util/InteractionOptionsWrapper.ts:329
getString<T>(name: string, required: true): T
Type Parameters
- T extends string = string
Parameters
- name: string
- required: true
Returns T
- Defined in lib/util/InteractionOptionsWrapper.ts:330

getStringOption

getStringOption(name: string, required?: false): undefined | InteractionOptionsString
Get a string option.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | InteractionOptionsString
- Defined in lib/util/InteractionOptionsWrapper.ts:340
getStringOption(name: string, required: true): InteractionOptionsString
Parameters
- name: string
- required: true
Returns InteractionOptionsString
- Defined in lib/util/InteractionOptionsWrapper.ts:341

getSubCommand

getSubCommand<T>(required?: false): undefined | T
If present, returns the top level subcommand. This will return an array of the subcommand name, and subcommand group name, if applicable.
Type Parameters
- T extends SubCommandArray = SubCommandArray
Parameters
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | T
- Defined in lib/util/InteractionOptionsWrapper.ts:350
getSubCommand<T>(required: true): T
Type Parameters
- T extends SubCommandArray = SubCommandArray
Parameters
- required: true
Returns T
- Defined in lib/util/InteractionOptionsWrapper.ts:351

getUser

getUser(name: string, required?: false): undefined | User
Get a user option value.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present, or if the user cannot be found.
Returns undefined | User
- Defined in lib/util/InteractionOptionsWrapper.ts:376
getUser(name: string, required: true): User
Parameters
- name: string
- required: true
Returns User
- Defined in lib/util/InteractionOptionsWrapper.ts:377

getUserOption

getUserOption(name: string, required?: false): undefined | InteractionOptionsUser
Get a user option.
Parameters
- name: string
  
  The name of the option.
- Optional required: false
  
  If true, an error will be thrown if the option is not present.
Returns undefined | InteractionOptionsUser
- Defined in lib/util/InteractionOptionsWrapper.ts:398
getUserOption(name: string, required: true): InteractionOptionsUser
Parameters
- name: string
- required: true
Returns InteractionOptionsUser
- Defined in lib/util/InteractionOptionsWrapper.ts:399

Class InteractionOptionsWrapper

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

data: InteractionOptions[]

resolved: null | ApplicationCommandInteractionResolvedData

Returns InteractionOptionsWrapper

Properties

raw

resolved

Methods

getAttachment

Parameters

name: string

Optional required: false

Returns undefined | Attachment

Parameters

name: string

required: true

Returns Attachment

getAttachmentOption

Parameters

name: string

Optional required: false

Returns undefined | InteractionOptionsAttachment

Parameters

name: string

required: true

Returns InteractionOptionsAttachment

getBoolean

Parameters

name: string

Optional required: false

Returns undefined | boolean

Parameters

name: string

required: true

Returns boolean

getBooleanOption

Parameters

name: string

Optional required: false

Returns undefined | InteractionOptionsBoolean

Parameters

name: string

required: true

Returns InteractionOptionsBoolean

getChannel

Parameters

name: string

Optional required: false

Returns undefined | InteractionResolvedChannel

Parameters

name: string

required: true

Returns InteractionResolvedChannel

getChannelOption

Parameters

name: string

Optional required: false

Returns undefined | InteractionOptionsChannel

Parameters

name: string

required: true

Returns InteractionOptionsChannel

getCompleteChannel

Type Parameters

T extends PrivateChannel | AnyGuildChannel | InteractionResolvedChannel = PrivateChannel | AnyGuildChannel | InteractionResolvedChannel

Parameters

name: string

Optional required: false

Returns undefined | T

Type Parameters

T extends PrivateChannel | AnyGuildChannel | InteractionResolvedChannel = PrivateChannel | AnyGuildChannel | InteractionResolvedChannel

Parameters

`Optional` required: false

`Optional` required: false

`Optional` required: false

`Optional` required: false

`Optional` required: false

`Optional` required: false

`Optional` required: false

`Optional` required: false

`Optional` required: false

`Optional` required: false

`Optional` required: false

`Optional` required: false

`Optional` required: false

`Optional` required: false