Class InteractionOptionsWrapper

constructor

• new InteractionOptionsWrapper(data, resolved): InteractionOptionsWrapper

• Parameters

  • data: InteractionOptions[]

  • resolved: null | ApplicationCommandInteractionResolvedData

  Returns InteractionOptionsWrapper

raw

resolved

getAttachment

• getAttachment(name, required?): 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
• getAttachment(name, required): Attachment

• Parameters

  • name: string

  • required: true

  Returns Attachment

getAttachmentOption

• getAttachmentOption(name, required?): 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
• getAttachmentOption(name, required): InteractionOptionsAttachment

• Parameters

  • name: string

  • required: true

  Returns InteractionOptionsAttachment

getBoolean

• getBoolean(name, required?): 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
• getBoolean(name, required): boolean

• Parameters

  • name: string

  • required: true

  Returns boolean

getBooleanOption

• getBooleanOption(name, required?): 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
• getBooleanOption(name, required): InteractionOptionsBoolean

• Parameters

  • name: string

  • required: true

  Returns InteractionOptionsBoolean

getChannel

• getChannel(name, required?): 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
• getChannel(name, required): InteractionResolvedChannel

• Parameters

  • name: string

  • required: true

  Returns InteractionResolvedChannel

getChannelOption

• getChannelOption(name, required?): 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
• getChannelOption(name, required): InteractionOptionsChannel

• Parameters

  • name: string

  • required: true

  Returns InteractionOptionsChannel

getCompleteChannel

• getCompleteChannel<T>(name, required?): 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 InteractionResolvedChannel | AnyImplementedChannel = InteractionResolvedChannel | AnyImplementedChannel

  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
• getCompleteChannel<T>(name, required): T

• Type Parameters

  • T extends InteractionResolvedChannel | AnyImplementedChannel = InteractionResolvedChannel | AnyImplementedChannel

  Parameters

  • name: string

  • required: true

  Returns T

getFocused

• getFocused<T>(required?): undefined | T

• Get the focused option (in an autocomplete interaction).

  Type Parameters

  • T extends AutoCompleteFocusedOption = AutoCompleteFocusedOption

  Parameters

  • Optional required: false

    If true, an error will be thrown if no focused option is present.

  Returns undefined | T
• getFocused<T>(required): T

• Type Parameters

  • T extends AutoCompleteFocusedOption = AutoCompleteFocusedOption

  Parameters

  • required: true

  Returns T

getInteger

• getInteger(name, required?): 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
• getInteger(name, required): number

• Parameters

  • name: string

  • required: true

  Returns number

getIntegerOption

• getIntegerOption(name, required?): 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
• getIntegerOption(name, required): InteractionOptionsInteger

• Parameters

  • name: string

  • required: true

  Returns InteractionOptionsInteger

getMember

• getMember(name, required?): 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
• getMember(name, required): Member

• Parameters

  • name: string

  • required: true

  Returns Member

getMentionable

• getMentionable<T>(name, required?): undefined | T

• Get a mentionable option value (user, role).

  Type Parameters

  • T extends User | Role = User | Role

  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
• getMentionable<T>(name, required): T

• Type Parameters

  • T extends User | Role = User | Role

  Parameters

  • name: string

  • required: true

  Returns T

getMentionableOption

• getMentionableOption(name, required?): 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
• getMentionableOption(name, required): InteractionOptionsMentionable

• Parameters

  • name: string

  • required: true

  Returns InteractionOptionsMentionable

getNumber

• getNumber(name, required?): 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
• getNumber(name, required): number

• Parameters

  • name: string

  • required: true

  Returns number

getNumberOption

• getNumberOption(name, required?): 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
• getNumberOption(name, required): InteractionOptionsNumber

• Parameters

  • name: string

  • required: true

  Returns InteractionOptionsNumber

getOptions

• getOptions(): InteractionOptionsWithValue[]

• Get the options received in this interaction, excluding subcommands and subcommand groups.

  Returns InteractionOptionsWithValue[]

getRole

• getRole(name, required?): 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
• getRole(name, required): Role

• Parameters

  • name: string

  • required: true

  Returns Role

getRoleOption

• getRoleOption(name, required?): 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
• getRoleOption(name, required): InteractionOptionsRole

• Parameters

  • name: string

  • required: true

  Returns InteractionOptionsRole

getString

• getString<T>(name, required?): 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
• getString<T>(name, required): T

• Type Parameters

  • T extends string = string

  Parameters

  • name: string

  • required: true

  Returns T

getStringOption

• getStringOption(name, required?): 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
• getStringOption(name, required): InteractionOptionsString

• Parameters

  • name: string

  • required: true

  Returns InteractionOptionsString

getSubCommand

• getSubCommand<T>(required?): 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
• getSubCommand<T>(required): T

• Type Parameters

  • T extends SubCommandArray = SubCommandArray

  Parameters

  • required: true

  Returns T

getUser

• getUser(name, required?): 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
• getUser(name, required): User

• Parameters

  • name: string

  • required: true

  Returns User

getUserOption

• getUserOption(name, required?): 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
• getUserOption(name, required): InteractionOptionsUser

• Parameters

  • name: string

  • required: true

  Returns InteractionOptionsUser