discord.js | SlashCommandBuilder

SlashCommandBuilder

A builder that creates API-compatible JSON data for slash commands.

export declare class SlashCommandBuilder

export declare class SlashCommandBuilder

Readonly

default_member_permissions

:

Permissions_2 | null | undefined

The set of permissions represented as a bit set for the command.

Deprecated

Readonly

default_permission

:

boolean | undefined

Use setDefaultMemberPermissions or setDMPermission instead.

Deprecated

Whether this command is enabled by default when the application is added to a guild.

Readonly

Optional

description_localizations?

:

LocalizationMap

The description localizations of this command.

Readonly

description

:

string

The description of this command.

Readonly

dm_permission

:

boolean | undefined

Indicates whether the command is available in direct messages with the application.

Readonly

Optional

name_localizations?

:

LocalizationMap

The name localizations of this command.

Readonly

name

:

string

The name of this command.

Readonly

nsfw

:

boolean | undefined

Whether this command is NSFW.

Readonly

options

:

ToAPIApplicationCommandOptions[]

The options of this 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_2 \| bigint \| number \| null \| undefined	No	The permissions bit field to set

Deprecated

setDefaultPermission(value)

:

this

Use or 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 direct messages with the application.

Remarks

By default, commands are visible. This method is only for global commands.

Name	Type	Optional	Description
enabled	boolean \| null \| undefined	No	Whether the command should be enabled in direct messages

setNSFW(nsfw?)

:

this

Sets whether this command is NSFW.

Name	Type	Optional	Description
nsfw	boolean	Yes	Whether this command is NSFW

toJSON()

:

RESTPostAPIChatInputApplicationCommandsJSONBody

Serializes this builder to API-compatible JSON data.

Remarks

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