Type of worker.
-Optional enablePool events integrated with async resource emission.
-true
+PoolOptions | poolifier - v3.1.29 Interface 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
- Worker extends IWorker
Type of worker.
+
Properties
Optional enable
enablePool events integrated with async resource emission.
+Default Value
true
-
-Optional enable
-enablePool worker node tasks queue.
-
-
-Default Value
false
+
Optional enable
enablePool worker node tasks queue.
+Default Value
false
-
-Optional error
-
-A function that will listen for error event on each worker.
-
-
-Default Value
() => {}
-
-
-Optional exit
-
-A function that will listen for exit event on each worker.
-
-
-Default Value
() => {}
-
-
-Optional message
-
-A function that will listen for message event on each worker.
-
-
-Default Value
() => {}
-
-
-Optional online
-
-A function that will listen for online event on each worker.
-
-
-Default Value
() => {}
-
-
-Optional restart
-restartRestart worker on error.
-
-
-
-Optional start
-startWhether to start the minimum number of workers at pool initialization.
-
-
-Default Value
true
+
Optional env
env?: Record<string, unknown>Key/value pairs to add to worker process environment.
+Optional error
A function that will listen for error event on each worker.
+Default Value
() => {}
+Optional exit
A function that will listen for exit event on each worker.
+Default Value
() => {}
+Optional message
A function that will listen for message event on each worker.
+Default Value
() => {}
+Optional online
A function that will listen for online event on each worker.
+Default Value
() => {}
+Optional restart
restartRestart worker on error.
+Optional settings
settings?: ClusterSettingsCluster settings.
+Optional start
startWhether to start the minimum number of workers at pool initialization.
+Default Value
true
-
-Optional tasks
-
-Pool worker node tasks queue options.
-
-
-
-Optional worker
-workerThe worker choice strategy to use in this pool.
-
-
-Default Value
WorkerChoiceStrategies.ROUND_ROBIN
+
Optional tasks
Pool worker node tasks queue options.
+Optional worker
workerThe worker choice strategy to use in this pool.
+Default Value
WorkerChoiceStrategies.ROUND_ROBIN
-
-Optional worker
-
-The worker choice strategy options.
-
- Generated using TypeDoc
-
\ No newline at end of file
+Optional workerThe worker choice strategy options.
+Optional workerWorker options.
+Generated using TypeDoc
Options for a poolifier pool.
-