@wordpress/priority-queue/build-types/index.d.ts

Generic browser priority queue.

export function createQueue(): WPPriorityQueue;
/**
 * Enqueued callback to invoke once idle time permits.
 */
export type WPPriorityQueueCallback = () => void;
/**
 * An object used to associate callbacks in a particular context grouping.
 */
export type WPPriorityQueueContext = {};
/**
 * Function to add callback to priority queue.
 */
export type WPPriorityQueueAdd = (element: WPPriorityQueueContext, item: WPPriorityQueueCallback) => void;
/**
 * Function to flush callbacks from priority queue.
 */
export type WPPriorityQueueFlush = (element: WPPriorityQueueContext) => boolean;
/**
 * Reset the queue.
 */
export type WPPriorityQueueReset = () => void;
/**
 * Priority queue instance.
 */
export type WPPriorityQueue = {
    /**
     * Add callback to queue for context.
     */
    add: WPPriorityQueueAdd;
    /**
     * Flush queue for context.
     */
    flush: WPPriorityQueueFlush;
    /**
     * Clear queue for context.
     */
    cancel: WPPriorityQueueFlush;
    /**
     * Reset queue.
     */
    reset: WPPriorityQueueReset;
};
//# sourceMappingURL=index.d.ts.map