X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=b1b504d59b22bba2aca61becc898fa87167c5c6c;hb=d8163b08686d39aca2a2c9896176ceede981672e;hp=118b283246e8fc71691911ea816726a3b716ff01;hpb=5b7d00b4d0f276c521db9f2145104a64f441d2fb;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 118b2832..b1b504d5 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,5 +1,5 @@ import type { TransferListItem } from 'node:worker_threads' -import type { EventEmitter, EventEmitterAsyncResource } from 'node:events' +import type { EventEmitterAsyncResource } from 'node:events' import type { TaskFunction } from '../worker/task-functions' import type { ErrorHandler, @@ -110,13 +110,13 @@ export interface TasksQueueOptions { */ readonly concurrency?: number /** - * Whether to enable task stealing. + * Whether to enable task stealing on idle. * * @defaultValue true */ readonly taskStealing?: boolean /** - * Whether to enable tasks stealing on back pressure. + * Whether to enable tasks stealing under back pressure. * * @defaultValue true */ @@ -235,13 +235,13 @@ export interface IPool< * - `'taskError'`: Emitted when an error occurs while executing a task. * - `'backPressure'`: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size \>= maximum queue size). */ - readonly emitter?: EventEmitter | EventEmitterAsyncResource + readonly emitter?: EventEmitterAsyncResource /** * Executes the specified function in the worker constructor with the task data input parameter. * * @param data - The optional task input data for the specified task function. This can only be structured-cloneable data. * @param name - The optional name of the task function to execute. If not specified, the default task function will be executed. - * @param transferList - An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards. + * @param transferList - An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards. * @returns Promise that will be fulfilled when the task is completed. */ readonly execute: (