Class SlashCommandBuilder<TOptions, TSubs, TGroups>

Builder chính dùng để định nghĩa một Slash Command.

Class này chịu trách nhiệm:

Khai báo metadata của command
Lưu root options
Lưu subcommands
Lưu subcommand groups
Định nghĩa hàm execute xử lý interaction

Đây là class trung tâm của hệ thống slash command trong framework.

Example

Command đơn giản

const pingCommand = new SlashCommandBuilder({
  commandName: "ping",
  description: "Kiểm tra bot",

  execute: async (client, interaction) => {
    await interaction.reply("Pong!");
  }
});

Example

Command có options

const avatarCommand = new SlashCommandBuilder({
  commandName: "avatar",
  description: "Xem avatar user",

  options: (opt) => ({
    user: opt.user({
      description: "User cần xem avatar",
      required: false
    })
  }),

  execute: async (client, interaction, options) => {
    const user = options.user ?? interaction.user;
    await interaction.reply(user.displayAvatarURL());
  }
});

Example

Command có subcommand

const musicCommand = new SlashCommandBuilder({
  commandName: "music",
  description: "Lệnh nhạc",

  subcommands: {
    play: new SlashSubCommandBuilder({
      description: "Phát nhạc",
      options: (opt) => ({
        query: opt.string({
          description: "Tên bài hát",
          required: true
        })
      })
    }),

    stop: new SlashSubCommandBuilder({
      description: "Dừng nhạc"
    })
  },

  execute: async (client, interaction, options) => {

    if (options.payload?.type === "sub") {

      if (options.payload.sub === "play") {
        const { query } = options.payload.options;
        await interaction.reply(`Playing: ${query}`);
      }

      if (options.payload.sub === "stop") {
        await interaction.reply("Stopped music.");
      }

    }
  }
});

Example

Command có subcommand group

Cấu trúc lệnh:

/admin user ban
/admin user kick
/admin role add
/admin role remove

const adminCommand = new SlashCommandBuilder({
  commandName: "admin",
  description: "Lệnh quản trị",

  groups: {

    user: new SlashSubCommandGroupBuilder({
      description: "Quản lý user",

      subcommands: {

        ban: new SlashSubCommandBuilder({
          description: "Ban user",
          options: (opt) => ({
            target: opt.user({
              description: "User cần ban",
              required: true
            }),

            reason: opt.string({
              description: "Lý do ban",
              required: false
            })
          })
        }),

        kick: new SlashSubCommandBuilder({
          description: "Kick user",
          options: (opt) => ({
            target: opt.user({
              description: "User cần kick",
              required: true
            })
          })
        })

      }
    }),

    role: new SlashSubCommandGroupBuilder({
      description: "Quản lý role",

      subcommands: {

        add: new SlashSubCommandBuilder({
          description: "Thêm role",
          options: (opt) => ({
            user: opt.user({
              description: "User",
              required: true
            }),

            role: opt.role({
              description: "Role",
              required: true
            })
          })
        }),

        remove: new SlashSubCommandBuilder({
          description: "Gỡ role",
          options: (opt) => ({
            user: opt.user({
              description: "User",
              required: true
            }),

            role: opt.role({
              description: "Role",
              required: true
            })
          })
        })

      }
    })

  },

  async execute(client, interaction, options) {

    if (options.payload?.type !== "group") return;

    const { group, sub, options: opts } = options.payload;

    if (group === "user" && sub === "ban") {
      await interaction.reply(`Ban ${opts.target?.tag}`);
    }

    if (group === "user" && sub === "kick") {
      await interaction.reply(`Kick ${opts.target?.tag}`);
    }

  }
});

Type Parameters

TOptions extends Record<string, any> | undefined = undefined
kiểu options gốc của command
TSubs extends Record<string, ISlashSubCommandBuilder<any>> = {}
danh sách subcommand trực tiếp
TGroups extends Record<string, ISlashSubCommandGroup<any>> = {}
danh sách subcommand group

