discord.js | SlashCommandOptionsOnlyBuilder

SlashCommandOptionsOnlyBuilder

export declare interface SlashCommandOptionsOnlyBuilder extends SharedNameAndDescription, SharedSlashCommandOptions, Pick<SlashCommandBuilder, 'toJSON'>

export declare interface SlashCommandOptionsOnlyBuilder extends SharedNameAndDescription, SharedSlashCommandOptions, Pick<SlashCommandBuilder, 'toJSON'>

An interface specifically for slash command options.

Extends

SharedNameAndDescription SharedSlashCommandOptionsPick<SlashCommandBuilder, 'toJSON'>

Readonly

Optional

description_localizations?

:

LocalizationMap

The description localizations of this command.

Inherited from SharedNameAndDescription

Readonly

description

:

string

The description of this command.

Inherited from SharedNameAndDescription

Readonly

Optional

name_localizations?

:

LocalizationMap

The name localizations of this command.

Inherited from SharedNameAndDescription

Readonly

name

:

string

The name of this command.

Inherited from SharedNameAndDescription

Readonly

options

:

ToAPIApplicationCommandOptions[]

Inherited from SharedSlashCommandOptions

addAttachmentOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Pick<this, Exclude<keyof this, "addSubcommand" | "addSubcommandGroup">> : this

Adds an attachment option.

Name	Type	Optional	Description
input	SlashCommandAttachmentOption \| ((builder: SlashCommandAttachmentOption) => SlashCommandAttachmentOption)	No	A function that returns an option builder or an already built builder

Inherited from SharedSlashCommandOptions

addBooleanOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Pick<this, Exclude<keyof this, "addSubcommand" | "addSubcommandGroup">> : this

Adds a boolean option.

Name	Type	Optional	Description
input	SlashCommandBooleanOption \| ((builder: SlashCommandBooleanOption) => SlashCommandBooleanOption)	No	A function that returns an option builder or an already built builder

Inherited from SharedSlashCommandOptions

addChannelOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Pick<this, Exclude<keyof this, "addSubcommand" | "addSubcommandGroup">> : this

Adds a channel option.

Name	Type	Optional	Description
input	SlashCommandChannelOption \| ((builder: SlashCommandChannelOption) => SlashCommandChannelOption)	No	A function that returns an option builder or an already built builder

Inherited from SharedSlashCommandOptions

addIntegerOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Pick<this, Exclude<keyof this, "addSubcommand" | "addSubcommandGroup">> : this

Adds an integer option.

Name	Type	Optional	Description
input	Pick<SlashCommandIntegerOption, Exclude<keyof SlashCommandIntegerOption, 'addChoices'>> \| Pick<SlashCommandIntegerOption, Exclude<keyof SlashCommandIntegerOption, 'setAutocomplete'>> \| SlashCommandIntegerOption \| ((builder: SlashCommandIntegerOption) => Pick<SlashCommandIntegerOption, Exclude<keyof SlashCommandIntegerOption, 'addChoices'>> \| Pick<SlashCommandIntegerOption, Exclude<keyof SlashCommandIntegerOption, 'setAutocomplete'>> \| SlashCommandIntegerOption)	No	A function that returns an option builder or an already built builder

Inherited from SharedSlashCommandOptions

addMentionableOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Pick<this, Exclude<keyof this, "addSubcommand" | "addSubcommandGroup">> : this

Adds a mentionable option.

Name	Type	Optional	Description
input	SlashCommandMentionableOption \| ((builder: SlashCommandMentionableOption) => SlashCommandMentionableOption)	No	A function that returns an option builder or an already built builder

Inherited from SharedSlashCommandOptions

addNumberOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Pick<this, Exclude<keyof this, "addSubcommand" | "addSubcommandGroup">> : this

Adds a number option.

Name	Type	Optional	Description
input	Pick<SlashCommandNumberOption, Exclude<keyof SlashCommandNumberOption, 'addChoices'>> \| Pick<SlashCommandNumberOption, Exclude<keyof SlashCommandNumberOption, 'setAutocomplete'>> \| SlashCommandNumberOption \| ((builder: SlashCommandNumberOption) => Pick<SlashCommandNumberOption, Exclude<keyof SlashCommandNumberOption, 'addChoices'>> \| Pick<SlashCommandNumberOption, Exclude<keyof SlashCommandNumberOption, 'setAutocomplete'>> \| SlashCommandNumberOption)	No	A function that returns an option builder or an already built builder

Inherited from SharedSlashCommandOptions

addRoleOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Pick<this, Exclude<keyof this, "addSubcommand" | "addSubcommandGroup">> : this

Adds a role option.

Name	Type	Optional	Description
input	SlashCommandRoleOption \| ((builder: SlashCommandRoleOption) => SlashCommandRoleOption)	No	A function that returns an option builder or an already built builder

Inherited from SharedSlashCommandOptions

addStringOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Pick<this, Exclude<keyof this, "addSubcommand" | "addSubcommandGroup">> : this

Adds a string option.

Name	Type	Optional	Description
input	Pick<SlashCommandStringOption, Exclude<keyof SlashCommandStringOption, 'addChoices'>> \| Pick<SlashCommandStringOption, Exclude<keyof SlashCommandStringOption, 'setAutocomplete'>> \| SlashCommandStringOption \| ((builder: SlashCommandStringOption) => Pick<SlashCommandStringOption, Exclude<keyof SlashCommandStringOption, 'addChoices'>> \| Pick<SlashCommandStringOption, Exclude<keyof SlashCommandStringOption, 'setAutocomplete'>> \| SlashCommandStringOption)	No	A function that returns an option builder or an already built builder

Inherited from SharedSlashCommandOptions

addUserOption(input)

:

ShouldOmitSubcommandFunctions extends true ? Pick<this, Exclude<keyof this, "addSubcommand" | "addSubcommandGroup">> : this

Adds a user option.

Name	Type	Optional	Description
input	SlashCommandUserOption \| ((builder: SlashCommandUserOption) => SlashCommandUserOption)	No	A function that returns an option builder or an already built builder

Inherited from SharedSlashCommandOptions

setDescription(description)

:

this

Sets the description of this command.

Name	Type	Optional	Description
description	string	No	The description to use

Inherited from SharedNameAndDescription

setDescriptionLocalization(locale, localizedDescription)

:

this

Sets a description localization for this command.

Name	Type	Optional	Description
locale	LocaleString	No	The locale to set
localizedDescription	string \| null	No	The localized description for the given locale

Inherited from SharedNameAndDescription

setDescriptionLocalizations(localizedDescriptions)

:

this

Sets the description localizations for this command.

Name	Type	Optional	Description
localizedDescriptions	LocalizationMap \| null	No	The object of localized descriptions to set

Inherited from SharedNameAndDescription

setName(name)

:

this

Sets the name of this command.

Name	Type	Optional	Description
name	string	No	The name to use

Inherited from SharedNameAndDescription

setNameLocalization(locale, localizedName)

:

this

Sets a name localization for this command.

Name	Type	Optional	Description
locale	LocaleString	No	The locale to set
localizedName	string \| null	No	The localized name for the given `locale`

Inherited from SharedNameAndDescription

setNameLocalizations(localizedNames)

:

this

Sets the name localizations for this command.

Name	Type	Optional	Description
localizedNames	LocalizationMap \| null	No	The object of localized names to set

Inherited from SharedNameAndDescription