si-funciona/dist/helpers/arrays/BasicQueue.d.ts

Funciones de utilidad para uso general. [General usage utility functions.]

import 'core-js/stable';
export type callableLater = {
    fn?: Function;
    args?: Array<any>;
};
export type queuedItem = {
    item: callableLater | any;
    generator: Generator;
};
/**
 * Define the format of a queue
 * @typdef {Object} IsQueue
 * @property {Array|*} innerList - Stores the data for the queue
 * @method dequeue - Pulls the first item from the queue
 * @method empty - Check if the queue is empty
 * @method enqueue - Adds and item to the end of the queue
 * @method peek - Get the next queue item but does not remove it
 * @method size - Get the size of the queue
 */
export interface IsQueue<queuedItem> {
    dequeue: () => queuedItem | null;
    empty: () => boolean;
    enqueue: (data: queuedItem) => void;
    peek: () => queuedItem | null;
    size: () => number;
}
/**
 * Class BasicQueue is a functional example of a queue to be used with queueManager.
 * @memberOf module:arrayHelpers
 */
declare class BasicQueue implements IsQueue<queuedItem> {
    private readonly innerList;
    constructor(innerList?: queuedItem[] | any);
    /**
     * Remove and return the next item in the queue
     * @returns {queuedItem|*}
     */
    dequeue(): queuedItem | any;
    /**
     * Check if the queue is empty
     * @returns {boolean}
     */
    empty(): boolean;
    /**
     * Add an item to the end of the queue
     * @param {queuedItem|*} data
     * @returns {BasicQueue}
     */
    enqueue(data: queuedItem | any): IsQueue<queuedItem>;
    /**
     * Retrieve the next item from the queue
     * @returns {queuedItem|*}
     */
    peek(): queuedItem | any;
    /**
     * Get the quantity of items in the queue
     * @returns {number}
     */
    size(): number;
}
export default BasicQueue;