poolifier 2.6.36 → 2.6.38

package/lib/pools/selection-strategies/selection-strategies-types.d.ts

@@ -1,200 +0,0 @@
-/**
- * Enumeration of worker choice strategies.
- */
-export declare const WorkerChoiceStrategies: Readonly<{
-    /**
-     * Round robin worker selection strategy.
-     */
-    readonly ROUND_ROBIN: "ROUND_ROBIN";
-    /**
-     * Least used worker selection strategy.
-     */
-    readonly LEAST_USED: "LEAST_USED";
-    /**
-     * Least busy worker selection strategy.
-     */
-    readonly LEAST_BUSY: "LEAST_BUSY";
-    /**
-     * Least ELU worker selection strategy.
-     */
-    readonly LEAST_ELU: "LEAST_ELU";
-    /**
-     * Fair share worker selection strategy.
-     */
-    readonly FAIR_SHARE: "FAIR_SHARE";
-    /**
-     * Weighted round robin worker selection strategy.
-     */
-    readonly WEIGHTED_ROUND_ROBIN: "WEIGHTED_ROUND_ROBIN";
-    /**
-     * Interleaved weighted round robin worker selection strategy.
-     *
-     * @experimental
-     */
-    readonly INTERLEAVED_WEIGHTED_ROUND_ROBIN: "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
-}>;
-/**
- * Worker choice strategy.
- */
-export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies;
-/**
- * Enumeration of measurements.
- */
-export declare const Measurements: Readonly<{
-    readonly runTime: "runTime";
-    readonly waitTime: "waitTime";
-    readonly elu: "elu";
-}>;
-/**
- * Measurement.
- */
-export type Measurement = keyof typeof Measurements;
-/**
- * Measurement options.
- */
-export interface MeasurementOptions {
-    /**
-     * Set measurement median.
-     */
-    readonly median: boolean;
-}
-/**
- * Worker choice strategy options.
- */
-export interface WorkerChoiceStrategyOptions {
-    /**
-     * Number of worker choice retries to perform if no worker is eligible.
-     *
-     * @defaultValue 6
-     */
-    readonly choiceRetries?: number;
-    /**
-     * Measurement to use in worker choice strategy supporting it.
-     */
-    readonly measurement?: Measurement;
-    /**
-     * Runtime options.
-     *
-     * @defaultValue \{ median: false \}
-     */
-    readonly runTime?: MeasurementOptions;
-    /**
-     * Wait time options.
-     *
-     * @defaultValue \{ median: false \}
-     */
-    readonly waitTime?: MeasurementOptions;
-    /**
-     * Event loop utilization options.
-     *
-     * @defaultValue \{ median: false \}
-     */
-    readonly elu?: MeasurementOptions;
-    /**
-     * Worker weights to use for weighted round robin worker selection strategies.
-     * A weight is tasks maximum execution time in milliseconds for a worker node.
-     *
-     * @defaultValue Weights computed automatically given the CPU performance.
-     */
-    readonly weights?: Record<number, number>;
-}
-/**
- * Measurement statistics requirements.
- *
- * @internal
- */
-export interface MeasurementStatisticsRequirements {
-    /**
-     * Requires measurement aggregate.
-     */
-    aggregate: boolean;
-    /**
-     * Requires measurement average.
-     */
-    average: boolean;
-    /**
-     * Requires measurement median.
-     */
-    median: boolean;
-}
-/**
- * Pool worker node worker usage statistics requirements.
- *
- * @internal
- */
-export interface TaskStatisticsRequirements {
-    /**
-     * Tasks runtime requirements.
-     */
-    readonly runTime: MeasurementStatisticsRequirements;
-    /**
-     * Tasks wait time requirements.
-     */
-    readonly waitTime: MeasurementStatisticsRequirements;
-    /**
-     * Tasks event loop utilization requirements.
-     */
-    readonly elu: MeasurementStatisticsRequirements;
-}
-/**
- * Strategy policy.
- *
- * @internal
- */
-export interface StrategyPolicy {
-    /**
-     * Expects tasks execution on the newly created dynamic worker.
-     */
-    readonly dynamicWorkerUsage: boolean;
-    /**
-     * Expects the newly created dynamic worker to be flagged as ready.
-     */
-    readonly dynamicWorkerReady: boolean;
-}
-/**
- * Worker choice strategy interface.
- *
- * @internal
- */
-export interface IWorkerChoiceStrategy {
-    /**
-     * Strategy policy.
-     */
-    readonly strategyPolicy: StrategyPolicy;
-    /**
-     * Tasks statistics requirements.
-     */
-    readonly taskStatisticsRequirements: TaskStatisticsRequirements;
-    /**
-     * Resets strategy internals.
-     *
-     * @returns `true` if the reset is successful, `false` otherwise.
-     */
-    readonly reset: () => boolean;
-    /**
-     * Updates the worker node key strategy internals.
-     *
-     * @returns `true` if the update is successful, `false` otherwise.
-     */
-    readonly update: (workerNodeKey: number) => boolean;
-    /**
-     * Chooses a worker node in the pool and returns its key.
-     * If the worker node is not eligible, `undefined` is returned.
-     *
-     * @returns The worker node key or `undefined`.
-     */
-    readonly choose: () => number | undefined;
-    /**
-     * Removes the worker node key from strategy internals.
-     *
-     * @param workerNodeKey - The worker node key.
-     * @returns `true` if the worker node key is removed, `false` otherwise.
-     */
-    readonly remove: (workerNodeKey: number) => boolean;
-    /**
-     * Sets the worker choice strategy options.
-     *
-     * @param opts - The worker choice strategy options.
-     */
-    readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void;
-}

