poolifier 2.6.37 → 2.6.39

package/lib/pools/version.d.ts

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

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

@@ -1,60 +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 WorkerNodeEventCallback, 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?: WorkerNodeEventCallback;
-    /** @inheritdoc */
-    onEmptyQueue?: WorkerNodeEventCallback;
-    private readonly tasksQueue;
-    private onEmptyQueueCount;
-    private readonly taskFunctionsUsage;
-    /**
-     * Constructs a new worker node.
-     *
-     * @param worker - The worker.
-     * @param tasksQueueBackPressureSize - The tasks queue back pressure size.
-     */
-    constructor(worker: Worker, 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;
-}

package/lib/pools/worker.d.ts

@@ -1,277 +0,0 @@
-/// <reference types="node" />
-import type { MessageChannel } from 'node:worker_threads';
-import type { CircularArray } from '../circular-array';
-import type { Task } from '../utility-types';
-/**
- * Callback invoked when the worker has started successfully.
- */
-export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void;
-/**
- * Callback invoked if the worker has received a message.
- */
-export type MessageHandler<Worker extends IWorker> = (this: Worker, message: unknown) => void;
-/**
- * Callback invoked if the worker raised an error.
- */
-export type ErrorHandler<Worker extends IWorker> = (this: Worker, error: Error) => void;
-/**
- * Callback invoked when the worker exits successfully.
- */
-export type ExitHandler<Worker extends IWorker> = (this: Worker, exitCode: number) => void;
-/**
- * Measurement statistics.
- *
- * @internal
- */
-export interface MeasurementStatistics {
-    /**
-     * Measurement aggregate.
-     */
-    aggregate?: number;
-    /**
-     * Measurement minimum.
-     */
-    minimum?: number;
-    /**
-     * Measurement maximum.
-     */
-    maximum?: number;
-    /**
-     * Measurement average.
-     */
-    average?: number;
-    /**
-     * Measurement median.
-     */
-    median?: number;
-    /**
-     * Measurement history.
-     */
-    readonly history: CircularArray<number>;
-}
-/**
- * Event loop utilization measurement statistics.
- *
- * @internal
- */
-export interface EventLoopUtilizationMeasurementStatistics {
-    readonly idle: MeasurementStatistics;
-    readonly active: MeasurementStatistics;
-    utilization?: number;
-}
-/**
- * Task statistics.
- *
- * @internal
- */
-export interface TaskStatistics {
-    /**
-     * Number of executed tasks.
-     */
-    executed: number;
-    /**
-     * Number of executing tasks.
-     */
-    executing: number;
-    /**
-     * Number of queued tasks.
-     */
-    readonly queued: number;
-    /**
-     * Maximum number of queued tasks.
-     */
-    readonly maxQueued?: number;
-    /**
-     * Number of stolen tasks.
-     */
-    stolen: number;
-    /**
-     * Number of failed tasks.
-     */
-    failed: number;
-}
-/**
- * Enumeration of worker types.
- */
-export declare const WorkerTypes: Readonly<{
-    readonly thread: "thread";
-    readonly cluster: "cluster";
-}>;
-/**
- * Worker type.
- */
-export type WorkerType = keyof typeof WorkerTypes;
-/**
- * Worker information.
- *
- * @internal
- */
-export interface WorkerInfo {
-    /**
-     * Worker id.
-     */
-    readonly id: number | undefined;
-    /**
-     * Worker type.
-     */
-    type: WorkerType;
-    /**
-     * Dynamic flag.
-     */
-    dynamic: boolean;
-    /**
-     * Ready flag.
-     */
-    ready: boolean;
-    /**
-     * Task function names.
-     */
-    taskFunctions?: string[];
-}
-/**
- * Worker usage statistics.
- *
- * @internal
- */
-export interface WorkerUsage {
-    /**
-     * Tasks statistics.
-     */
-    readonly tasks: TaskStatistics;
-    /**
-     * Tasks runtime statistics.
-     */
-    readonly runTime: MeasurementStatistics;
-    /**
-     * Tasks wait time statistics.
-     */
-    readonly waitTime: MeasurementStatistics;
-    /**
-     * Tasks event loop utilization statistics.
-     */
-    readonly elu: EventLoopUtilizationMeasurementStatistics;
-}
-/**
- * Worker interface.
- */
-export interface IWorker {
-    /**
-     * Worker id.
-     */
-    readonly id?: number;
-    readonly threadId?: number;
-    /**
-     * Registers an event listener.
-     *
-     * @param event - The event.
-     * @param handler - The event handler.
-     */
-    readonly on: ((event: 'online', handler: OnlineHandler<this>) => void) & ((event: 'message', handler: MessageHandler<this>) => void) & ((event: 'error', handler: ErrorHandler<this>) => void) & ((event: 'exit', handler: ExitHandler<this>) => void);
-    /**
-     * Registers a listener to the exit event that will only be performed once.
-     *
-     * @param event - The `'exit'` event.
-     * @param handler - The exit handler.
-     */
-    readonly once: (event: 'exit', handler: ExitHandler<this>) => void;
-}
-export type WorkerNodeEventCallback = (workerId: number) => void;
-/**
- * Worker node interface.
- *
- * @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @internal
- */
-export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
-    /**
-     * Worker.
-     */
-    readonly worker: Worker;
-    /**
-     * Worker info.
-     */
-    readonly info: WorkerInfo;
-    /**
-     * Worker usage statistics.
-     */
-    usage: WorkerUsage;
-    /**
-     * Message channel (worker_threads only).
-     */
-    readonly messageChannel?: MessageChannel;
-    /**
-     * Tasks queue back pressure size.
-     * This is the number of tasks that can be enqueued before the worker node has back pressure.
-     */
-    tasksQueueBackPressureSize: number;
-    /**
-     * Callback invoked when worker node tasks queue is back pressured.
-     *
-     * @param workerId - The worker id.
-     */
-    onBackPressure?: WorkerNodeEventCallback;
-    /**
-     * Callback invoked when worker node tasks queue is empty.
-     *
-     * @param workerId - The worker id.
-     */
-    onEmptyQueue?: WorkerNodeEventCallback;
-    /**
-     * Tasks queue size.
-     *
-     * @returns The tasks queue size.
-     */
-    readonly tasksQueueSize: () => number;
-    /**
-     * Enqueue task.
-     *
-     * @param task - The task to queue.
-     * @returns The tasks queue size.
-     */
-    readonly enqueueTask: (task: Task<Data>) => number;
-    /**
-     * Prepends a task to the tasks queue.
-     *
-     * @param task - The task to prepend.
-     * @returns The tasks queue size.
-     */
-    readonly unshiftTask: (task: Task<Data>) => number;
-    /**
-     * Dequeue task.
-     *
-     * @returns The dequeued task.
-     */
-    readonly dequeueTask: () => Task<Data> | undefined;
-    /**
-     * Pops a task from the tasks queue.
-     *
-     * @returns The popped task.
-     */
-    readonly popTask: () => Task<Data> | undefined;
-    /**
-     * Clears tasks queue.
-     */
-    readonly clearTasksQueue: () => void;
-    /**
-     * Whether the worker node has back pressure (i.e. its tasks queue is full).
-     *
-     * @returns `true` if the worker node has back pressure, `false` otherwise.
-     */
-    readonly hasBackPressure: () => boolean;
-    /**
-     * Resets usage statistics.
-     */
-    readonly resetUsage: () => void;
-    /**
-     * Closes communication channel.
-     */
-    readonly closeChannel: () => void;
-    /**
-     * Gets task function worker usage statistics.
-     *
-     * @param name - The task function name.
-     * @returns The task function worker usage statistics if the task function worker usage statistics are initialized, `undefined` otherwise.
-     */
-    readonly getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined;
-}

