discord.js | ChatInputCommandUserOption

Search...

ChatInputCommandUserOption

export declare class ChatInputCommandUserOption extends ApplicationCommandOptionBase

export declare class ChatInputCommandUserOption extends ApplicationCommandOptionBase

A chat input command user option.

Extends

ApplicationCommandOptionBase

constructor()

Constructs a new instance of the ChatInputCommandUserOption class

Name	Type	Optional	Description

ProtectedReadonly

data:ApplicationCommandOptionBaseData & SharedNameAndDescriptionData

Inherited from ApplicationCommandOptionBase

ProtectedStaticReadonly

predicate:z.ZodTypeAny

Inherited from ApplicationCommandOptionBase

clearDescriptionLocalization(locale):this

Clears a description localization for this command.

Name	Type	Optional	Description
locale	Locale	No	The locale to clear

Inherited from SharedNameAndDescription

clearDescriptionLocalizations():this

Clears all description localizations for this command.

Inherited from SharedNameAndDescription

clearNameLocalization(locale):this

Clears a name localization for this command.

Name	Type	Optional	Description
locale	Locale	No	The locale to clear

Inherited from SharedName

clearNameLocalizations():this

Clears all name localizations for this command.

Inherited from SharedName

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	Locale	No	The locale to set
localizedDescription	string	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	Partial<Record<Locale, string>>	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 SharedName

setNameLocalization(locale, localizedName):this

Sets a name localization for this command.

Name	Type	Optional	Description
locale	Locale	No	The locale to set
localizedName	string	No	The localized name for the given `locale`

Inherited from SharedName

setNameLocalizations(localizedNames):this

Sets the name localizations for this command.

Name	Type	Optional	Description
localizedNames	Partial<Record<Locale, string>>	No	The object of localized names to set

Inherited from SharedName

setRequired(required?):this

Sets whether this option is required.

Name	Type	Optional	Description
required	boolean	Yes	Whether this option should be required

Inherited from ApplicationCommandOptionBase

toJSON(validationOverride?):APIApplicationCommandBasicOption

Serializes this builder to API-compatible JSON data.

Note that by disabling validation, there is no guarantee that the resulting object will be valid.

Name	Type	Optional	Description
validationOverride	boolean	Yes	Force validation to run/not run regardless of your global preference

Inherited from ApplicationCommandOptionBase