discord.js | SlashCommandBuilder

SlashCommandBuilder

No summary provided.

declare class SlashCommandBuilder

declare class SlashCommandBuilder

Readonly

default_member_permissions

:

Permissions | null | undefined

Set of permissions represented as a bit set for the command

Deprecated

Readonly

default_permission

:

boolean | undefined

This property is deprecated and will be removed in the future. You should use setDefaultMemberPermissions or setDMPermission instead.

Deprecated

Whether the command is enabled by default when the app is added to a guild

Readonly

Optional

description_localizations?

:

LocalizationMap

The localized descriptions for this command

Readonly

description

:

string

The description of this slash command

Readonly

dm_permission

:

boolean | undefined

Indicates whether the command is available in DMs with the application, only for globally-scoped commands. By default, commands are visible.

Readonly

Optional

name_localizations?

:

LocalizationMap

The localized names for this command

Readonly

name

:

string

The name of this slash command

Readonly

options

:

ToAPIApplicationCommandOptions[]

The options of this slash command

addSubcommand(input)

:

SlashCommandSubcommandsOnlyBuilder

Adds a new subcommand to this command

Name	Type	Optional	Description
input	SlashCommandSubcommandBuilder \| ((subcommandGroup: SlashCommandSubcommandBuilder) => SlashCommandSubcommandBuilder)	No	A function that returns a subcommand builder, or an already built builder

addSubcommandGroup(input)

:

SlashCommandSubcommandsOnlyBuilder

Adds a new subcommand group to this command

Name	Type	Optional	Description
input	SlashCommandSubcommandGroupBuilder \| ((subcommandGroup: SlashCommandSubcommandGroupBuilder) => SlashCommandSubcommandGroupBuilder)	No	A function that returns a subcommand group builder, or an already built builder

setDefaultMemberPermissions(permissions)

:

this

Sets the default permissions a member should have in order to run the command.

Remarks

You can set this to '0' to disable the command by default.

Name	Type	Optional	Description
permissions	Permissions \| bigint \| number \| null \| undefined	No	The permissions bit field to set

Deprecated

setDefaultPermission(value)

:

this

Use setDefaultMemberPermissions or setDMPermission instead.

Deprecated

Sets whether the command is enabled by default when the application is added to a guild.

Remarks

If set to false, you will have to later PUT the permissions for this command.

Name	Type	Optional	Description
value	boolean	No	Whether or not to enable this command by default

setDMPermission(enabled)

:

this

Sets if the command is available in DMs with the application, only for globally-scoped commands. By default, commands are visible.

Name	Type	Optional	Description
enabled	boolean \| null \| undefined	No	If the command should be enabled in DMs

toJSON()

:

RESTPostAPIChatInputApplicationCommandsJSONBody

Returns the final data that should be sent to Discord.

Remarks

This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.