X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=fb237e06695e77e83815d64b97a5a711de2cee87;hb=938d9c678aa8e70e5642feffb90604cf25c993fe;hp=fc8c3f0d18b2e2c0f0e7459fc1ff3ad9692bbfde;hpb=7e36fa9f0f844e3e60f0c22de3e28665dd8cc9d1;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index fc8c3f0d..fb237e06 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,4 +1,4 @@ -
Generated using TypeDoc
The worker type.
+Worker extends IWorker
+Type of worker.
Hierarchy
-- ClusterPoolOptions
@@ -40,85 +40,87 @@
enable Events?
-enable Tasks Queue?
-error Handler?
-exit Handler?
-message Handler?
-online Handler?
-tasks Queue Options?
-worker Choice Strategy?
-worker Choice Strategy Options?
+enable Events?
+enable Tasks Queue?
+error Handler?
+exit Handler?
+message Handler?
+online Handler?
+tasks Queue Options?
+worker Choice Strategy?
+worker Choice Strategy Options?
+
enable Events?: boolean
+enable Events?: boolean
-
-enable Tasks Queue?: boolean
+- Defined in src/pools/pool.ts:99
+
+enable Tasks Queue?: boolean
-
+- Defined in src/pools/pool.ts:105
+
error Handler?: ErrorHandler<Worker>
+error Handler?: ErrorHandler<Worker>
-
+- Defined in src/pools/pool.ts:75
+
exit Handler?: ExitHandler<Worker>
+exit Handler?: ExitHandler<Worker>
-
+- Defined in src/pools/pool.ts:83
+
message Handler?: MessageHandler<Worker>
+message Handler?: MessageHandler<Worker>
-
+- Defined in src/pools/pool.ts:71
+
online Handler?: OnlineHandler<Worker>
+online Handler?: OnlineHandler<Worker>
-
-tasks Queue Options?: TasksQueueOptions
+- Defined in src/pools/pool.ts:79
+
+tasks Queue Options?: TasksQueueOptions
-
+- Defined in src/pools/pool.ts:109
+
worker Choice Strategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+worker Choice Strategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
-
+- Defined in src/pools/pool.ts:89
+
worker Choice Strategy Options?: WorkerChoiceStrategyOptions
+worker Choice Strategy Options?: WorkerChoiceStrategyOptions
+- Defined in src/pools/pool.ts:93
Properties
-Properties
- Events
-Optional
enablePool events emission.
Default Value
true
-- Defined in src/pools/pool.ts:96
Tasks Queue
-Optional
Experimental
enable Tasks Queue
+Optional
enablePool worker tasks queue.
Default Value
false
-- Defined in src/pools/pool.ts:103
Handler
-Optional
errorA function that will listen for error event on each worker.
-- Defined in src/pools/pool.ts:74
Handler
-Optional
exitA function that will listen for exit event on each worker.
-- Defined in src/pools/pool.ts:82
Handler
-Optional
messageA function that will listen for message event on each worker.
-- Defined in src/pools/pool.ts:70
Handler
-Optional
onlineA function that will listen for online event on each worker.
-- Defined in src/pools/pool.ts:78
Queue Options
-Optional
Experimental
tasks Queue Options
+Optional
tasksPool worker tasks queue options.
-- Defined in src/pools/pool.ts:109
Choice Strategy
-Optional
workerThe worker choice strategy to use in this pool.
+ +Default Value
WorkerChoiceStrategies.ROUND_ROBIN
-- Defined in src/pools/pool.ts:86
Choice Strategy Options
-Optional
workerThe worker choice strategy options.
-- Defined in src/pools/pool.ts:90