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

    Interface WarnManager

    interface WarnManager {
        size: number;
        clear(): void;
        decay(olderThanMs: number): number;
        getCount(user: string, chat?: string): number;
        getTop(
            limit?: number,
            chat?: string,
        ): { chat?: string; count: number; user: string }[];
        getWarns(user: string, chat?: string): WarnRecord[];
        list(chat?: string): { chat?: string; count: number; user: string }[];
        load(snapshot: Record<string, unknown>): void;
        onThreshold(
            cb: (result: WarnResult & { warns: WarnRecord[] }) => void,
        ): () => void;
        onWarn(cb: (result: WarnResult) => void): () => void;
        pardon(user: string, chat?: string, amount?: number): number;
        renderList(chat: string, options?: { title?: string }): string;
        reset(user: string, chat?: string): void;
        toJSON(): Record<string, unknown>;
        warn(
            user: string,
            info?: { by?: string; chat?: string; reason?: string },
        ): WarnResult;
    }
    Index
    size
    clear decay getCount getTop getWarns list load onThreshold onWarn pardon renderList reset toJSON warn
    size: number

    • Expire warns older than olderThanMs everywhere. Returns removed count.

      Parameters

      • olderThanMs: number

      Returns number

    • Most-warned users leaderboard.

      Parameters

      • Optionallimit: number
      • Optionalchat: string

      Returns { chat?: string; count: number; user: string }[]

    • Parameters

      • Optionalchat: string

      Returns { chat?: string; count: number; user: string }[]

    • Parameters

      • user: string
      • Optionalchat: string
      • Optionalamount: number

      Returns number

    • Ready-to-send warn list for a chat.

      Parameters

      • chat: string
      • Optionaloptions: { title?: string }

      Returns string

    • Parameters

      • user: string
      • Optionalinfo: { by?: string; chat?: string; reason?: string }

      Returns WarnResult

    Settings
    Member Visibility

    On This Page
    Properties
    Methods