Documentation / @imvu/bot / CommandOptions

Interface: CommandOptions<T>

Defined in: packages/bot/src/Bot.ts:81

Type Parameters

Type Parameter	Default type
T extends SourceType	SourceType

Properties

aliases?

aliases?: string[];

Defined in: packages/bot/src/Bot.ts:85

---

cooldown?

cooldown?: number;

Defined in: packages/bot/src/Bot.ts:89

Per-user cooldown in milliseconds (per source).

---

description?

description?: string;

Defined in: packages/bot/src/Bot.ts:82

---

permission?

permission?: 
  | Role
  | ((context) => boolean | Promise<boolean>);

Defined in: packages/bot/src/Bot.ts:87

Minimum role, or a custom check. Default 'everyone'.

---

sources?

sources?: T[];

Defined in: packages/bot/src/Bot.ts:94

Where the command may run. Default: everywhere. Also narrows ctx.source in the handler: with ['room'] it is a BotRoom.

---

usage?

usage?: string;

Defined in: packages/bot/src/Bot.ts:84

Shown by help <command>, e.g. <user> [reason].