discord.js | SlashCommandBuilder

Search...

SlashCommandBuilder

export declare class SlashCommandBuilder

export declare class SlashCommandBuilder

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

Readonly

contexts?:InteractionContextType[]

The contexts for this command.

Readonly

default_member_permissions:Permissions | null | undefined

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

DeprecatedReadonly

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

description_localizations?:LocalizationMap

The description localizations of this command.

Readonly

description:string

The description of this command.

DeprecatedReadonly

dm_permission:boolean | undefined

Use instead.

Deprecated

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

Remarks

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

Readonly

integration_types?:ApplicationIntegrationType[]

The integration types for this command.

Readonly

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.

Readonly

contexts?:InteractionContextType[]

Inherited from SharedSlashCommand

Readonly

default_member_permissions:Permissions | null | undefined

Inherited from SharedSlashCommand

DeprecatedReadonly

default_permission:boolean | undefined

Use setDefaultMemberPermissions or setDMPermission instead.

Deprecated

Inherited from SharedSlashCommand

Readonly

description_localizations?:LocalizationMap

The description localizations of this command.

Inherited from SharedNameAndDescription

Readonly

description:string

The description of this command.

Inherited from SharedNameAndDescription

DeprecatedReadonly

dm_permission:boolean | undefined

Use contexts instead.

Deprecated

Inherited from SharedSlashCommand

Readonly

integration_types?:ApplicationIntegrationType[]

Inherited from SharedSlashCommand

Readonly

name_localizations?:LocalizationMap

The name localizations of this command.

Inherited from SharedNameAndDescription

Readonly

name:string

The name of this command.

Inherited from SharedNameAndDescription

Readonly

nsfw:boolean | undefined

Inherited from SharedSlashCommand

Readonly

options:ToAPIApplicationCommandOptions[]

Inherited from SharedSlashCommand

addAttachmentOption(input):TypeAfterAddingOptions

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):TypeAfterAddingOptions

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):TypeAfterAddingOptions

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):TypeAfterAddingOptions

Adds an integer option.

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

Inherited from SharedSlashCommandOptions

addMentionableOption(input):TypeAfterAddingOptions

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):TypeAfterAddingOptions

Adds a number option.

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

Inherited from SharedSlashCommandOptions

addRoleOption(input):TypeAfterAddingOptions

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):TypeAfterAddingOptions

Adds a string option.

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

Inherited from SharedSlashCommandOptions

addSubcommand(input):TypeAfterAddingSubcommands

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

Inherited from SharedSlashCommandSubcommands

addSubcommandGroup(input):TypeAfterAddingSubcommands

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

Inherited from SharedSlashCommandSubcommands

addUserOption(input):TypeAfterAddingOptions

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

setContexts(...contexts):this

Sets the contexts of this command.

Name	Type	Optional	Description
...contexts	RestOrArray<InteractionContextType>	No	The contexts

Inherited from SharedSlashCommand

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

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

Name	Type	Optional	Description
description	string	No	The description to use

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

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

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

Name	Type	Optional	Description
...integrationTypes	RestOrArray<ApplicationIntegrationType>	No	The integration types

Name	Type	Optional	Description
name	string	No	The name to use

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

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

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

Remarks

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

Inherited from SharedSlashCommand

SlashCommandBuilder

Remarks

Remarks

See Also

Remarks

See Also

Remarks

See Also

Remarks