@japofc/baileys - v2.4.7
    Preparing search index...

    Interface CommandDefinition

    interface CommandDefinition {
        adminOnly?: boolean;
        alias?: Record<string, string>;
        aliases?: string | string[];
        booleans?: string[];
        botAdmin?: boolean;
        category?: string;
        cooldownMs?: number;
        defaults?: Record<string, unknown>;
        description?: string;
        disabled?: boolean;
        groupOnly?: boolean;
        handler: CommandHandler;
        hidden?: boolean;
        name: string;
        ownerOnly?: boolean;
        permission?: (ctx: Context) => boolean | Promise<boolean>;
        privateOnly?: boolean;
        usage?: string;
    }
    Index
    adminOnly? alias? aliases? booleans? botAdmin? category? cooldownMs? defaults? description? disabled? groupOnly? handler hidden? name ownerOnly? permission? privateOnly? usage?
    adminOnly?: boolean

    Only group admins (uses the router's isAdmin resolver).

    alias?: Record<string, string>

    Flag alias map (passed to args-parser).

    aliases?: string | string[]

    Alternative words that invoke the same command.

    booleans?: string[]

    Flag names parsed as booleans (passed to args-parser).

    botAdmin?: boolean

    Require the bot itself to be a group admin.

    category?: string

    Grouping label for help (default 'General').

    cooldownMs?: number

    Per-user cooldown in ms (owners are exempt).

    defaults?: Record<string, unknown>

    Default flag values (passed to args-parser).

    description?: string

    One-line description shown in help.

    disabled?: boolean

    Registered but temporarily inert.

    groupOnly?: boolean

    Only inside groups.

    handler: CommandHandler
    hidden?: boolean

    Hide from the generated help.

    name: string

    Primary command word (without prefix).

    ownerOnly?: boolean

    Only bot owners may run it.

    permission?: (ctx: Context) => boolean | Promise<boolean>

    Custom async gate; falsy return denies with reason 'custom'.

    privateOnly?: boolean

    Only in direct messages.

    usage?: string

    Usage/argument hint shown in help (e.g. ' [amount]').

    Settings
    Member Visibility

    On This Page
    Properties