Index

Constructors

constructor

new SlashCommandBuilder<
    TOptions extends Record<string, any>
    | undefined = undefined,
    TSubs extends Record<string, ISlashSubCommandBuilder<any>> = {},
    TGroups extends Record<string, ISlashSubCommandGroup<any>> = {},
>(
    config?: SlashCommandBuilderOptions<TOptions, TSubs, TGroups>,
): SlashCommandBuilder<TOptions, TSubs, TGroups>
Khởi tạo SlashCommandBuilder.

Nếu truyền config, builder sẽ tự động áp dụng cấu hình thông qua applyConfig.
Type Parameters
- TOptions extends Record<string, any> | undefined = undefined
  kiểu options gốc của command
- TSubs extends Record<string, ISlashSubCommandBuilder<any>> = {}
  danh sách subcommand trực tiếp
- TGroups extends Record<string, ISlashSubCommandGroup<any>> = {}
  danh sách subcommand group
Parameters
- Optionalconfig: SlashCommandBuilderOptions<TOptions, TSubs, TGroups>
  cấu hình khởi tạo command
Returns SlashCommandBuilder<TOptions, TSubs, TGroups>

Properties

commandName

commandName: string

Tên slash command.

Ví dụ: /ping /admin

`Optional`cooldown

cooldown?: CooldownConfig<"interaction">

Cấu hình cooldown để tránh spam command.

description

description: string

Mô tả command hiển thị trong Discord.

`Optional`userPermission

userPermission?: SlashPermissionConfig

Cấu hình quyền người dùng cần có để sử dụng command.

Accessors

options

get options(): TOptions | undefined
Lấy options đã được build.

Returns TOptions | undefined

Methods

build

build(): SlashCommandBuilder
Build Discord SlashCommandBuilder để đăng ký với Discord API.

Method này:
1. Kiểm tra command name và description
2. Build root options
3. Build subcommands
4. Build subcommand groups
Returns SlashCommandBuilder
DiscordSlashCommandBuilder
Throws
Error nếu thiếu command name hoặc description
Example
```
const data = command.build();

await rest.put(
  Routes.applicationCommands(clientId),
  { body: [data.toJSON()] }
);
```

setCooldown

setCooldown(
cooldown: CooldownConfig<"interaction">,
): SlashCommandBuilder<TOptions, TSubs, TGroups>
Set cooldown cho command.
Parameters
- cooldown: CooldownConfig<"interaction">
  cấu hình cooldown
Returns SlashCommandBuilder<TOptions, TSubs, TGroups>
Example
```
.setCooldown({
  time: 5,
  scope: "user"
})
```

setDescription

setDescription(
description: string,
): SlashCommandBuilder<TOptions, TSubs, TGroups>
Set mô tả command.
Parameters
- description: string
  mô tả command
Returns SlashCommandBuilder<TOptions, TSubs, TGroups>
Example
```
.setDescription("Ping command")
```

setExecute

setExecute(
    handler: (
        client: Client,
        interaction: ChatInputCommandInteraction,
        options: ExecuteOptions<TOptions, TSubs, TGroups>,
    ) => any,
): SlashCommandBuilder<TOptions, TSubs, TGroups>
Set function xử lý khi command được execute.
Parameters
- handler: (
      client: Client,
      interaction: ChatInputCommandInteraction,
      options: ExecuteOptions<TOptions, TSubs, TGroups>,
  ) => any
  function handler
  - (
        client: Client,
        interaction: ChatInputCommandInteraction,
        options: ExecuteOptions<TOptions, TSubs, TGroups>,
    ): any
    Hàm thực thi khi slash command được gọi.
    
    Parameters
    client: Client
    Discord Client
    
    interaction: ChatInputCommandInteraction
    interaction của slash command
    
    options: ExecuteOptions<TOptions, TSubs, TGroups>
    object đã được parse và type-safe
    
    options bao gồm:
    
    root options
    
    payload subcommand hoặc group
    
    Ví dụ payload:
    
    options.payload
    
    có thể là:
    
    { type: "sub", sub: "ping", options: {} }
    
    hoặc
    
    { type: "group", group: "admin", sub: "ban", options: { user: User } }
    
    Returns any
