Class SlashCommandNumberOption

A slash command number option.

Hierarchy

ApplicationCommandOptionBase
ApplicationCommandNumericOptionMinMaxValueMixin
ApplicationCommandOptionWithChoicesMixin<number>
ApplicationCommandOptionWithAutocompleteMixin
- SlashCommandNumberOption

Implements

ApplicationCommandNumericOptionMinMaxValueMixin

Constructors

constructor

new SlashCommandNumberOption(): SlashCommandNumberOption
Returns SlashCommandNumberOption

Inherited from ApplicationCommandOptionWithAutocompleteMixin.constructor

Properties

`Optional` `Readonly` autocomplete

autocomplete?: boolean

Whether this option utilizes autocomplete.

`Optional` `Readonly` choices

choices?: APIApplicationCommandOptionChoice<number>[]

The choices of this option.

`Readonly` description

description: string

The description of this command.

`Optional` `Readonly` description_localizations

description_localizations?: Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

The description localizations of this command.

`Optional` `Readonly` max_value

max_value?: number

The maximum value of this option.

`Optional` `Readonly` min_value

min_value?: number

The minimum value of this option.

`Readonly` name

name: string

The name of this command.

`Optional` `Readonly` name_localizations

name_localizations?: Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

The name localizations of this command.

`Readonly` required

required: boolean

Whether this option is required.

Default Value

false

`Readonly` type

type: Number

The type of this option.

Methods

addChoices

addChoices(...choices): SlashCommandNumberOption
Adds multiple choices to this option.
Parameters
- Rest ...choices: RestOrArray<APIApplicationCommandOptionChoice<number>>
  
  The choices to add
Returns SlashCommandNumberOption
Inherited from ApplicationCommandOptionWithChoicesMixin.addChoices
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1469

`Protected` runRequiredValidations

runRequiredValidations(): void
This method runs required validators on this builder.

Returns void
Inherited from ApplicationCommandOptionBase.runRequiredValidations
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1328

setAutocomplete

setAutocomplete(autocomplete): SlashCommandNumberOption
Whether this option uses autocomplete.
Parameters
- autocomplete: boolean
  
  Whether this option should use autocomplete
Returns SlashCommandNumberOption
Inherited from ApplicationCommandOptionWithAutocompleteMixin.setAutocomplete
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1447

setChoices

setChoices<Input>(...choices): SlashCommandNumberOption
Sets multiple choices for this option.
Type Parameters
- Input extends APIApplicationCommandOptionChoice<number>
Parameters
- Rest ...choices: RestOrArray<Input>
  
  The choices to set
Returns SlashCommandNumberOption
Inherited from ApplicationCommandOptionWithChoicesMixin.setChoices
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1475

setDescription

setDescription(description): SlashCommandNumberOption
Sets the description of this command.
Parameters
- description: string
  
  The description to use
Returns SlashCommandNumberOption
Inherited from ApplicationCommandOptionBase.setDescription
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1189

setDescriptionLocalization

setDescriptionLocalization(locale, localizedDescription): SlashCommandNumberOption
Sets a description localization for this command.
Parameters
- locale: "id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi"
  
  The locale to set
- localizedDescription: null | string
  
  The localized description for the given locale
Returns SlashCommandNumberOption
Inherited from ApplicationCommandOptionBase.setDescriptionLocalization
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1209

setDescriptionLocalizations

setDescriptionLocalizations(localizedDescriptions): SlashCommandNumberOption
Sets the description localizations for this command.
Parameters
- localizedDescriptions: null | Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>
  
  The object of localized descriptions to set
Returns SlashCommandNumberOption
Inherited from ApplicationCommandOptionBase.setDescriptionLocalizations
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1215

setMaxValue

setMaxValue(max): SlashCommandNumberOption
Sets the maximum number value of this option.
Parameters
- max: number
  
  The maximum value this option can be
Returns SlashCommandNumberOption
Implementation of ApplicationCommandNumericOptionMinMaxValueMixin.setMaxValue

Inherited from ApplicationCommandNumericOptionMinMaxValueMixin.setMaxValue
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1527