package/lib/utility-types.d.ts

@@ -1,152 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import type { EventLoopUtilization } from 'node:perf_hooks';
-import type { MessagePort, TransferListItem } from 'node:worker_threads';
-import type { KillBehavior } from './worker/worker-options';
-/**
- * Task error.
- *
- * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
- */
-export interface TaskError<Data = unknown> {
-    /**
-     * Task name triggering the error.
-     */
-    readonly name: string;
-    /**
-     * Error message.
-     */
-    readonly message: string;
-    /**
-     * Data triggering the error.
-     */
-    readonly data?: Data;
-}
-/**
- * Task performance.
- *
- * @internal
- */
-export interface TaskPerformance {
-    /**
-     * Task name.
-     */
-    readonly name: string;
-    /**
-     * Task performance timestamp.
-     */
-    readonly timestamp: number;
-    /**
-     * Task runtime.
-     */
-    readonly runTime?: number;
-    /**
-     * Task event loop utilization.
-     */
-    readonly elu?: EventLoopUtilization;
-}
-/**
- * Performance statistics computation.
- *
- * @internal
- */
-export interface WorkerStatistics {
-    runTime: boolean;
-    elu: boolean;
-}
-/**
- * Message object that is passed as a task between main worker and worker.
- *
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
- * @internal
- */
-export interface Task<Data = unknown> {
-    /**
-     * Worker id.
-     */
-    readonly workerId: number;
-    /**
-     * Task name.
-     */
-    readonly name?: string;
-    /**
-     * Task input data that will be passed to the worker.
-     */
-    readonly data?: Data;
-    /**
-     * Array of transferable objects.
-     */
-    readonly transferList?: TransferListItem[];
-    /**
-     * Timestamp.
-     */
-    readonly timestamp?: number;
-    /**
-     * Task UUID.
-     */
-    readonly taskId?: string;
-}
-/**
- * Message object that is passed between main worker and worker.
- *
- * @typeParam Data - Type of data sent to the worker or execution response. This can only be structured-cloneable data.
- * @typeParam ErrorData - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
- * @internal
- */
-export interface MessageValue<Data = unknown, ErrorData = unknown> extends Task<Data> {
-    /**
-     * Kill code.
-     */
-    readonly kill?: KillBehavior | true | 'success' | 'failure';
-    /**
-     * Task error.
-     */
-    readonly taskError?: TaskError<ErrorData>;
-    /**
-     * Task performance.
-     */
-    readonly taskPerformance?: TaskPerformance;
-    /**
-     * Task function names.
-     */
-    readonly taskFunctions?: string[];
-    /**
-     * Whether the worker computes the given statistics or not.
-     */
-    readonly statistics?: WorkerStatistics;
-    /**
-     * Whether the worker is ready or not.
-     */
-    readonly ready?: boolean;
-    /**
-     * Whether the worker starts or stops its activity check.
-     */
-    readonly checkActive?: boolean;
-    /**
-     * Message port.
-     */
-    readonly port?: MessagePort;
-}
-/**
- * An object holding the task execution response promise resolve/reject callbacks.
- *
- * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
- * @internal
- */
-export interface PromiseResponseWrapper<Response = unknown> {
-    /**
-     * Resolve callback to fulfill the promise.
-     */
-    readonly resolve: (value: Response | PromiseLike<Response>) => void;
-    /**
-     * Reject callback to reject the promise.
-     */
-    readonly reject: (reason?: unknown) => void;
-    /**
-     * The worker node key executing the task.
-     */
-    readonly workerNodeKey: number;
-}
-export type Writable<T> = {
-    -readonly [P in keyof T]: T[P];
-};

