discord.js | SharedNameAndDescription

Search...

SharedNameAndDescription

export declare class SharedNameAndDescription extends SharedName

export declare class SharedNameAndDescription extends SharedName

This mixin holds name and description symbols for chat input commands.

ProtectedReadonly

clearDescriptionLocalization(locale):this

Clears a description localization for this command.

Name	Type	Optional	Description
locale	Locale	No	The locale to clear

clearDescriptionLocalizations():this

Clears all description localizations for this command.

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

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`

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

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