setMinValue

setMinValue(min): SlashCommandNumberOption
Sets the minimum number value of this option.
Parameters
- min: number
  
  The minimum value this option can be
Returns SlashCommandNumberOption
Implementation of ApplicationCommandNumericOptionMinMaxValueMixin.setMinValue

Inherited from ApplicationCommandNumericOptionMinMaxValueMixin.setMinValue
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1531

setName

setName(name): SlashCommandNumberOption
Sets the name of this command.
Parameters
- name: string
  
  The name to use
Returns SlashCommandNumberOption
Inherited from ApplicationCommandOptionBase.setName
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1183

setNameLocalization

setNameLocalization(locale, localizedName): SlashCommandNumberOption
Sets a name localization for this command.
Parameters
- locale: "id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi"
  
  The locale to set
- localizedName: null | string
  
  The localized name for the given locale
Returns SlashCommandNumberOption
Inherited from ApplicationCommandOptionBase.setNameLocalization
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1196

setNameLocalizations

setNameLocalizations(localizedNames): SlashCommandNumberOption
Sets the name localizations for this command.
Parameters
- localizedNames: null | Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>
  
  The object of localized names to set
Returns SlashCommandNumberOption
Inherited from ApplicationCommandOptionBase.setNameLocalizations
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1202

setRequired

setRequired(required): SlashCommandNumberOption
Sets whether this option is required.
Parameters
- required: boolean
  
  Whether this option should be required
Returns SlashCommandNumberOption
Inherited from ApplicationCommandOptionBase.setRequired
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1316

toJSON

toJSON(): APIApplicationCommandNumberOption
Serializes this builder to API-compatible JSON data.

Returns APIApplicationCommandNumberOption

Remarks
This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.
Overrides ApplicationCommandOptionBase.toJSON
- Defined in node_modules/@discordjs/builders/dist/index.d.ts:1535

Class SlashCommandNumberOption

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SlashCommandNumberOption

Properties

Optional Readonly autocomplete

Optional Readonly choices

Readonly description

Optional Readonly description_localizations

Optional Readonly max_value

Optional Readonly min_value

Readonly name

Optional Readonly name_localizations

Readonly required

Default Value

Readonly type

Methods

addChoices

Parameters

Rest ...choices: RestOrArray<APIApplicationCommandOptionChoice<number>>

Returns SlashCommandNumberOption

Protected runRequiredValidations

Returns void

setAutocomplete

Parameters

autocomplete: boolean

Returns SlashCommandNumberOption

setChoices

Type Parameters

Input extends APIApplicationCommandOptionChoice<number>

Parameters

Rest ...choices: RestOrArray<Input>

Returns SlashCommandNumberOption

setDescription

Parameters

description: string

Returns SlashCommandNumberOption

setDescriptionLocalization

Parameters

locale: "id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi"

localizedDescription: null | string

Returns SlashCommandNumberOption

setDescriptionLocalizations

Parameters

Returns SlashCommandNumberOption

setMaxValue

Parameters

max: number

Returns SlashCommandNumberOption

setMinValue

Parameters

min: number

Returns SlashCommandNumberOption

setName

Parameters

name: string

Returns SlashCommandNumberOption

setNameLocalization

Parameters

locale: "id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi"

localizedName: null | string

Returns SlashCommandNumberOption

setNameLocalizations

Parameters

Returns SlashCommandNumberOption

setRequired

Parameters

required: boolean

Returns SlashCommandNumberOption

toJSON

Returns APIApplicationCommandNumberOption

Remarks

Settings

Member Visibility

`Optional` `Readonly` autocomplete

`Optional` `Readonly` choices

`Readonly` description

`Optional` `Readonly` description_localizations

`Optional` `Readonly` max_value

`Optional` `Readonly` min_value

`Readonly` name

`Optional` `Readonly` name_localizations

`Readonly` required

`Readonly` type

`Rest` ...choices: RestOrArray<APIApplicationCommandOptionChoice<number>>

`Protected` runRequiredValidations

`Rest` ...choices: RestOrArray<Input>