package/lib/utils.d.ts

@@ -1,123 +0,0 @@
-import type { MeasurementStatisticsRequirements, WorkerChoiceStrategyOptions } from './pools/selection-strategies/selection-strategies-types';
-import { type IWorker, type MeasurementStatistics, type WorkerType } from './pools/worker';
-/**
- * Default task name.
- */
-export declare const DEFAULT_TASK_NAME = "default";
-/**
- * An intentional empty function.
- */
-export declare const EMPTY_FUNCTION: () => void;
-/**
- * Default worker choice strategy options.
- */
-export declare const DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS: WorkerChoiceStrategyOptions;
-/**
- * Default measurement statistics requirements.
- */
-export declare const DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS: MeasurementStatisticsRequirements;
-/**
- * Returns safe host OS optimized estimate of the default amount of parallelism a pool should use.
- * Always returns a value greater than zero.
- *
- * @returns The host OS optimized maximum pool size.
- * @internal
- */
-export declare const availableParallelism: () => number;
-/**
- * Returns the worker type of the given worker.
- *
- * @param worker - The worker to get the type of.
- * @returns The worker type of the given worker.
- * @internal
- */
-export declare const getWorkerType: <Worker_1 extends IWorker>(worker: Worker_1) => WorkerType | undefined;
-/**
- * Returns the worker id of the given worker.
- *
- * @param worker - The worker to get the id of.
- * @returns The worker id of the given worker.
- * @internal
- */
-export declare const getWorkerId: <Worker_1 extends IWorker>(worker: Worker_1) => number | undefined;
-/**
- * Sleeps for the given amount of milliseconds.
- *
- * @param ms - The amount of milliseconds to sleep.
- * @returns A promise that resolves after the given amount of milliseconds.
- */
-export declare const sleep: (ms: number) => Promise<void>;
-/**
- * Computes the retry delay in milliseconds using an exponential back off algorithm.
- *
- * @param retryNumber - The number of retries that have already been attempted
- * @param delayFactor - The base delay factor in milliseconds
- * @returns Delay in milliseconds
- * @internal
- */
-export declare const exponentialDelay: (retryNumber?: number, delayFactor?: number) => number;
-/**
- * Computes the average of the given data set.
- *
- * @param dataSet - Data set.
- * @returns The average of the given data set.
- * @internal
- */
-export declare const average: (dataSet: number[]) => number;
-/**
- * Computes the median of the given data set.
- *
- * @param dataSet - Data set.
- * @returns The median of the given data set.
- * @internal
- */
-export declare const median: (dataSet: number[]) => number;
-/**
- * Rounds the given number to the given scale.
- * The rounding is done using the "round half away from zero" method.
- *
- * @param num - The number to round.
- * @param scale - The scale to round to.
- * @returns The rounded number.
- */
-export declare const round: (num: number, scale?: number) => number;
-/**
- * Is the given object a plain object?
- *
- * @param obj - The object to check.
- * @returns `true` if the given object is a plain object, `false` otherwise.
- */
-export declare const isPlainObject: (obj: unknown) => boolean;
-/**
- * Detects whether the given value is a kill behavior or not.
- *
- * @typeParam KB - Which specific KillBehavior type to test against.
- * @param killBehavior - Which kind of kill behavior to detect.
- * @param value - Any value.
- * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`.
- * @internal
- */
-export declare const isKillBehavior: <KB extends "SOFT" | "HARD">(killBehavior: KB, value: unknown) => value is KB;
-/**
- * Detects whether the given value is an asynchronous function or not.
- *
- * @param fn - Any value.
- * @returns `true` if `fn` was an asynchronous function, otherwise `false`.
- */
-export declare const isAsyncFunction: (fn: unknown) => fn is (...args: unknown[]) => Promise<unknown>;
-/**
- * Updates the given measurement statistics.
- *
- * @param measurementStatistics - The measurement statistics to update.
- * @param measurementRequirements - The measurement statistics requirements.
- * @param measurementValue - The measurement value.
- * @param numberOfMeasurements - The number of measurements.
- * @internal
- */
-export declare const updateMeasurementStatistics: (measurementStatistics: MeasurementStatistics, measurementRequirements: MeasurementStatisticsRequirements, measurementValue: number) => void;
-/**
- * Generate a cryptographically secure random number in the [0,1[ range
- *
- * @returns A number in the [0,1[ range
- */
-export declare const secureRandom: () => number;