Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

interface IPool<Worker, Data, Response> {
Â Â Â Â addTaskFunction: ((name, fn) => Promise<boolean>);
Â Â Â Â destroy: (() => Promise<void>);
Â Â Â Â emitter?: EventEmitterAsyncResource;
Â Â Â Â enableTasksQueue: ((enable, tasksQueueOptions?) => void);
Â Â Â Â execute: ((data?, name?, transferList?) => Promise<Response>);
Â Â Â Â hasTaskFunction: ((name) => boolean);
Â Â Â Â info: PoolInfo;
Â Â Â Â listTaskFunctionsProperties: (() => TaskFunctionProperties[]);
Â Â Â Â mapExecute: ((data, name?, transferList?) => Promise<Response[]>);
Â Â Â Â removeTaskFunction: ((name) => Promise<boolean>);
Â Â Â Â setDefaultTaskFunction: ((name) => Promise<boolean>);
Â Â Â Â setTasksQueueOptions: ((tasksQueueOptions) => void);
Â Â Â Â setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void);
Â Â Â Â setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => boolean);
Â Â Â Â start: (() => void);
Â Â Â Â workerNodes: IWorkerNode<Worker, Data>[];
}

Type Parameters

Worker extends IWorker
Type of worker which manages this pool.
+IPool | poolifier - v4.0.15
Preparing search index...
The search index is not available
poolifier - v4.0.15
poolifier
IPool
Interface IPool<Worker, Data, Response>
Contract definition for a poolifier pool.
+
interface IPool<Worker, Data, Response> {
Â Â Â Â addTaskFunction: ((name: string, fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>) => Promise<boolean>);
Â Â Â Â destroy: (() => Promise<void>);
Â Â Â Â emitter?: EventEmitterAsyncResource;
Â Â Â Â enableTasksQueue: ((enable: boolean, tasksQueueOptions?: TasksQueueOptions) => void);
Â Â Â Â execute: ((data?: Data, name?: string, transferList?: readonly TransferListItem[]) => Promise<Response>);
Â Â Â Â hasTaskFunction: ((name: string) => boolean);
Â Â Â Â info: PoolInfo;
Â Â Â Â listTaskFunctionsProperties: (() => TaskFunctionProperties[]);
Â Â Â Â mapExecute: ((data: Iterable<Data>, name?: string, transferList?: readonly TransferListItem[]) => Promise<Response[]>);
Â Â Â Â removeTaskFunction: ((name: string) => Promise<boolean>);
Â Â Â Â setDefaultTaskFunction: ((name: string) => Promise<boolean>);
Â Â Â Â setTasksQueueOptions: ((tasksQueueOptions: TasksQueueOptions) => void);
Â Â Â Â setWorkerChoiceStrategy: ((workerChoiceStrategy:
Â Â Â Â Â Â Â Â | "ROUND_ROBIN"
Â Â Â Â Â Â Â Â | "LEAST_USED"
Â Â Â Â Â Â Â Â | "LEAST_BUSY"
Â Â Â Â Â Â Â Â | "LEAST_ELU"
Â Â Â Â Â Â Â Â | "FAIR_SHARE"
Â Â Â Â Â Â Â Â | "WEIGHTED_ROUND_ROBIN"
Â Â Â Â Â Â Â Â | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions) => void);
Â Â Â Â setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions: WorkerChoiceStrategyOptions) => boolean);
Â Â Â Â start: (() => void);
Â Â Â Â workerNodes: IWorkerNode<Worker, Data>[];
}
Type Parameters
Worker extends IWorker
Type of worker which manages this pool.

Data = unknown
Type of data sent to the worker. This can only be structured-cloneable data.

Response = unknown
Type of execution response. This can only be structured-cloneable data.
-
Implemented by
AbstractPool
Defined in src/pools/pool.ts:247
Index
Properties
addTaskFunction +

Implemented by

AbstractPool

Index

Properties

