poolifier 4.0.11 → 4.0.13

package/lib/index.d.ts

@@ -6,30 +6,142 @@ import { EventLoopUtilization } from 'node:perf_hooks';
 import { ClusterSettings, Worker } from 'node:cluster';
 
 /**
- * Circular buffer
+ * Circular buffer designed for positive numbers.
+ *
+ * @internal
  */
-declare class CircularBuffer<T> {
-    private readonly readIdx;
+declare class CircularBuffer {
+    private readIdx;
     private writeIdx;
-    private items;
+    private readonly items;
     private readonly maxArrayIdx;
+    size: number;
     /**
-     * @param size - Buffer size
-     * @returns CircularBuffer
+     * @param size - Buffer size. @defaultValue defaultBufferSize
+     * @returns CircularBuffer.
      */
     constructor(size?: number);
     /**
-     * Puts data into buffer
+     * Checks whether the buffer is empty.
+     *
+     * @returns Whether the buffer is empty.
+     */
+    empty(): boolean;
+    /**
+     * Checks whether the buffer is full.
+     *
+     * @returns Whether the buffer is full.
+     */
+    full(): boolean;
+    /**
+     * Puts number into buffer.
+     *
+     * @param number - Number to put into buffer.
+     */
+    put(number: number): void;
+    /**
+     * Gets number from buffer.
+     *
+     * @returns Number from buffer.
+     */
+    get(): number | undefined;
+    /**
+     * Returns buffer as numbers' array.
+     *
+     * @returns Numbers' array.
+     */
+    toArray(): number[];
+    /**
+     * Checks the buffer size.
+     *
+     * @param size - Buffer size.
+     */
+    private checkSize;
+}
+
+/**
+ * Fixed priority queue node.
+ *
+ * @typeParam T - Type of priority queue node data.
+ * @internal
+ */
+interface FixedPriorityQueueNode<T> {
+    data: T;
+    priority: number;
+}
+/**
+ * Fixed priority queue.
+ *
+ * @typeParam T - Type of fixed priority queue data.
+ * @internal
+ */
+declare class FixedPriorityQueue<T> {
+    private start;
+    private readonly nodeArray;
+    /** The fixed priority queue capacity. */
+    readonly capacity: number;
+    /** The fixed priority queue size. */
+    size: number;
+    /** Whether to enable priority. */
+    enablePriority: boolean;
+    /**
+     * Constructs a fixed priority queue.
+     *
+     * @param size - Fixed priority queue size. @defaultValue defaultQueueSize
+     * @param enablePriority - Whether to enable priority. @defaultValue false
+     * @returns FixedPriorityQueue.
+     */
+    constructor(size?: number, enablePriority?: boolean);
+    /**
+     * Checks if the fixed priority queue is empty.
+     *
+     * @returns `true` if the fixed priority queue is empty, `false` otherwise.
+     */
+    empty(): boolean;
+    /**
+     * Checks if the fixed priority queue is full.
+     *
+     * @returns `true` if the fixed priority queue is full, `false` otherwise.
+     */
+    full(): boolean;
+    /**
+     * Enqueue data into the fixed priority queue.
+     *
+     * @param data - Data to enqueue.
+     * @param priority - Priority of the data. Lower values have higher priority.
+     * @returns The new size of the priority queue.
+     * @throws If the fixed priority queue is full.
+     */
+    enqueue(data: T, priority?: number): number;
+    /**
+     * Gets data from the fixed priority queue.
+     *
+     * @param index - The index of the data to get.
+     * @returns The data at the index or `undefined` if the fixed priority queue is empty or the index is out of bounds.
+     */
+    get(index: number): T | undefined;
+    /**
+     * Dequeue data from the fixed priority queue.
+     *
+     * @returns The dequeued data or `undefined` if the priority queue is empty.
+     */
+    dequeue(): T | undefined;
+    /**
+     * Clears the fixed priority queue.
+     */
+    clear(): void;
+    /**
+     * Returns an iterator for the fixed priority queue.
      *
-     * @param data - Data to push
+     * @returns An iterator for the fixed priority queue.
+     * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
      */
-    put(data: T): void;
+    [Symbol.iterator](): Iterator<T>;
     /**
-     * Returns buffer as array
+     * Checks the queue size.
      *
-     * @returns T[]
+     * @param size - Queue size.
      */
-    toArray(): T[];
     private checkSize;
 }
 
@@ -587,7 +699,7 @@ interface MeasurementStatistics {
     /**
      * Measurement history.
      */
-    readonly history: CircularBuffer<number>;
+    readonly history: CircularBuffer;
 }
 /**
  * Event loop utilization measurement statistics.
@@ -769,6 +881,7 @@ interface WorkerNodeOptions {
     env?: Record<string, unknown>;
     tasksQueueBackPressureSize: number | undefined;
     tasksQueueBucketSize: number | undefined;
+    tasksQueuePriority: boolean | undefined;
 }
 /**
  * Worker node interface.
@@ -804,6 +917,12 @@ interface IWorkerNode<Worker extends IWorker, Data = unknown> extends EventEmitt
      * This is the number of tasks that can be enqueued before the worker node has back pressure.
      */
     tasksQueueBackPressureSize: number;
+    /**
+     * Sets tasks queue priority.
+     *
+     * @param enablePriority - Whether to enable tasks queue priority.
+     */
+    readonly setTasksQueuePriority: (enablePriority: boolean) => void;
     /**
      * Tasks queue size.
      *
@@ -1573,7 +1692,7 @@ declare abstract class AbstractPool<Worker extends IWorker, Data = unknown, Resp
      * Chooses a worker node for the next task.
      *
      * @param name - The task function name.
-     * @returns The chosen worker node key
+     * @returns The chosen worker node key.
      */
     private chooseWorkerNode;
     /**
@@ -1657,6 +1776,7 @@ declare abstract class AbstractPool<Worker extends IWorker, Data = unknown, Resp
     private readonly handleWorkerNodeIdleEvent;
     private readonly workerNodeStealTask;
     private readonly handleWorkerNodeBackPressureEvent;
+    private setTasksQueuePriority;
     /**
      * This method is the message listener registered on each worker.
      */
@@ -1677,6 +1797,7 @@ declare abstract class AbstractPool<Worker extends IWorker, Data = unknown, Resp
      * @returns The worker information.
      */
     protected getWorkerInfo(workerNodeKey: number): WorkerInfo | undefined;
+    private getTasksQueuePriority;
     /**
      * Creates a worker node.
      *
@@ -1874,9 +1995,8 @@ declare class DynamicThreadPool<Data = unknown, Response = unknown> extends Fixe
  * @typeParam T - Type of priority queue node data.
  * @internal
  */
-interface PriorityQueueNode<T> {
-    data: T;
-    priority: number;
+interface PriorityQueueNode<T> extends FixedPriorityQueue<T> {
+    next?: FixedPriorityQueue<T>;
 }
 /**
  * Priority queue.
@@ -1885,23 +2005,29 @@ interface PriorityQueueNode<T> {
  * @internal
  */
 declare class PriorityQueue<T> {
-    private nodeArray;
-    /** Prioritized bucket size. */
+    private head;
+    private tail;
     private readonly bucketSize;
-    /** The size of the priority queue. */
-    size: number;
-    /** The maximum size of the priority queue. */
+    /** The priority queue maximum size. */
     maxSize: number;
-    /**
-     * The number of filled prioritized buckets.
-     */
-    get buckets(): number;
     /**
      * Constructs a priority queue.
      *
-     * @param bucketSize - Prioritized bucket size. @defaultValue Number.POSITIVE_INFINITY
+     * @param bucketSize - Prioritized bucket size. @defaultValue defaultBucketSize
+     * @param enablePriority - Whether to enable priority. @defaultValue false
+     * @returns PriorityQueue.
+     */
+    constructor(bucketSize?: number, enablePriority?: boolean);
+    /**
+     * The priority queue size.
      */
-    constructor(bucketSize?: number);
+    get size(): number;
+    get enablePriority(): boolean;
+    set enablePriority(enablePriority: boolean);
+    /**
+     * The number of filled prioritized buckets.
+     */
+    get buckets(): number;
     /**
      * Enqueue data into the priority queue.
      *
@@ -1913,20 +2039,10 @@ declare class PriorityQueue<T> {
     /**
      * Dequeue data from the priority queue.
      *
-     * @param bucket - The prioritized bucket to dequeue from. @defaultValue 0
+     * @param bucket - The prioritized bucket to dequeue from.
      * @returns The dequeued data or `undefined` if the priority queue is empty.
      */
     dequeue(bucket?: number): T | undefined;
-    /**
-     * Peeks at the first data.
-     * @returns The first data or `undefined` if the priority queue is empty.
-     */
-    peekFirst(): T | undefined;
-    /**
-     * Peeks at the last data.
-     * @returns The last data or `undefined` if the priority queue is empty.
-     */
-    peekLast(): T | undefined;
     /**
      * Clears the priority queue.
      */
@@ -1938,18 +2054,6 @@ declare class PriorityQueue<T> {
      * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
      */
     [Symbol.iterator](): Iterator<T>;
-    /**
-     * Increments the size of the priority queue.
-     *
-     * @returns The new size of the priority queue.
-     */
-    private incrementSize;
-    /**
-     * Decrements the size of the priority queue.
-     *
-     * @returns The new size of the priority queue.
-     */
-    private decrementSize;
 }
 
 /**
@@ -2201,4 +2305,4 @@ declare class ThreadWorker<Data = unknown, Response = unknown> extends AbstractW
     protected handleError(error: Error | string): string;
 }
 
-export { AbstractPool, AbstractWorker, CircularBuffer, type ClusterPoolOptions, ClusterWorker, DynamicClusterPool, DynamicThreadPool, type ErrorHandler, type EventHandler, type EventLoopUtilizationMeasurementStatistics, type ExitHandler, FixedClusterPool, FixedThreadPool, type IPool, type IWorker, type IWorkerChoiceStrategy, type IWorkerNode, type KillBehavior, KillBehaviors, type KillHandler, type Measurement, type MeasurementOptions, type MeasurementStatistics, type MeasurementStatisticsRequirements, Measurements, type MessageHandler, type MessageValue, type OnlineHandler, type PoolEvent, PoolEvents, type PoolInfo, type PoolOptions, type PoolType, PoolTypes, PriorityQueue, type PriorityQueueNode, type PromiseResponseWrapper, type StrategyData, type StrategyPolicy, type Task, type TaskAsyncFunction, type TaskFunction, type TaskFunctionObject, type TaskFunctionOperationResult, type TaskFunctionProperties, type TaskFunctions, type TaskPerformance, type TaskStatistics, type TaskStatisticsRequirements, type TaskSyncFunction, type TasksQueueOptions, type ThreadPoolOptions, ThreadWorker, WorkerChoiceStrategies, WorkerChoiceStrategiesContext, type WorkerChoiceStrategy, type WorkerChoiceStrategyOptions, type WorkerError, type WorkerInfo, type WorkerNodeEventDetail, type WorkerNodeOptions, type WorkerOptions, type WorkerStatistics, type WorkerType, WorkerTypes, type WorkerUsage, type Writable, availableParallelism };
+export { AbstractPool, AbstractWorker, CircularBuffer, type ClusterPoolOptions, ClusterWorker, DynamicClusterPool, DynamicThreadPool, type ErrorHandler, type EventHandler, type EventLoopUtilizationMeasurementStatistics, type ExitHandler, FixedClusterPool, FixedPriorityQueue, type FixedPriorityQueueNode, FixedThreadPool, type IPool, type IWorker, type IWorkerChoiceStrategy, type IWorkerNode, type KillBehavior, KillBehaviors, type KillHandler, type Measurement, type MeasurementOptions, type MeasurementStatistics, type MeasurementStatisticsRequirements, Measurements, type MessageHandler, type MessageValue, type OnlineHandler, type PoolEvent, PoolEvents, type PoolInfo, type PoolOptions, type PoolType, PoolTypes, PriorityQueue, type PriorityQueueNode, type PromiseResponseWrapper, type StrategyData, type StrategyPolicy, type Task, type TaskAsyncFunction, type TaskFunction, type TaskFunctionObject, type TaskFunctionOperationResult, type TaskFunctionProperties, type TaskFunctions, type TaskPerformance, type TaskStatistics, type TaskStatisticsRequirements, type TaskSyncFunction, type TasksQueueOptions, type ThreadPoolOptions, ThreadWorker, WorkerChoiceStrategies, WorkerChoiceStrategiesContext, type WorkerChoiceStrategy, type WorkerChoiceStrategyOptions, type WorkerError, type WorkerInfo, type WorkerNodeEventDetail, type WorkerNodeOptions, type WorkerOptions, type WorkerStatistics, type WorkerType, WorkerTypes, type WorkerUsage, type Writable, availableParallelism };