X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FPoolOptions.html;h=4ab0ad3536883aeab0145bf2bef9701e7fc16d3e;hb=a70d17c01f1a59c1525fed69c7cec2c3f4cf5175;hp=0c92333cfa3874efe2c6e994023600c1226b518e;hpb=7ab352a62ac2ae168541b47090e4085a28952f07;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 0c92333c..4ab0ad35 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,245 +1,46 @@ -
Type of worker.
-Optional
enablePool events emission.
-true
+PoolOptions | poolifier - v4.0.8 Interface PoolOptions<Worker>
Options for a poolifier pool.
+ interface PoolOptions<Worker> {
    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 Events
enable Events?: booleanPool events integrated with async resource emission.
+Default Value
true
-
-
-Optional
enable Tasks Queue
-enable Tasks Queue?: boolean
-Pool worker node tasks queue.
-
-
-Default Value
false
+
Optional
enable Tasks Queue
enable Tasks Queue?: booleanPool worker node tasks queue.
+Default Value
false
-
-
-Optional
error Handler
-
-A function that will listen for error event on each worker.
-
-
-
-Optional
exit Handler
-
-A function that will listen for exit event on each worker.
-
-
-
-Optional
message Handler
-
-A function that will listen for message event on each worker.
-
-
-
-Optional
online Handler
-
-A function that will listen for online event on each worker.
-
-
-
-Optional
restart Worker On Error
-restart Worker On Error?: boolean
-Restart worker on error.
-
-
-
-Optional
tasks Queue Options
-
-Pool worker node tasks queue options.
-
-
-
-Optional
worker Choice Strategy
-worker Choice Strategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
-The worker choice strategy to use in this pool.
-
-
-Default Value
WorkerChoiceStrategies.ROUND_ROBIN
+
Optional
env
env?: Record<string, unknown>Key/value pairs to add to worker process environment.
+Optional
error Handler
A function that will listen for error event on each worker.
+Default Value
() => {}
+Optional
exit Handler
A function that will listen for exit event on each worker.
+Default Value
() => {}
+Optional
message Handler
A function that will listen for message event on each worker.
+Default Value
() => {}
+Optional
online Handler
A function that will listen for online event on each worker.
+Default Value
() => {}
+Optional
restart Worker On Error
restart Worker On Error?: booleanRestart worker on error.
+Optional
settings
settings?: ClusterSettingsCluster settings.
+Optional
start Workers
start Workers?: booleanWhether to start the minimum number of workers at pool initialization.
+Default Value
true
-
-
-Optional
worker Choice Strategy Options
-
-The worker choice strategy options.
-
-
-
-
-Generated using TypeDoc
-
\ No newline at end of file
+
Optional
tasksPool worker node tasks queue options.
+Optional
workerThe default worker choice strategy to use in this pool.
+WorkerChoiceStrategies.ROUND_ROBIN
+
+Optional
workerThe worker choice strategy options.
+Optional
workerWorker options.
+
Options for a poolifier pool.
-