Skip to main content
Version: 1.x

CommandMetadata

CommandMetadata​

commandkittypes.ts

Represents the command metadata.

Signature
interface CommandMetadata {
    guilds?: string[];
    aliases?: string[];
    userPermissions?: PermissionsString | PermissionsString[];
    botPermissions?: PermissionsString | PermissionsString[];
    nameAliases?: Record<'user' | 'message', string>;
}

guilds​

property
string[]

The guilds that the command is available in.

aliases​

property
string[]

The aliases of the command.

userPermissions​

property
PermissionsString | PermissionsString[]

The user permissions required to execute the command.

botPermissions​

property
PermissionsString | PermissionsString[]

The bot permissions required to execute the command.

nameAliases​

property
Record<'user' | 'message', string>

The name aliases for the user and message context menu commands. When i18n plugin is in use, this option will be ignored if the translation for the context menu command name is provided.