@figliolia/data-structures/dist/types/Queue.d.ts

Efficient data structures for every day programming

/**
 * Queue
 *
 * A basic queue with enqueue, dequeue and peek methods
 *
 * ```typescript
 * import { Queue } from "@figliolia/data-structures";
 *
 * const queue = new Queue<number>();
 * queue.enqueue(1);
 * queue.enqueue(2);
 * queue.enqueue(3);
 * queue.peek(); // 1
 * queue.dequeue(); // 1
 * ```
 */
export declare class Queue<T> extends Array<T> {
    /**
     * Peek
     *
     * Returns a reference to the first element in the queue
     */
    peek(): T;
    /**
     * Enqueue
     *
     * Adds an element to the end of the queue
     */
    enqueue(item: T): number;
    /**
     * Dequeue
     *
     * Removes the first element in the queue
     */
    dequeue(): T | undefined;
}