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

    Interface InviteTracker

    Invite tracker — group-add attribution + top-inviter leaderboards.

    interface InviteTracker {
        size: number;
        bind(sock: unknown): () => void;
        getCount(chat: string, inviter: string): { active: number; total: number };
        getGlobalCount(inviter: string): { active: number; total: number };
        getGlobalLeaderboard(
            limit?: number,
        ): { active: number; inviter: string; total: number }[];
        getInviter(chat: string, member: string): string | null;
        getLeaderboard(
            chat: string,
            limit?: number,
        ): { active: number; inviter: string; total: number }[];
        handler(update: unknown): void;
        load(snapshot: Record<string, unknown>): void;
        onInvite(
            cb: (
                info: { at: number; chat: string; invited: string; inviter: string },
            ) => void,
        ): () => void;
        renderLeaderboard(
            chat: string,
            options?: { limit?: number; title?: string },
        ): string;
        toJSON(): Record<string, unknown>;
        unbind(): void;
    }
    Index
    size
    bind getCount getGlobalCount getGlobalLeaderboard getInviter getLeaderboard handler load onInvite renderLeaderboard toJSON unbind
    size: number

    • Adds credited to an inviter: { total, active } (leavers decrement active).

      Parameters

      • chat: string
      • inviter: string

      Returns { active: number; total: number }

    • An inviter's combined { total, active } across all tracked chats.

      Parameters

      • inviter: string

      Returns { active: number; total: number }

    • Top inviters aggregated across every tracked chat.

      Parameters

      • Optionallimit: number

      Returns { active: number; inviter: string; total: number }[]

    • Who brought this member in, or null.

      Parameters

      • chat: string
      • member: string

      Returns string | null

    • Parameters

      • chat: string
      • Optionallimit: number

      Returns { active: number; inviter: string; total: number }[]

    • Parameters

      • cb: (info: { at: number; chat: string; invited: string; inviter: string }) => void

      Returns () => void

    • Parameters

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

      Returns string

    Settings
    Member Visibility

    On This Page
    Properties
    Methods