@playlive/react-query
    Preparing search index...

    Interface UseAlertsQueueParams

    Params for useAlertsQueue.

    interface UseAlertsQueueParams {
        consumeDonation: (donation: TiltifyDonation) => void;
        getMostRecentDonation: () => TiltifyDonation | null;
        minDonation: number;
    }
    Index
    consumeDonation getMostRecentDonation minDonation
    consumeDonation: (donation: TiltifyDonation) => void

    Mark a donation as consumed on the upstream queue so subsequent getMostRecentDonation() calls advance past it. Invoked for every peeked donation, regardless of whether it clears the min threshold.

    getMostRecentDonation: () => TiltifyDonation | null

    Peek the next donation from an external queue (e.g. an overlay context provider). Called on every tick; return null to short-circuit to the idle-check interval.

    minDonation: number

    Minimum donation amount (dollars) required to show an alert. Donations below this threshold are silently consumed off the upstream queue (so the loop doesn't re-check them) but never surfaced to the caller.

    Settings
    Member Visibility

    On This Page
    Properties