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

    Interface CommandStats

    interface CommandStats {
        totalCommands: number;
        trackingSince: number;
        clear(): void;
        getBusiestHours(): number[];
        getCommandStats(
            command: string,
        ):
            | {
                chats: number;
                command: string;
                count: number;
                lastUsedAt: number;
                topUsers: { count: number; user: string }[];
                users: number;
            }
            | null;
        getTopChats(limit?: number): { chat: string; count: number }[];
        getTopCommands(limit?: number): { command: string; count: number }[];
        getTopUsers(limit?: number): { count: number; user: string }[];
        getUserStats(
            user: string,
        ):
            | {
                commands: { command: string; count: number }[];
                count: number;
                lastSeenAt: number;
                user: string;
            }
            | null;
        load(snapshot: Record<string, unknown>): void;
        middleware(): (
            ctx: { command: string; jid: string; sender: string },
            next: () => Promise<void>,
        ) => Promise<void>;
        record(command: string, user?: string, chat?: string): void;
        renderTop(options?: { limit?: number; title?: string }): string;
        toJSON(): Record<string, unknown>;
    }
    Index
    totalCommands trackingSince
    clear getBusiestHours getCommandStats getTopChats getTopCommands getTopUsers getUserStats load middleware record renderTop toJSON
    totalCommands: number
    trackingSince: number

    • Parameters

      • command: string

      Returns
          | {
              chats: number;
              command: string;
              count: number;
              lastUsedAt: number;
              topUsers: { count: number; user: string }[];
              users: number;
          }
          | null

    • Busiest chats across all commands.

      Parameters

      • Optionallimit: number

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

    • Parameters

      • Optionallimit: number

      Returns { command: string; count: number }[]

    • Parameters

      • Optionallimit: number

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

    • Parameters

      • user: string

      Returns
          | {
              commands: { command: string; count: number }[];
              count: number;
              lastSeenAt: number;
              user: string;
          }
          | null

    • Router middleware: router.use(stats.middleware()).

      Returns (
          ctx: { command: string; jid: string; sender: string },
          next: () => Promise<void>,
      ) => Promise<void>

    • Parameters

      • command: string
      • Optionaluser: string
      • Optionalchat: string

      Returns void

    • Ready-to-send usage leaderboard.

      Parameters

      • Optionaloptions: { limit?: number; title?: string }

      Returns string

    Settings
    Member Visibility

    On This Page
    Properties
    Methods