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

    Interface CommandLock

    interface CommandLock {
        isMaintenance: boolean;
        check(chat: string, command: string, sender?: string): CommandLockVerdict;
        getLocks(chat: string): { chat: string[]; global: string[] };
        isLocked(chat: string, command: string, sender?: string): boolean;
        load(snapshot: Record<string, unknown>): void;
        lock(chat: string, command?: string): void;
        lockGlobal(command: string): void;
        middleware(
            options?: {
                reply?:
                    | string
                    | false
                    | ((ctx: unknown, verdict: CommandLockVerdict) => string);
            },
        ): (ctx: any, next: () => Promise<void>) => Promise<void>;
        onBlocked(
            cb: (
                info: {
                    chat: string;
                    command: string;
                    reason: string;
                    sender: string;
                },
            ) => void,
        ): () => void;
        setMaintenance(on: boolean, options?: { message?: string }): void;
        toJSON(): Record<string, unknown>;
        unlock(chat: string, command?: string): boolean;
        unlockGlobal(command: string): boolean;
    }
    Index
    isMaintenance
    check getLocks isLocked load lock lockGlobal middleware onBlocked setMaintenance toJSON unlock unlockGlobal
    isMaintenance: boolean

    • Parameters

      • chat: string

      Returns { chat: string[]; global: string[] }

    • Parameters

      • chat: string
      • command: string
      • Optionalsender: string

      Returns boolean

    • '*' locks everything in the chat.

      Parameters

      • chat: string
      • Optionalcommand: string

      Returns void

    • Router middleware; maintenance notices are sent once per user.

      Parameters

      • Optionaloptions: {
            reply?:
                | string
                | false
                | ((ctx: unknown, verdict: CommandLockVerdict) => string);
        }

      Returns (ctx: any, next: () => Promise<void>) => Promise<void>

    • Parameters

      • cb: (
            info: { chat: string; command: string; reason: string; sender: string },
        ) => void

      Returns () => void

    • Only owners run anything while on.

      Parameters

      • on: boolean
      • Optionaloptions: { message?: string }

      Returns void

    • Parameters

      • chat: string
      • Optionalcommand: string

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Properties
    Methods