package/lib/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.d.ts

@@ -1,35 +0,0 @@
-import type { IWorker } from '../worker';
-import type { IPool } from '../pool';
-import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy';
-import type { IWorkerChoiceStrategy, TaskStatisticsRequirements, WorkerChoiceStrategyOptions } from './selection-strategies-types';
-/**
- * Selects the next worker with a weighted round robin scheduling algorithm.
- * Loosely modeled after the weighted round robin queueing algorithm: https://en.wikipedia.org/wiki/Weighted_round_robin.
- *
- * @typeParam Worker - Type of worker which manages the strategy.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
- */
-export declare class WeightedRoundRobinWorkerChoiceStrategy<Worker extends IWorker, Data = unknown, Response = unknown> extends AbstractWorkerChoiceStrategy<Worker, Data, Response> implements IWorkerChoiceStrategy {
-    /** @inheritDoc */
-    readonly taskStatisticsRequirements: TaskStatisticsRequirements;
-    /**
-     * Default worker weight.
-     */
-    private readonly defaultWorkerWeight;
-    /**
-     * Worker virtual task runtime.
-     */
-    private workerVirtualTaskRunTime;
-    /** @inheritDoc */
-    constructor(pool: IPool<Worker, Data, Response>, opts?: WorkerChoiceStrategyOptions);
-    /** @inheritDoc */
-    reset(): boolean;
-    /** @inheritDoc */
-    update(): boolean;
-    /** @inheritDoc */
-    choose(): number | undefined;
-    /** @inheritDoc */
-    remove(workerNodeKey: number): boolean;
-    private weightedRoundRobinNextWorkerNodeKey;
-}

package/lib/pools/selection-strategies/worker-choice-strategy-context.d.ts