addTaskFunction destroy emitter? enableTasksQueue @@ -18,60 +18,60 @@ setWorkerChoiceStrategyOptions start workerNodes -

Properties

`Readonly` addTaskFunction

addTaskFunction: ((name, fn) => Promise<boolean>)

Adds a task function to this pool. +

Properties

`Readonly`addTaskFunction

addTaskFunction: ((name: string, fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>) => Promise<boolean>)

Adds a task function to this pool. If a task function with the same name already exists, it will be overwritten.

Type declaration

- (name, fn): Promise<boolean>
- Parameters
  - name: string
    The name of the task function.
  - fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>
    The task function.
    -
  Returns Promise<boolean>

Returns

true if the task function was added, false otherwise.

Throws

https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

Throws

https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function or task function object.

`Readonly` destroy

destroy: (() => Promise<void>)

Terminates all workers in this pool.

Type declaration

- (): Promise<void>
- Returns Promise<void>

`Optional` `Readonly` emitter

emitter?: EventEmitterAsyncResource

Pool event emitter integrated with async resource. +

Returns Promise<boolean>

`Readonly`destroy

destroy: (() => Promise<void>)

Terminates all workers in this pool.

`Optional` `Readonly`emitter

emitter?: EventEmitterAsyncResource

Pool event emitter integrated with async resource. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

Events that can currently be listened to:

'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers is set to zero, this event is emitted when at least one dynamic worker is ready.
'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'empty': Emitted when the pool is dynamic with a minimum number of workers set to zero and the number of workers has reached the minimum size expected.
'destroy': Emitted when the pool is destroyed.
'error': Emitted when an uncaught error occurs.
'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).
'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers is set to zero, this event is emitted when at least one dynamic worker is ready.
'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'empty': Emitted when the pool is dynamic with a minimum number of workers set to zero and the number of workers has reached the minimum size expected.
'destroy': Emitted when the pool is destroyed.
'error': Emitted when an uncaught error occurs.
'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` enableTasksQueue

enableTasksQueue: ((enable, tasksQueueOptions?) => void)

Enables/disables the worker node tasks queue in this pool.

`Readonly`enableTasksQueue

enableTasksQueue: ((enable: boolean, tasksQueueOptions?: TasksQueueOptions) => void)

Enables/disables the worker node tasks queue in this pool.

Type declaration

- (enable, tasksQueueOptions?): void
- Parameters
  - enable: boolean
    Whether to enable or disable the worker node tasks queue.
    -
  - Optional tasksQueueOptions: TasksQueueOptions
    The worker node tasks queue options.
    -
  Returns void

`Readonly` execute

execute: ((data?, name?, transferList?) => Promise<Response>)

Executes the specified function in the worker constructor with the task data input parameter.

Type declaration

- (data?, name?, transferList?): Promise<Response>
- Parameters
  - Optional data: Data
    The optional task input data for the specified task function. This can only be structured-cloneable data.
    -
  - Optional name: string
    The optional name of the task function to execute. If not specified, the default task function will be executed.
    -
  - Optional transferList: readonly TransferListItem[]
    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<Response>

Returns

Promise with a task function response that will be fulfilled when the task is completed.

`Readonly` hasTaskFunction

hasTaskFunction: ((name) => boolean)

Whether the specified task function exists in this pool.

OptionaltasksQueueOptions: TasksQueueOptions

The worker node tasks queue options.

Returns void

`Readonly`execute

execute: ((data?: Data, name?: string, transferList?: readonly TransferListItem[]) => Promise<Response>)

Executes the specified function in the worker constructor with the task data input parameter.

Type declaration

- (data?, name?, transferList?): Promise<Response>
- Parameters
  - Optionaldata: Data
    The optional task input data for the specified task function. This can only be structured-cloneable data.
    +
  - Optionalname: string
    The optional name of the task function to execute. If not specified, the default task function will be executed.
    +
  - OptionaltransferList: readonly TransferListItem[]
    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<Response>
  Promise with a task function response that will be fulfilled when the task is completed.
  +

