Class CommandManager

Quản lý hệ thống prefix command cho Discord bot.

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

Load command từ thư mục.
Đăng ký command, alias và category vào client.
Resolve command theo tên hoặc alias.
Tự động xử lý event messageCreate.
Kiểm tra cooldown và permission trước khi chạy command.

Example

const manager = new CommandManager({
  directory: "./commands",
  prefix: "!",
});

await manager.loadAll(client);

Index

Constructors

constructor

new CommandManager(options: CommandManagerOptions): CommandManager
Tạo một CommandManager mới.

Constructor chỉ lưu cấu hình, chưa load command ngay. Để load command, hãy gọi CommandManager.loadAll.
Parameters
- options: CommandManagerOptions
  Cấu hình cho CommandManager.
Returns CommandManager
Example
```
const manager = new CommandManager({
  directory: "./commands",
  prefix: ["!", "?"],
  mentionPrefix: true,
});
```

Properties

client

client: Client

Methods

getAllCommands

getAllCommands(): CommandBuilder<boolean>[]
Lấy toàn bộ command đã load.

Returns CommandBuilder<boolean>[]
Mảng các command builder.
Example
```
for (const command of manager.getAllCommands()) {
  console.log(command.commandName);
}
```

getCategories

getCategories(): Collection<string, Collection<string, CommandBuilder<boolean>>>
Lấy toàn bộ category và command bên trong từng category.

Returns Collection<string, Collection<string, CommandBuilder<boolean>>>
Collection có key là tên category và value là collection command.
Example
```
for (const [category, commands] of manager.getCategories()) {
  console.log(category, commands.size);
}
```

getCategory

getCategory(
category: string,
): Collection<string, CommandBuilder<boolean>> | undefined
Lấy collection command theo category.

Category được suy ra từ thư mục cấp đầu tiên bên trong directory.
Parameters
- category: string
  Tên category cần lấy.
Returns Collection<string, CommandBuilder<boolean>> | undefined
Collection command thuộc category, hoặc undefined nếu không tồn tại.
Example
```
const adminCommands = manager.getCategory("admin");

if (adminCommands) {
  console.log([...adminCommands.keys()]);
}
```

getCategoryNames

getCategoryNames(): string[]
Lấy danh sách tên category hiện có.

Returns string[]
Mảng tên category.
Example
```
const categories = manager.getCategoryNames();
console.log(categories);
```

getCommand

getCommand(commandName: string): CommandBuilder<boolean> | undefined
Lấy command theo tên chính xác sau khi normalize.

Hàm này chỉ tìm trong client.commands, không resolve alias. Nếu bạn muốn tìm cả alias, hãy dùng CommandManager.resolve.
Parameters
- commandName: string
  Tên command cần tìm.
Returns CommandBuilder<boolean> | undefined
Command nếu tồn tại, ngược lại trả về undefined.
Example
```
const help = manager.getCommand("help");

if (help) {
  console.log(help.commandName);
}
```

getCommandCount

getCommandCount(): number
Lấy tổng số command hiện đang được quản lý.

Returns number
Số lượng command đã load.
Example
```
console.log(`Bot hiện có ${manager.getCommandCount()} command`);
```

getCommandNames

getCommandNames(): string[]
Lấy danh sách tên command đã load.

Returns string[]
Mảng tên command đã normalize.
Example
```
const names = manager.getCommandNames();
console.log(names.join(", "));
```

getPrefixes

getPrefixes(guildID?: string): Promise<string[]>
Lấy danh sách prefix hiện tại.

Nếu prefix là function, hàm sẽ gọi function đó với guildID. Nếu prefix trả về string đơn, hàm sẽ bọc thành mảng một phần tử.
Parameters
- guildID: string = ""
  ID của guild cần lấy prefix. Mặc định là chuỗi rỗng.
Returns Promise<string[]>
Mảng prefix có thể dùng trong guild đó.
Example
```
const prefixes = await manager.getPrefixes(message.guildId ?? "");
console.log(prefixes);
```

hasCommand

hasCommand(commandName: string): boolean
Kiểm tra command hoặc alias có tồn tại hay không.

Hàm này dùng CommandManager.resolve, nên có thể kiểm tra cả tên command lẫn alias của command.
Parameters
- commandName: string
  Tên command hoặc alias cần kiểm tra.
Returns boolean
true nếu tìm thấy command, ngược lại là false.
Example
```
if (manager.hasCommand("h")) {
  console.log("Alias hoặc command này tồn tại");
}
```

loadAll

loadAll(): Promise<void>
Load toàn bộ command từ thư mục đã cấu hình.

