IPool | poolifier

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

destroy

`Readonly` destroy

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

Type declaration

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

Defined in src/pools/pool.ts:259

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

`Optional` `Readonly` emitter

emitter?: __module | 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:

'full': Emitted when the pool is dynamic and full.
'busy': Emitted when the pool is busy.
'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).

enableTasksQueue

`Readonly` enableTasksQueue

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

Type declaration

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

execute

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

`Readonly` execute

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

Type declaration

- (data?, name?): Promise<Response>
- (data?, name?, transferList?): Promise<Response>
- Executes the specified function in the worker constructor with the task data input parameter.
  
  @@ -134,54 +189,182 @@
  - Optional data: Data
    -
    The task input data for the specified worker function. This can only be serializable data.
    -
  - Optional name: string
    -
    The name of the worker function to execute. If not specified, the default worker function will be executed.
    -

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

setTasksQueueOptions

`Readonly` setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions) => void)

Type declaration

- (tasksQueueOptions): void
- (tasksQueueOptions): void
- -
  Sets the worker tasks queue options in this pool.
  +
  Sets the worker node tasks queue options in this pool.
  Parameters
  - tasksQueueOptions: TasksQueueOptions
    -
    The worker tasks queue options.
    -
  -
  Returns void

setWorkerChoiceStrategy

`Readonly` setWorkerChoiceStrategy

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

Type declaration

- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
- Sets the worker choice strategy in this pool.
  
  @@ -189,25 +372,28 @@
  Parameters
  - -
    workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    +
    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

setWorkerChoiceStrategyOptions

`Readonly` setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

Type declaration

- (workerChoiceStrategyOptions): void
- (workerChoiceStrategyOptions): void
- Sets the worker choice strategy options in this pool.
  
  @@ -217,95 +403,96 @@
- 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` workerNodes

workerNodes: WorkerNode<Worker, Data>[]

`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

Index

Index

Properties

Properties

Readonly addTaskFunction

Type declaration

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns Promise<boolean>

Throws

Throws

destroy

Readonly destroy

Type declaration

Returns Promise<void>

Optional Readonly emitter

Optional Readonly emitter

enableTasksQueue

Readonly enableTasksQueue

Type declaration

Parameters

enable: boolean

Optional tasksQueueOptions: TasksQueueOptions

Returns void

execute

Readonly execute

Type declaration

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

setTasksQueueOptions

Readonly setTasksQueueOptions

Type declaration

Parameters

tasksQueueOptions: TasksQueueOptions

Returns void

setWorkerChoiceStrategy

Readonly setWorkerChoiceStrategy

Type declaration

Parameters

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

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

Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

Returns void

setWorkerChoiceStrategyOptions

Readonly setWorkerChoiceStrategyOptions

Type declaration

`Readonly` addTaskFunction

`Readonly` destroy

`Optional` `Readonly` emitter

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

`Readonly` listTaskFunctionNames

`Readonly` removeTaskFunction

`Readonly` setDefaultTaskFunction

`Readonly` setTasksQueueOptions

`Readonly` setWorkerChoiceStrategy

`Optional` workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

`Readonly` setWorkerChoiceStrategyOptions

`Readonly` start

`Readonly` workerNodes

`Readonly` `Internal` workerNodes