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 destroy emitter? enableTasksQueue execute hasTaskFunction hasWorkerNodeBackPressure info listTaskFunctionNames removeTaskFunction setDefaultTaskFunction setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions start workerNodes

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

'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are 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.
'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)

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

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

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

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

`Readonly` info

info: PoolInfo

Pool information.

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

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

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

`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

`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

`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

`Readonly` start

start: (() => void)

Type declaration

- (): void
- Starts the minimum number of workers in this pool.
  
  Returns void

`Readonly` `Internal` workerNodes

workerNodes: IWorkerNode<Worker, Data>[]

Pool worker nodes.

Interface IPool<Worker, Data, Response>

Type Parameters

Worker extends IWorker

Data = unknown

Response = unknown

Hierarchy

Implemented by

Index

Properties

Properties

Readonly addTaskFunction

Type declaration

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns Promise<boolean>

Throws

Throws

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

Type declaration

Parameters

tasksQueueOptions: TasksQueueOptions

Returns void

Readonly setWorkerChoiceStrategy

Type declaration

Parameters

workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

Returns void

Readonly setWorkerChoiceStrategyOptions

Type declaration

Parameters

workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

Returns void

Readonly start

Type declaration

Returns void

Readonly Internal workerNodes

Settings

`Readonly` addTaskFunction

`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