💻
Welcome
  • OVERVIEW
    • Introduction
  • DOCUMENTATION
    • CLASSES
      • ApplicationCommand
      • ApplicationCommandManager
      • ApplicationCommandBuilder
      • AttachmentOptionBuilder
      • BooleanOptionBuilder
      • ChannelOptionBuilder
      • IntegerOptionBuilder
      • MentionableOptionBuilder
      • NumberOptionBuilder
      • RoleOptionBuilder
      • StringOptionBuilder
      • SubcommandOptionBuilder
      • SubcommandGroupOptionBuilder
      • UserOptionBuilder
      • BaseOptionBuilder
      • ChoiceBuilder
      • Base
    • TYPEDEFS
      • Permissions
      • ApplicationCommandOptionTypes
      • ChannelTypes
      • ApplicationCommandTypes
      • ApplicationCommandOptionChoiceData
      • ApplicationCommandOptionData
      • ApplicationCommandData
      • RawApplicationCommandOptionChoiceData
      • RawApplicationCommandOptionData
      • RawApplicationCommandData
      • ApplicationCommandEditData
      • Snowflake
Powered by GitBook
On this page
  • Properties
  • .name
  • .description
  • .type
  • .required
  • .autocomplete
  • .choices
  • .max_value
  • .min_value
  • .name_localizations
  • .description_localizations
  • Methods
  • .setName(name)
  • .setDescription(description)
  • .setRequired(required)
  • .setAutocomplete(autocomplete)
  • .addChoice(choice)
  • .addChoices(...choices)
  • .setMaxValue(maxValue)
  • .setMinValue(minValue)
  • .toJSON()
  1. DOCUMENTATION
  2. CLASSES

NumberOptionBuilder

extends BaseOptionBuilder

Properties

.name

The option name

Type: string | null

.description

The option description

Type: string | null

.type

The option type

Type: number

.required

The option required

Type: boolean

.autocomplete

The option autocomplete

Type: boolean

.choices

The option choices

Type: RawApplicationCommandOptionChoiceData[]

.max_value

The option max value

Type: number | null

.min_value

The option min value

Type: number | null

.name_localizations

The option name localizations

Type: { [locale: string]: string }

.description_localizations

The option description localizations

Type: { [locale: string]: string }

Methods

.setName(name)

Set the option name

PARAMETER
TYPE
OPTIONAL
DESCRIPTION

name

string

none

The option name

Returns: NumberOptionBuilder

.setDescription(description)

Set the option description

PARAMETER
TYPE
OPTIONAL
DESCRIPTION

description

string

none

The option description

Returns: NumberOptionBuilder

.setRequired(required)

Set the option required

PARAMETER
TYPE
OPTIONAL
DESCRIPTION

required

boolean

none

The option required

Returns: NumberOptionBuilder

.setAutocomplete(autocomplete)

Set the option required

PARAMETER
TYPE
OPTIONAL
DESCRIPTION

autocomplete

boolean

none

The option autocomplete

Returns: NumberOptionBuilder

.addChoice(choice)

Add the option choice

PARAMETER
TYPE
OPTIONAL
DESCRIPTION

choice

fn: (builder: ChoiceBuilder) => void

none

A function that returns an option builder

Returns: NumberOptionBuilder

.addChoices(...choices)

Add the option choices

PARAMETER
TYPE
OPTIONAL
DESCRIPTION

...choices

((builder: ChoiceBuilder) => void)[]

none

A function that returns an option builder

Returns: NumberOptionBuilder

.setMaxValue(maxValue)

Set the option max value

PARAMETER
TYPE
OPTIONAL
DESCRIPTION

maxValue

number

none

The option max value

Returns: NumberOptionBuilder

.setMinValue(minValue)

Set the option min value

PARAMETER
TYPE
OPTIONAL
DESCRIPTION

minValue

number

none

The option min value

Returns: NumberOptionBuilder

.toJSON()

Returns the properties of the class in the object type.

Returns: { [property: string]: any }

PreviousMentionableOptionBuilderNextRoleOptionBuilder

Last updated 3 years ago