X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FPoolOptions.html;h=a7ffc00b92f27753660bace6ae43e5ed20a9e0d5;hb=5d59ef8fc3bb4082501d2f84c14408a2b7fcfacd;hp=e18ce4378a86c619d7a3825718262edf808ffd07;hpb=e789726c2313317dacab65a8a7bdbe54f0eac1e0;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index e18ce437..a7ffc00b 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,6 +1,6 @@ -
Generated using TypeDoc
Options for a poolifier pool.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.19Interface 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.
-Index
Properties
Index
Properties
Properties
Optional
enablePool events integrated with async resource emission.
Default Value
-Optional
enablePool worker node tasks queue.
+Optional
enablePool worker node tasks queue.
Default Value
-Optional
envKey/value pairs to add to worker process environment.
+Optional
envKey/value pairs to add to worker process environment.
See
https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
-Optional
errorA function that will listen for error event on each worker.
+Optional
errorA function that will listen for error event on each worker.
Default Value
-() => {}
Optional
exitA function that will listen for exit event on each worker.
+Optional
exitA function that will listen for exit event on each worker.
Default Value
-() => {}
Optional
messageA function that will listen for message event on each worker.
+Optional
messageA function that will listen for message event on each worker.
Default Value
-() => {}
Optional
onlineA function that will listen for online event on each worker.
+Optional
onlineA function that will listen for online event on each worker.
Default Value
-() => {}
Optional
restartRestart worker on error.
-Optional
settingsCluster settings.
+Optional
restartRestart worker on error.
+Optional
settingsCluster settings.
See
https://nodejs.org/api/cluster.html#cluster_cluster_settings
-Optional
startWhether to start the minimum number of workers at pool initialization.
+Optional
startWhether to start the minimum number of workers at pool initialization.
Default Value
-Optional
tasksPool worker node tasks queue options.
-Optional
workerThe worker choice strategy to use in this pool.
+Optional
tasksPool worker node tasks queue options.
+Optional
workerThe worker choice strategy to use in this pool.
Default Value
-Optional
workerThe worker choice strategy options.
-Optional
workerWorker options.
+Optional
workerThe worker choice strategy options.
+Optional
workerWorker 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