Returns SlashCommandBuilder<TOptions, TSubs, TGroups>
Example
```
.setExecute(async (client, interaction, options) => {
  await interaction.reply("Hello");
})
```

setGroups

setGroups<T extends Record<string, ISlashSubCommandGroup<any>>>(
groups: T,
): SlashCommandBuilder<TOptions, TSubs, T>
Set subcommand groups cho command.

Groups dùng để tổ chức command lớn.
Type Parameters
- T extends Record<string, ISlashSubCommandGroup<any>>
Parameters
- groups: T
Returns SlashCommandBuilder<TOptions, TSubs, T>
Example
```
/admin user ban
/admin user kick
```

setName

setName(name: string): SlashCommandBuilder<TOptions, TSubs, TGroups>
Set tên command.
Parameters
- name: string
  tên command
Returns SlashCommandBuilder<TOptions, TSubs, TGroups>
Example
```
.setName("ping")
```

setOptions

setOptions<T extends Record<string, any>>(
options: (opt: OptionFactory) => T,
): SlashCommandBuilder<T, TSubs, TGroups>
Định nghĩa options cho command.
Type Parameters
- T extends Record<string, any>
Parameters
- options: (opt: OptionFactory) => T
  function tạo options
Returns SlashCommandBuilder<T, TSubs, TGroups>
Example
```
.setOptions((opt) => ({
  user: opt.user({
     description: "Target user",
     required: true
  }),
  reason: opt.string({
     description: "Ban reason"
  })
}))
```

setSubcommands

setSubcommands<T extends Record<string, ISlashSubCommandBuilder<any>>>(
subs: T,
): SlashCommandBuilder<TOptions, T, TGroups>
Set subcommands cho command.
Type Parameters
- T extends Record<string, ISlashSubCommandBuilder<any>>
Parameters
- subs: T
  danh sách subcommands
Returns SlashCommandBuilder<TOptions, T, TGroups>
Example
```
.setSubcommands({
  play: playSubcommand,
  stop: stopSubcommand
})
```

setUserPermissions

setUserPermissions(
permission: SlashPermissionConfig,
): SlashCommandBuilder<TOptions, TSubs, TGroups>
Set permission yêu cầu để sử dụng command.
Parameters
- permission: SlashPermissionConfig
  permission config
Returns SlashCommandBuilder<TOptions, TSubs, TGroups>

Class SlashCommandBuilder<TOptions, TSubs, TGroups>

Example

Example

Example

Example

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SlashCommandBuilder<TOptions, TSubs, TGroups>

Properties

commandName

Optionalcooldown

description

OptionaluserPermission

Accessors

options

Returns TOptions | undefined

Methods

build

Returns SlashCommandBuilder

Throws

Example

setCooldown

Parameters

Returns SlashCommandBuilder<TOptions, TSubs, TGroups>

Example

setDescription

Parameters

Returns SlashCommandBuilder<TOptions, TSubs, TGroups>

Example

setExecute

Parameters

Parameters

Returns any

Returns SlashCommandBuilder<TOptions, TSubs, TGroups>

Example

setGroups

Type Parameters

Parameters

Returns SlashCommandBuilder<TOptions, TSubs, T>

Example

setName

Parameters

Returns SlashCommandBuilder<TOptions, TSubs, TGroups>

Example

setOptions

Type Parameters

Parameters

Returns SlashCommandBuilder<T, TSubs, TGroups>

Example

setSubcommands

Type Parameters

Parameters

Returns SlashCommandBuilder<TOptions, T, TGroups>

Example

setUserPermissions

Parameters

Returns SlashCommandBuilder<TOptions, TSubs, TGroups>

Settings

On This Page

`Optional`cooldown

`Optional`userPermission