Interface PoolOptions<Worker>

Options for a poolifier pool.

Type Parameters

  • Worker extends IWorker

    Type of worker.

Hierarchy

Properties

enableEvents?: boolean

Pool events integrated with async resource emission.

Default Value

true
enableTasksQueue?: boolean

Pool worker node tasks queue.

Default Value

false
errorHandler?: ErrorHandler<Worker>

A function that will listen for error event on each worker.

Default Value

() => {}

exitHandler?: ExitHandler<Worker>

A function that will listen for exit event on each worker.

Default Value

() => {}

messageHandler?: MessageHandler<Worker>

A function that will listen for message event on each worker.

Default Value

() => {}

onlineHandler?: OnlineHandler<Worker>

A function that will listen for online event on each worker.

Default Value

() => {}

restartWorkerOnError?: boolean

Restart worker on error.

startWorkers?: boolean

Whether to start the minimum number of workers at pool initialization.

Default Value

true
tasksQueueOptions?: TasksQueueOptions

Pool worker node tasks queue options.

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

The worker choice strategy to use in this pool.

Default Value

WorkerChoiceStrategies.ROUND_ROBIN
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

The worker choice strategy options.

Generated using TypeDoc