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

    Interface QuotaManager

    interface QuotaManager {
        consume(user: string, tier?: string, amount?: number): QuotaCheck;
        getAllUsage(): { used: number; user: string }[];
        getLimit(tier?: string): number;
        getUsed(user: string): number;
        grantBonus(user: string, amount: number): void;
        load(snapshot: Record<string, unknown>): void;
        onExhausted(
            cb: (
                info: {
                    limit: number;
                    resetAt: number;
                    tier?: string;
                    used: number;
                    user: string;
                },
            ) => void,
        ): () => void;
        remaining(user: string, tier?: string): number;
        renderStatus(user: string, tier?: string): string;
        reset(user?: string): void;
        setDefaultLimit(limit: number): void;
        setLimit(tier: string, limit: number): void;
        toJSON(): Record<string, unknown>;
    }
    Index
    consume getAllUsage getLimit getUsed grantBonus load onExhausted remaining renderStatus reset setDefaultLimit setLimit toJSON

    • Today's usage for every tracked user.

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

    • Extra allowance for today only (rewards/promos).

      Parameters

      • user: string
      • amount: number

      Returns void

    • Parameters

      • snapshot: Record<string, unknown>

      Returns void

    • Parameters

      • cb: (
            info: {
                limit: number;
                resetAt: number;
                tier?: string;
                used: number;
                user: string;
            },
        ) => void

      Returns () => void

    • Peek without spending.

      Parameters

      • user: string
      • Optionaltier: string

      Returns number

    • Ready-to-send quota line for one user.

      Parameters

      • user: string
      • Optionaltier: string

      Returns string

    • Reset one user, or everyone when omitted.

      Parameters

      • Optionaluser: string

      Returns void

    • Change a tier's daily limit at runtime.

      Parameters

      • tier: string
      • limit: number

      Returns void

    Settings
    Member Visibility

    On This Page
    Methods