Nếu registerMessageCreateEvent là true, hàm này cũng tự động gắn listener cho event messageCreate để bot có thể xử lý prefix command.

Returns Promise<void>
Promise hoàn tất sau khi toàn bộ command hợp lệ được load.
Example
```
const manager = new CommandManager({
  directory: "./commands",
  prefix: "!",
});

await manager.loadAll();
console.log(`Đã load ${manager.getCommandCount()} command`);
```

registerCommand

registerCommand(
command: CommandBuilder<boolean> | CommandBuilder<boolean>[],
): void
Đăng ký một hoặc nhiều command vào command manager.

Nếu command hoặc alias đã tồn tại, hàm sẽ ném ra lỗi.
Parameters
- command: CommandBuilder<boolean> | CommandBuilder<boolean>[]
  Command hoặc danh sách command cần đăng ký.
Returns void
Throws
Ném ra lỗi nếu:
- Tên command bị trùng lặp.
- Alias bị trùng lặp.
- Command không hợp lệ.
Example
```
manager.registerCommand(pingCommand);
```
Example
```
manager.registerCommand([
  pingCommand,
  helpCommand,
  avatarCommand,
]);
```

reloadAll

reloadAll(): Promise<void>
Xóa toàn bộ command hiện tại và load lại từ thư mục.

Hàm này clear commands, aliases và categories trước khi gọi lại CommandManager.loadAll.

Returns Promise<void>
Promise hoàn tất sau khi reload xong.
Example
```
await manager.reloadAll();
console.log("Đã reload toàn bộ command");
```

reloadCommand

reloadCommand(commandName: string): Promise<boolean>
Reload một command cụ thể.

Hàm này tìm command theo tên hoặc alias, unload command đó, sau đó quét lại thư mục command để load phiên bản mới.
Parameters
- commandName: string
  Tên command hoặc alias cần reload.
Returns Promise<boolean>
true nếu command được reload thành công, ngược lại là false.
Example
```
const ok = await manager.reloadCommand("help");

if (ok) {
  console.log("Đã reload command help");
}
```

resolve

resolve(commandName: string): CommandBuilder<boolean> | null
Resolve command từ tên command hoặc alias.

Tên truyền vào sẽ được trim và chuyển về chữ thường trước khi tìm kiếm.
Parameters
- commandName: string
Returns CommandBuilder<boolean> | null
Command tìm được, hoặc null nếu không tồn tại.
Example
```
const command = manager.resolve("help");
const commandFromAlias = manager.resolve("h");

if (commandFromAlias) {
  await commandFromAlias.execute(client, message, []);
}
```

setClient

setClient(client: Client): this
Gán instance client cho manager.

Method này được gọi bởi Client trong quá trình khởi tạo để inject client vào manager sau khi client đã được tạo.
Parameters
- client: Client
  Instance Discord client.
Returns this
Chính instance hiện tại để hỗ trợ chaining.
Example
```
commandManager.setClient(client);
```

unloadCommand

unloadCommand(commandName: string): boolean
Gỡ một command khỏi client.

Hàm này cũng xóa các alias trỏ tới command và xóa command khỏi category. Nếu category rỗng sau khi xóa, category đó cũng bị xóa khỏi client.
Parameters
- commandName: string
  Tên command hoặc alias cần gỡ.
Returns boolean
true nếu gỡ thành công, false nếu không tìm thấy command.
Example
```
const removed = manager.unloadCommand("help");

if (removed) {
  console.log("Đã gỡ command help");
}
```

Class CommandManager

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommandManager

Example

Properties

client

Methods

getAllCommands

Returns CommandBuilder<boolean>[]

Example

getCategories

Returns Collection<string, Collection<string, CommandBuilder<boolean>>>

Example

getCategory

Parameters

Returns Collection<string, CommandBuilder<boolean>> | undefined

Example

getCategoryNames

Returns string[]

Example

getCommand

Parameters

Returns CommandBuilder<boolean> | undefined

Example

getCommandCount

Returns number

Example

getCommandNames

Returns string[]

Example

getPrefixes

Parameters

Returns Promise<string[]>

Example

hasCommand

Parameters

Returns boolean

Example

loadAll

Returns Promise<void>

Example

registerCommand

Parameters

Returns void

Throws

Example

Example

reloadAll

Returns Promise<void>

Example

reloadCommand

Parameters

Returns Promise<boolean>

Example

resolve

Parameters

Returns CommandBuilder<boolean> | null

Example

setClient

Parameters

Returns this

Example

unloadCommand

Parameters

Returns boolean

Example

Settings

On This Page