Interface PoolOptions<Worker>

Options for a poolifier pool.

interface PoolOptions<Worker> {
    enableEvents?: boolean;
    enableTasksQueue?: boolean;
    env?: Record<string, unknown>;
    errorHandler?: ErrorHandler<Worker>;
    exitHandler?: ExitHandler<Worker>;
    messageHandler?: MessageHandler<Worker>;
    onlineHandler?: OnlineHandler<Worker>;
    restartWorkerOnError?: boolean;
    settings?: ClusterSettings;
    startWorkers?: boolean;
    tasksQueueOptions?: TasksQueueOptions;
    workerChoiceStrategy?:
        | "FAIR_SHARE"
        | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
        | "LEAST_BUSY"
        | "LEAST_ELU"
        | "LEAST_USED"
        | "ROUND_ROBIN"
        | "WEIGHTED_ROUND_ROBIN";
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions;
    workerOptions?: WorkerOptions;
}

Type Parameters

  • Worker extends IWorker

    Type of worker.

Properties

enableEvents? enableTasksQueue? env? errorHandler? exitHandler? messageHandler? onlineHandler? restartWorkerOnError? settings? startWorkers? tasksQueueOptions? workerChoiceStrategy? workerChoiceStrategyOptions? workerOptions?

Properties

OptionalenableEvents

enableEvents?: boolean

Pool events integrated with async resource emission.

Default Value

true

OptionalenableTasksQueue

enableTasksQueue?: boolean

Pool worker node tasks queue.

Default Value

false

Optionalenv

env?: Record<string, unknown>

Key/value pairs to add to worker process environment.

See

https://nodejs.org/api/cluster.html#cluster_cluster_fork_env

OptionalerrorHandler

errorHandler?: ErrorHandler<Worker>

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

Default Value

() => {}

OptionalexitHandler

exitHandler?: ExitHandler<Worker>

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

Default Value

() => {}

OptionalmessageHandler

messageHandler?: MessageHandler<Worker>

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

Default Value

() => {}

OptionalonlineHandler

onlineHandler?: OnlineHandler<Worker>

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

Default Value

() => {}

OptionalrestartWorkerOnError

restartWorkerOnError?: boolean

Restart worker on error.

Optionalsettings

settings?: ClusterSettings

Cluster settings.

See

https://nodejs.org/api/cluster.html#cluster_cluster_settings

OptionalstartWorkers

startWorkers?: boolean

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

Default Value

true

OptionaltasksQueueOptions

tasksQueueOptions?: TasksQueueOptions

Pool worker node tasks queue options.

OptionalworkerChoiceStrategy

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

The default worker choice strategy to use in this pool.

Default Value

WorkerChoiceStrategies.ROUND_ROBIN

OptionalworkerChoiceStrategyOptions

workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

The worker choice strategy options.

OptionalworkerOptions

workerOptions?: WorkerOptions

Worker options.

See

https://nodejs.org/api/worker_threads.html#new-workerfilename-options

Settings

Member Visibility

On This Page

Properties