@@ -1,71 +0,0 @@
-import type { IPool } from '../pool';
-import type { IWorker } from '../worker';
-import type { StrategyPolicy, TaskStatisticsRequirements, WorkerChoiceStrategy, WorkerChoiceStrategyOptions } from './selection-strategies-types';
-/**
- * The worker choice strategy context.
- *
- * @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
- */
-export declare class WorkerChoiceStrategyContext<Worker extends IWorker, Data = unknown, Response = unknown> {
-    private workerChoiceStrategy;
-    private opts;
-    private readonly workerChoiceStrategies;
-    /**
-     * The number of times the worker choice strategy in the context has been retried.
-     */
-    private choiceRetriesCount;
-    /**
-     * Worker choice strategy context constructor.
-     *
-     * @param pool - The pool instance.
-     * @param workerChoiceStrategy - The worker choice strategy.
-     * @param opts - The worker choice strategy options.
-     */
-    constructor(pool: IPool<Worker, Data, Response>, workerChoiceStrategy?: WorkerChoiceStrategy, opts?: WorkerChoiceStrategyOptions);
-    /**
-     * Gets the strategy policy in the context.
-     *
-     * @returns The strategy policy.
-     */
-    getStrategyPolicy(): StrategyPolicy;
-    /**
-     * Gets the worker choice strategy in the context task statistics requirements.
-     *
-     * @returns The task statistics requirements.
-     */
-    getTaskStatisticsRequirements(): TaskStatisticsRequirements;
-    /**
-     * Sets the worker choice strategy to use in the context.
-     *
-     * @param workerChoiceStrategy - The worker choice strategy to set.
-     */
-    setWorkerChoiceStrategy(workerChoiceStrategy: WorkerChoiceStrategy): void;
-    /**
-     * Updates the worker node key in the worker choice strategy in the context internals.
-     *
-     * @returns `true` if the update is successful, `false` otherwise.
-     */
-    update(workerNodeKey: number): boolean;
-    /**
-     * Executes the worker choice strategy in the context algorithm.
-     *
-     * @returns The key of the worker node.
-     * @throws {@link https://nodejs.org/api/errors.html#class-error} If after configured retries the worker node key is null or undefined .
-     */
-    execute(): number;
-    /**
-     * Removes the worker node key from the worker choice strategy in the context.
-     *
-     * @param workerNodeKey - The worker node key.
-     * @returns `true` if the removal is successful, `false` otherwise.
-     */
-    remove(workerNodeKey: number): boolean;
-    /**
-     * Sets the worker choice strategies in the context options.
-     *
-     * @param opts - The worker choice strategy options.
-     */
-    setOptions(opts: WorkerChoiceStrategyOptions): void;
-}

package/lib/pools/thread/dynamic.d.ts

@@ -1,29 +0,0 @@
-import { type PoolType } from '../pool';
-import { FixedThreadPool, type ThreadPoolOptions } from './fixed';
-/**
- * A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
- *
- * This thread pool creates new threads when the others are busy, up to the maximum number of threads.
- * When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's `emitter`.
- *
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
- * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
- * @since 0.0.1
- */
-export declare class DynamicThreadPool<Data = unknown, Response = unknown> extends FixedThreadPool<Data, Response> {
-    protected readonly max: number;
-    /**
-     * Constructs a new poolifier dynamic thread pool.
-     *
-     * @param min - Minimum number of threads which are always active.
-     * @param max - Maximum number of threads that can be created by this pool.
-     * @param filePath - Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
-     * @param opts - Options for this dynamic thread pool.
-     */
-    constructor(min: number, max: number, filePath: string, opts?: ThreadPoolOptions);
-    /** @inheritDoc */
-    protected get type(): PoolType;
-    /** @inheritDoc */
-    protected get busy(): boolean;
-}

package/lib/pools/thread/fixed.d.ts

