Options for a poolifier pool.
Type of worker.
Optional
Pool events integrated with async resource emission.
true Copy
true
Pool worker node tasks queue.
false Copy
false
Key/value pairs to add to worker process environment.
https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
A function that will listen for error event on each worker.
() => {}
A function that will listen for exit event on each worker.
A function that will listen for message event on each worker.
A function that will listen for online event on each worker.
Restart worker on error.
Cluster settings.
https://nodejs.org/api/cluster.html#cluster_cluster_settings
Whether to start the minimum number of workers at pool initialization.
Pool worker node tasks queue options.
The worker choice strategy to use in this pool.
WorkerChoiceStrategies.ROUND_ROBIN Copy
WorkerChoiceStrategies.ROUND_ROBIN
The worker choice strategy options.
Worker options.
https://nodejs.org/api/worker_threads.html#new-workerfilename-options
Generated using TypeDoc
Options for a poolifier pool.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.30Interface PoolOptions<Worker>
Options for a poolifier pool.
    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?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions;
    workerOptions?: WorkerOptions;
}
Type Parameters
Type of worker.
-Index
Properties
Index
Properties
Properties
OptionalenablePool events integrated with async resource emission.
Default Value
-OptionalenablePool worker node tasks queue.
+OptionalenablePool worker node tasks queue.
Default Value
-OptionalenvKey/value pairs to add to worker process environment.
+OptionalenvKey/value pairs to add to worker process environment.
See
https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
-OptionalerrorA function that will listen for error event on each worker.
+OptionalerrorA function that will listen for error event on each worker.
Default Value
-() => {}OptionalexitA function that will listen for exit event on each worker.
+OptionalexitA function that will listen for exit event on each worker.
Default Value
-() => {}OptionalmessageA function that will listen for message event on each worker.
+OptionalmessageA function that will listen for message event on each worker.
Default Value
-() => {}OptionalonlineA function that will listen for online event on each worker.
+OptionalonlineA function that will listen for online event on each worker.
Default Value
-() => {}OptionalrestartRestart worker on error.
-OptionalsettingsCluster settings.
+OptionalrestartRestart worker on error.
+OptionalsettingsCluster settings.
See
https://nodejs.org/api/cluster.html#cluster_cluster_settings
-OptionalstartWhether to start the minimum number of workers at pool initialization.
+OptionalstartWhether to start the minimum number of workers at pool initialization.
Default Value
-OptionaltasksPool worker node tasks queue options.
-OptionalworkerThe worker choice strategy to use in this pool.
+OptionaltasksPool worker node tasks queue options.
+OptionalworkerThe worker choice strategy to use in this pool.
Default Value
-OptionalworkerThe worker choice strategy options.
-OptionalworkerWorker options.
+OptionalworkerThe worker choice strategy options.
+OptionalworkerWorker options.
See
https://nodejs.org/api/worker_threads.html#new-workerfilename-options
-Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc
Settings
Member Visibility
Theme
On This Page