commands

create

Creates a command. Specify guildId to make a command in a guild

await discord.commands.create({fields}, guildId)
fieldtypedescription

name

string

Name of command, 1-32 characters

name_localizations?

LocaleObject

Localization dictionary for the name field. Values follow the same restrictions as name

description?

string

1-100 character description

description_localizations?

LocaleObject

Localization dictionary for the description field. Values follow the same restrictions as description

options?

CommandOption[]

Parameters for the command

default_member_permissions?

?string

Set of permissions represented as a bit set

default_permissions?

boolean

Replaced by default_member_permissions and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to true

type?

CommandType

Type of command, defaults 1 if not set

nsfw?

boolean

Indicates whether the command is age-restricted

delete

Deletes a command. You must specify guildId if it is a guild command

await discord.commands.delete(commandId, guildId?)

edit

Edits a command

await discord.commands.edit(commandId, fields, guildId?)
fieldstypedescription

name?

string

Name of command, 1-32 characters

name_localizations?

?LocaleObject

Localization dictionary for the name field. Values follow the same restrictions as name

description

string

1-100 character description

description_localizations?

?LocaleObject

Localization dictionary for the description field. Values follow the same restrictions as description

options?

CommandOption[]

Parameters for the command

default_member_permissions?

?string

Set of permissions represented as a bit set

default_permission?

boolean

Replaced by default_member_permissions and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to true

nsfw?

boolean

Indicates whether the command is age-restricted

list

Get a list of commands. Specify guildId for commands in a specific guild

await discord.commands.list(guildId?, withLocalizations?: boolean)

bulkOverwrite

Overwrite a list of commands.

await discord.commands.bulkOverwrite(fields[], guildId?)
fieldtypedescription

id?

Snowflake

ID of the command, if known

name

string

Name of command, 1-32 characters

name_localizations?

?LocaleObject

Localization dictionary for the name field. Values follow the same restrictions as `name

description

string

1-100 character description

description_localizations?

?LocaleObject

Localization dictionary for the description field. Values follow the same restrictions as description

options?

CommandOption[]

Parameters for the command

default_member_permissions?

?string

Set of permissions represented as a bit set

dm_permission?

?boolean

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

default_permission?

?boolean

Replaced by default_member_permissions and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to true

type?

CommandType

Type of command, defaults 1 if not set

nsfw?

boolean

Indicates whether the command is age-restricted

get

Get a command. You must specify guildId if it is a guild command

await discord.commands.get(commandId, guildId?)

classes

Command

properties

fieldtypedescription

id

Snowflake

type?

number

application_id?

Snowflake

guild_id?

Snowflake

name

string

name_localizations?

?LocaleObject

description

string

description_localizations?

?LocaleObject

options?

CommandOption[]

default_member_permissions

?string

dm_permission?

?boolean

default_permission?

?boolean

nsfw?

boolean

version

string

methods

edit

Edits this command

await command.edit(fields)

editfields

delete

deletes this command

await command.delete()

get

Gets the latest version of this command

await command.get()

getPermissions

Get the permissions of the command

await command.getPermissions(guildId?)

Last updated