`Readonly`hasTaskFunction

hasTaskFunction: ((name: string) => boolean)

Whether the specified task function exists in this pool.

Type declaration

- (name): boolean
- Parameters
  - name: string
    The name of the task function.
    -
  Returns boolean

Returns

true if the task function exists, false otherwise.

`Readonly` info

info: PoolInfo

Pool information.

`Readonly` listTaskFunctionsProperties

listTaskFunctionsProperties: (() => TaskFunctionProperties[])

Lists the properties of task functions available in this pool.

Type declaration

- (): TaskFunctionProperties[]
- Returns TaskFunctionProperties[]

Returns

The properties of task functions available in this pool.

`Readonly` mapExecute

mapExecute: ((data, name?, transferList?) => Promise<Response[]>)

Executes the specified function in the worker constructor with the tasks data iterable input parameter.

Returns boolean

true if the task function exists, false otherwise.

`Readonly`info

info: PoolInfo

Pool information.

`Readonly`listTaskFunctionsProperties

listTaskFunctionsProperties: (() => TaskFunctionProperties[])

Lists the properties of task functions available in this pool.

Type declaration

- (): TaskFunctionProperties[]
- Returns TaskFunctionProperties[]
  The properties of task functions available in this pool.
  +

`Readonly`mapExecute

mapExecute: ((data: Iterable<Data>, name?: string, transferList?: readonly TransferListItem[]) => Promise<Response[]>)

Executes the specified function in the worker constructor with the tasks data iterable input parameter.

Type declaration

- (data, name?, transferList?): Promise<Response[]>
- Parameters
  - data: Iterable<Data>
    The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.
    -
  - Optional name: string
    The optional name of the task function to execute. If not specified, the default task function will be executed.
    -
  - Optional transferList: readonly TransferListItem[]
    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<Response[]>

Returns

Promise with an array of task function responses that will be fulfilled when the tasks are completed.

`Readonly` removeTaskFunction

removeTaskFunction: ((name) => Promise<boolean>)

Removes a task function from this pool.

Optionalname: string

The optional name of the task function to execute. If not specified, the default task function will be executed.

OptionaltransferList: readonly TransferListItem[]

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<Response[]>

Promise with an array of task function responses that will be fulfilled when the tasks are completed.

`Readonly`removeTaskFunction

removeTaskFunction: ((name: string) => Promise<boolean>)

Removes a task function from this pool.

Type declaration

- (name): Promise<boolean>
- Parameters
  - name: string
    The name of the task function.
    -
  Returns Promise<boolean>

Returns

true if the task function was removed, false otherwise.

`Readonly` setDefaultTaskFunction

setDefaultTaskFunction: ((name) => Promise<boolean>)

Sets the default task function in this pool.

Returns Promise<boolean>

true if the task function was removed, false otherwise.

`Readonly`setDefaultTaskFunction

setDefaultTaskFunction: ((name: string) => Promise<boolean>)

Sets the default task function in this pool.

Type declaration

- (name): Promise<boolean>
- Parameters
  - name: string
    The name of the task function.
    -
  Returns Promise<boolean>

Returns

true if the default task function was set, false otherwise.

`Readonly` setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions) => void)

Sets the worker node tasks queue options in this pool.

Returns Promise<boolean>

true if the default task function was set, false otherwise.

`Readonly`setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions: TasksQueueOptions) => void)

Sets the worker node tasks queue options in this pool.

Type declaration

- (tasksQueueOptions): void
- Parameters
  - tasksQueueOptions: TasksQueueOptions
    The worker node tasks queue options.
    -
  Returns void

`Readonly` setWorkerChoiceStrategy

setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)

Sets the default worker choice strategy in this pool.

Type declaration

- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
- Parameters
  - workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    The default worker choice strategy.
    -
  - Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
    The worker choice strategy options.
    -
  Returns void

`Readonly` setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => boolean)

