- -

Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

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.
-
-

Hierarchy

IPool

Implemented by

AbstractPool

Index

Properties

addTaskFunction +IPool | poolifier - v3.0.11

Interface IPool<Worker, Data, Response>

Contract definition for a poolifier pool.

interface IPool {
Â Â Â Â addTaskFunction: ((name, fn) => Promise<boolean>);
Â Â Â Â destroy: (() => Promise<void>);
Â Â Â Â emitter?: EventEmitterAsyncResource;
Â Â Â Â enableTasksQueue: ((enable, tasksQueueOptions?) => void);
Â Â Â Â execute: ((data?, name?, transferList?) => Promise<Response>);
Â Â Â Â hasTaskFunction: ((name) => boolean);
Â Â Â Â hasWorkerNodeBackPressure: ((workerNodeKey) => boolean);
Â Â Â Â info: PoolInfo;
Â Â Â Â listTaskFunctionNames: (() => string[]);
Â Â Â Â removeTaskFunction: ((name) => Promise<boolean>);
Â Â Â Â setDefaultTaskFunction: ((name) => Promise<boolean>);
Â Â Â Â setTasksQueueOptions: ((tasksQueueOptions) => void);
Â Â Â Â setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void);
Â Â Â Â setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void);
Â Â Â Â 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

Index

Properties

addTaskFunction destroy emitter? enableTasksQueue @@ -70,64 +18,15 @@ setWorkerChoiceStrategyOptions start workerNodes -

Properties

`Readonly` addTaskFunction

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

Type declaration

-
- (name, fn): Promise<boolean>
- -
  Adds a task function to this pool. +

Properties

`Readonly` addTaskFunction

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

Type declaration

- (name, fn): Promise<boolean>
- Adds a task function to this pool. If a task function with the same name already exists, it will be overwritten.
  -
  -
  -
  Parameters
  -
  - -
    name: string
    -
    The name of the task function.
    -
    -
  - -
    fn: TaskFunction<Data, Response>
    -
    The task function.
    -
    -
  -
  Returns Promise<boolean>
  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.
  - +
  Parameters
  - name: string
    The name of the task function.
    +
  - fn: TaskFunction<Data, Response>
    The task function.
    +
  Returns Promise<boolean>
  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.
  -

`Readonly` destroy

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

Type declaration

-
- (): Promise<void>
- -
  Terminates all workers in this pool.
  -
  -
  Returns Promise<void>
  -

`Optional` `Readonly` emitter

emitter?: __module | EventEmitterAsyncResource

Event emitter integrated with async resource on which events can be listened to. +

`Readonly` destroy

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

Type declaration

- (): Promise<void>
- Terminates all workers in this pool.
  +
  Returns Promise<void>

`Optional` `Readonly` emitter

emitter?: EventEmitterAsyncResource

Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

Events that can currently be listened to:

poolifier:<PoolType>-<Wo
 '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).


-

-
-Defined in src/pools/pool.ts:238


-
-Readonly enableTasksQueue
-enableTasksQueue: ((enable, tasksQueueOptions?) => void)
-
-Type declaration
-
-
-
-(enable, tasksQueueOptions?): void
-
-Enables/disables the worker node tasks queue in this pool.
-
-
-Parameters
-
-
-enable: boolean
-Whether to enable or disable the worker node tasks queue.
-
-
-
-Optional tasksQueueOptions: TasksQueueOptions
-The worker node tasks queue options.
-
-
-Returns void
-

-
-Defined in src/pools/pool.ts:325
-
-Readonly execute
-execute: ((data?, name?, transferList?) => Promise<Response>)
-
-Type declaration
-
-
-
-(data?, name?, transferList?): Promise<Response>
-
-Executes the specified function in the worker constructor with the task data input parameter.
-
-
-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: TransferListItem[]
-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.
-
-
-Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
-
-

-
-Defined in src/pools/pool.ts:247
-
-Readonly hasTaskFunction
-hasTaskFunction: ((name) => boolean)
-
-Type declaration
-
-
-
-(name): boolean
-
-Whether the specified task function exists in this pool.
-
-
-Parameters
-
-
-name: string
-The name of the task function.
-
-
-Returns boolean
true if the task function exists, false otherwise.
-
-

-
-Defined in src/pools/pool.ts:266
-
-Readonly hasWorkerNodeBackPressure
-hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
-
-Type declaration
-
-
-
-(workerNodeKey): boolean
-Internal 
-Whether the worker node has back pressure (i.e. its tasks queue is full).
-
-
-Parameters
-
-
-workerNodeKey: number
-The worker node key.
-
-
-Returns boolean
true if the worker node has back pressure, false otherwise.
-
-

-
-Defined in src/pools/pool.ts:223
-
-Readonly info
-info: PoolInfo
-Pool information.
-
-

-
-Defined in src/pools/pool.ts:209
-
-Readonly listTaskFunctionNames
-listTaskFunctionNames: (() => string[])
-
-Type declaration
-
-
-
-(): string[]
-
-Lists the names of task function available in this pool.
-
-Returns string[]
The names of task function available in this pool.
-
-

-
-Defined in src/pools/pool.ts:293
-
-Readonly removeTaskFunction
-removeTaskFunction: ((name) => Promise<boolean>)
-
-Type declaration
-
-
-
-(name): Promise<boolean>
-
-Removes a task function from this pool.
-
-
-Parameters
-
-
-name: string
-The name of the task function.
-
-
-Returns Promise<boolean>
true if the task function was removed, false otherwise.
-
-

