poolifier - v5.0.9
    Preparing search index...

    Interface PriorityQueue<T>Internal

    Priority queue.

    interface PriorityQueue<T> {
        maxSize: number;
        size: number;
        get buckets(): number;
        get enablePriority(): boolean;
        set enablePriority(enablePriority: boolean): void;
        "[iterator]"(): Iterator<T>;
        clear(): void;
        delete(data: T): boolean;
        dequeue(bucket?: number): undefined | T;
        enqueue(data: T, priority?: number): number;
    }

    Type Parameters

    • T

      Type of priority queue data.

    Index

    Properties

    maxSize: number

    The priority queue maximum size.

    size: number

    The priority queue size.

    Accessors

    • get buckets(): number

      The number of filled prioritized buckets.

      Returns number

      The number of filled prioritized buckets.

    • get enablePriority(): boolean

      Whether priority is enabled.

      Returns boolean

      Whether priority is enabled.

    • set enablePriority(enablePriority: boolean): void

      Enables/disables priority.

      Parameters

      • enablePriority: boolean

        Whether to enable priority.

      Returns void

    Methods

    • Deletes the given data from the priority queue.

      Parameters

      • data: T

        Data to delete.

      Returns boolean

      true if the data was deleted, false otherwise.

    • Dequeue data from the priority queue.

      Parameters

      • Optionalbucket: number

        The prioritized bucket to dequeue from.

      Returns undefined | T

      The dequeued data or undefined if the priority queue is empty.

    • Enqueue data into the priority queue.

      Parameters

      • data: T

        Data to enqueue.

      • Optionalpriority: number

        Priority of the data. Lower values have higher priority.

      Returns number

      The new size of the priority queue.