@@ -1,54 +0,0 @@
-/// <reference types="node" />
-import { type TransferListItem, Worker, type WorkerOptions } from 'node:worker_threads';
-import type { MessageValue } from '../../utility-types';
-import { AbstractPool } from '../abstract-pool';
-import { type PoolOptions, type PoolType } from '../pool';
-import { type WorkerType } from '../worker';
-/**
- * Options for a poolifier thread pool.
- */
-export interface ThreadPoolOptions extends PoolOptions<Worker> {
-    /**
-     * Worker options.
-     *
-     * @see https://nodejs.org/api/worker_threads.html#new-workerfilename-options
-     */
-    workerOptions?: WorkerOptions;
-}
-/**
- * A thread pool with a fixed number of threads.
- *
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
- * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
- * @since 0.0.1
- */
-export declare class FixedThreadPool<Data = unknown, Response = unknown> extends AbstractPool<Worker, Data, Response> {
-    protected readonly opts: ThreadPoolOptions;
-    /**
-     * Constructs a new poolifier fixed thread pool.
-     *
-     * @param numberOfThreads - Number of threads for this pool.
-     * @param filePath - Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
-     * @param opts - Options for this fixed thread pool.
-     */
-    constructor(numberOfThreads: number, filePath: string, opts?: ThreadPoolOptions);
-    /** @inheritDoc */
-    protected isMain(): boolean;
-    /** @inheritDoc */
-    protected destroyWorkerNode(workerNodeKey: number): Promise<void>;
-    /** @inheritDoc */
-    protected sendToWorker(workerNodeKey: number, message: MessageValue<Data>, transferList?: TransferListItem[]): void;
-    /** @inheritDoc */
-    protected sendStartupMessageToWorker(workerNodeKey: number): void;
-    /** @inheritDoc */
-    protected registerWorkerMessageListener<Message extends Data | Response>(workerNodeKey: number, listener: (message: MessageValue<Message>) => void): void;
-    /** @inheritDoc */
-    protected createWorker(): Worker;
-    /** @inheritDoc */
-    protected get type(): PoolType;
-    /** @inheritDoc */
-    protected get worker(): WorkerType;
-    /** @inheritDoc */
-    protected get busy(): boolean;
-}

package/lib/pools/version.d.ts

@@ -1 +0,0 @@
-export declare const version = "2.6.36";

package/lib/pools/worker-node.d.ts

@@ -1,69 +0,0 @@
-/// <reference types="node" />
-import { MessageChannel } from 'node:worker_threads';
-import type { Task } from '../utility-types';
-import { type IWorker, type IWorkerNode, type WorkerInfo, type WorkerType, type WorkerUsage } from './worker';
-/**
- * Worker node.
- *
- * @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- */
-export declare class WorkerNode<Worker extends IWorker, Data = unknown> implements IWorkerNode<Worker, Data> {
-    /** @inheritdoc */
-    readonly worker: Worker;
-    /** @inheritdoc */
-    readonly info: WorkerInfo;
-    /** @inheritdoc */
-    usage: WorkerUsage;
-    /** @inheritdoc */
-    messageChannel?: MessageChannel;
-    /** @inheritdoc */
-    tasksQueueBackPressureSize: number;
-    /** @inheritdoc */
-    onBackPressure?: (workerId: number) => void;
-    /** @inheritdoc */
-    onEmptyQueue?: (workerId: number) => void;
-    private readonly tasksQueue;
-    private onEmptyQueueCount;
-    private readonly taskFunctionsUsage;
-    /**
-     * Constructs a new worker node.
-     *
-     * @param worker - The worker.
-     * @param workerType - The worker type.
-     * @param tasksQueueBackPressureSize - The tasks queue back pressure size.
-     */
-    constructor(worker: Worker, workerType: WorkerType, tasksQueueBackPressureSize: number);
-    /** @inheritdoc */
-    tasksQueueSize(): number;
-    /** @inheritdoc */
-    enqueueTask(task: Task<Data>): number;
-    /** @inheritdoc */
-    unshiftTask(task: Task<Data>): number;
-    /** @inheritdoc */
-    dequeueTask(): Task<Data> | undefined;
-    /** @inheritdoc */
-    popTask(): Task<Data> | undefined;
-    /** @inheritdoc */
-    clearTasksQueue(): void;
-    /** @inheritdoc */
-    hasBackPressure(): boolean;
-    /** @inheritdoc */
-    resetUsage(): void;
-    /** @inheritdoc */
-    closeChannel(): void;
-    /** @inheritdoc */
-    getTaskFunctionWorkerUsage(name: string): WorkerUsage | undefined;
-    private startOnEmptyQueue;
-    private initWorkerInfo;
-    private initWorkerUsage;
-    private initTaskFunctionWorkerUsage;
-    /**
-     * Gets the worker id.
-     *
-     * @param worker - The worker.
-     * @param workerType - The worker type.
-     * @returns The worker id.
-     */
-    private getWorkerId;
-}