X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=5003863ead84dc3f251a7b223269ab2f5852483e;hb=6c4fa3e1bd11a23fd83b8492ad941a323853de06;hp=c45d9899d97a552c430913176172ebd3ef452bf1;hpb=71056a0ac555e096c1428d6341ef45c7980a6332;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index c45d9899..5003863e 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,13 +1,13 @@ -
Optional
enableOptional
enableGenerated using TypeDoc
Generated using TypeDoc
Pool events emission.
+Pool events integrated with async resource emission.
Default Value
true
+Default Value
Optional
enablePool worker tasks queue.
+Pool worker node tasks queue.
Default Value
false
+Default Value
-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
exitA function that will listen for exit event on each worker.
Default Value
+() => {}
Inherited from PoolOptions.exitHandler
-- Defined in src/pools/pool.ts:116
Optional
messageA function that will listen for message event on each worker.
Default Value
+() => {}
Inherited from PoolOptions.messageHandler
-- Defined in src/pools/pool.ts:104
Optional
onlineA function that will listen for online event on each worker.
Default Value
+() => {}
Inherited from PoolOptions.onlineHandler
-- Defined in src/pools/pool.ts:112
Optional
restartInherited from PoolOptions.restartWorkerOnError
-- Defined in src/pools/pool.ts:130
Optional
settingsSee
https://nodejs.org/api/cluster.html#cluster_cluster_settings
-- Defined in src/pools/cluster/fixed.ts:28
Workers
+Optional
startWhether to start the minimum number of workers at pool initialization.
+Default Value
+Inherited from PoolOptions.startWorkers
++- Defined in src/pools/pool.ts:161
Optional
tasksPool worker tasks queue options.
+Pool worker node tasks queue options.
Inherited from PoolOptions.tasksQueueOptions
-- Defined in src/pools/pool.ts:146
Choice Strategy
-Optional
workerThe worker choice strategy to use in this pool.
Default Value
WorkerChoiceStrategies.ROUND_ROBIN
+Default Value
Inherited from PoolOptions.workerChoiceStrategy
-- Defined in src/pools/pool.ts:122
Optional
workerInherited from PoolOptions.workerChoiceStrategyOptions
-- Defined in src/pools/pool.ts:126