Sets the worker choice strategy options in this pool.

Returns void

`Readonly`setWorkerChoiceStrategy

Sets the default worker choice strategy in this pool.

Type declaration

- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
- Parameters
  - workerChoiceStrategy:
    Â Â Â Â | "ROUND_ROBIN"
    Â Â Â Â | "LEAST_USED"
    Â Â Â Â | "LEAST_BUSY"
    Â Â Â Â | "LEAST_ELU"
    Â Â Â Â | "FAIR_SHARE"
    Â Â Â Â | "WEIGHTED_ROUND_ROBIN"
    Â Â Â Â | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    The default worker choice strategy.
    +
  - OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions
    The worker choice strategy options.
    +
  Returns void

`Readonly`setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions: WorkerChoiceStrategyOptions) => boolean)

Sets the worker choice strategy options in this pool.

Type declaration

- (workerChoiceStrategyOptions): boolean
- Parameters
  - workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
    The worker choice strategy options.
    -
  Returns boolean

Returns

true if the worker choice strategy options were set, false otherwise.

Interface IPool<Worker, Data, Response>

Type Parameters

Interface IPool<Worker, Data, Response>

Type Parameters

Implemented by

Index

Properties

Implemented by

Index

Properties

Properties

Readonly addTaskFunction

Properties

ReadonlyaddTaskFunction

Type declaration

Parameters

Returns Promise<boolean>

Returns

Throws

Throws

Readonly destroy

Type declaration

Returns Promise<void>

Optional Readonly emitter

Returns Promise<boolean>

Throws

Throws

Readonlydestroy

Optional Readonlyemitter

Readonly enableTasksQueue

ReadonlyenableTasksQueue

Type declaration

Parameters

Returns void

Readonly execute

Type declaration

Parameters

Returns Promise<Response>

Returns

Readonly hasTaskFunction

Returns void

Readonlyexecute

Type declaration

Parameters

Returns Promise<Response>

ReadonlyhasTaskFunction

Type declaration

Parameters

Returns boolean

Returns

Readonly info

Readonly listTaskFunctionsProperties

Type declaration

Returns TaskFunctionProperties[]

Returns

Readonly mapExecute

Returns boolean

Readonlyinfo

ReadonlylistTaskFunctionsProperties

Type declaration

Returns TaskFunctionProperties[]

ReadonlymapExecute

Type declaration

Parameters

Returns Promise<Response[]>

Returns

Readonly removeTaskFunction

Returns Promise<Response[]>

ReadonlyremoveTaskFunction

Type declaration

Parameters

Returns Promise<boolean>

Returns

Readonly setDefaultTaskFunction

Returns Promise<boolean>

ReadonlysetDefaultTaskFunction

Type declaration

Parameters

Returns Promise<boolean>

Returns

`Readonly` addTaskFunction

`Readonly`addTaskFunction

`Readonly` destroy

`Optional` `Readonly` emitter

`Readonly`destroy

`Optional` `Readonly`emitter

`Readonly` enableTasksQueue

`Readonly`enableTasksQueue

`Readonly` execute

`Readonly` hasTaskFunction

`Readonly`execute

`Readonly`hasTaskFunction

`Readonly` info

`Readonly` listTaskFunctionsProperties

`Readonly` mapExecute

`Readonly`info

`Readonly`listTaskFunctionsProperties

`Readonly`mapExecute

`Readonly` removeTaskFunction

`Readonly`removeTaskFunction

`Readonly` setDefaultTaskFunction

`Readonly`setDefaultTaskFunction

`Readonly` setTasksQueueOptions

`Readonly`setTasksQueueOptions

`Readonly` setWorkerChoiceStrategy

`Readonly` setWorkerChoiceStrategyOptions

`Readonly`setWorkerChoiceStrategy

`Readonly`setWorkerChoiceStrategyOptions

`Readonly` start

`Readonly` `Internal` workerNodes

`Readonly`start

`Readonly` `Internal`workerNodes