-
-Defined in src/pools/pool.ts:287
-
-Readonly setDefaultTaskFunction
-setDefaultTaskFunction: ((name) => Promise<boolean>)
-
-Type declaration
-
-
-
-(name): Promise<boolean>
-
-Sets the default task function in this pool.
-
-
-Parameters
-
-
-name: string
-The name of the task function.
-
-
-Returns Promise<boolean>
true if the default task function was set, false otherwise.
-
-

-
-Defined in src/pools/pool.ts:300
-
-Readonly setTasksQueueOptions
-setTasksQueueOptions: ((tasksQueueOptions) => void)
-
-Type declaration
-
-
-
-(tasksQueueOptions): void
-
-Sets the worker node tasks queue options in this pool.
-
-
-Parameters
-
-
-tasksQueueOptions: TasksQueueOptions
-The worker node tasks queue options.
-
-
-Returns void
-

-
-Defined in src/pools/pool.ts:334
-
-Readonly setWorkerChoiceStrategy
-setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
-
-Type declaration
-
-
-
-(workerChoiceStrategy, workerChoiceStrategyOptions?): void
-
-Sets the worker choice strategy in this pool.
-
-
-Parameters
-
-
-workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
-The worker choice strategy.
-
-
-
-Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
-The worker choice strategy options.
-
-
-Returns void
-

-
-Defined in src/pools/pool.ts:307
-
-Readonly setWorkerChoiceStrategyOptions
-setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
-
-Type declaration
-
-
-
-(workerChoiceStrategyOptions): void
-
-Sets the worker choice strategy options in this pool.
-
-
-Parameters
-
-
-workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
-The worker choice strategy options.
-
-
-Returns void
-

-
-Defined in src/pools/pool.ts:316
-
-Readonly start
-start: (() => void)
-
-Type declaration
-
-
-
-(): void
-
-Starts the minimum number of workers in this pool.
-
-Returns void
-

-
-Defined in src/pools/pool.ts:255
-
-Readonly Internal workerNodes
-workerNodes: IWorkerNode<Worker, Data>[]
-Pool worker nodes.
-
-

-
-Defined in src/pools/pool.ts:215

Interface IPool<Worker, Data, Response>

Type Parameters

Worker extends IWorker

Data = unknown

Response = unknown

Hierarchy

Implemented by

Index

Properties

Interface IPool<Worker, Data, Response>

Type Parameters

Worker extends IWorker

Data = unknown

Response = unknown

Implemented by

Index

Properties

Properties

Readonly addTaskFunction

Type declaration

Properties

Readonly addTaskFunction

Type declaration

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns Promise<boolean>

Throws

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns Promise<boolean>

Throws

Throws

Readonly destroy

Type declaration

Returns Promise<void>

Optional Readonly emitter

Readonly destroy

Type declaration

Returns Promise<void>

Optional Readonly emitter

Readonly enableTasksQueue

Type declaration

Parameters

enable: boolean

Optional tasksQueueOptions: TasksQueueOptions

Returns void

Readonly execute

Type declaration

Parameters

Optional data: Data

Optional name: string

Optional transferList: TransferListItem[]

Returns Promise<Response>

Readonly hasTaskFunction

Type declaration

Parameters

name: string

Returns boolean

Readonly hasWorkerNodeBackPressure

Type declaration

Parameters

workerNodeKey: number

Returns boolean

Readonly info

Readonly listTaskFunctionNames

Type declaration

Returns string[]

Readonly removeTaskFunction

Type declaration

Parameters

name: string

Returns Promise<boolean>

Readonly setDefaultTaskFunction

Type declaration

Parameters

name: string

Returns Promise<boolean>

Readonly setTasksQueueOptions

`Readonly` addTaskFunction

`Readonly` addTaskFunction

`Readonly` destroy

`Optional` `Readonly` emitter

`Readonly` destroy

`Optional` `Readonly` emitter

`Readonly` enableTasksQueue

`Optional` tasksQueueOptions: TasksQueueOptions

`Readonly` execute

`Optional` data: Data

`Optional` name: string

`Optional` transferList: TransferListItem[]

`Readonly` hasTaskFunction

`Readonly` hasWorkerNodeBackPressure

`Readonly` info

`Readonly` listTaskFunctionNames

`Readonly` removeTaskFunction

`Readonly` setDefaultTaskFunction

`Readonly` setTasksQueueOptions

`Readonly` setWorkerChoiceStrategy

`Optional` workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

`Readonly` setWorkerChoiceStrategyOptions

`Readonly` start

`Readonly` `Internal` workerNodes

`Readonly` enableTasksQueue

`Optional` tasksQueueOptions: TasksQueueOptions

`Readonly` execute

`Optional` data: Data

`Optional` name: string

`Optional` transferList: TransferListItem[]

`Readonly` hasTaskFunction

`Readonly` hasWorkerNodeBackPressure

`Readonly` info

`Readonly` listTaskFunctionNames

`Readonly` removeTaskFunction

`Readonly` setDefaultTaskFunction

`Readonly` setTasksQueueOptions

`Readonly` setWorkerChoiceStrategy

`Optional` workerChoiceStrategyOptions: WorkerChoiceStrategyOptions