X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FThreadPoolOptions.html;h=a587e5a8b4006d98157f8b4e98b6418816318cbb;hb=64eb699c80c434f946f9aca8306bf4eb9498a319;hp=bdd70ff81d8b6209bc1e0eaed2e0b3b8d5e0ef40;hpb=41ad8560b4bc9bed1f1840deda65d619ba68d485;p=poolifier.git diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index bdd70ff8..a587e5a8 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -1,217 +1,39 @@ -ThreadPoolOptions | poolifier - v2.6.41
-
- -
-
-
-
- -

Interface ThreadPoolOptions

-
-

Options for a poolifier thread pool.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
enableEvents? +ThreadPoolOptions | poolifier - v3.0.9

Interface ThreadPoolOptions

Options for a poolifier thread pool.

+

Hierarchy

-
-

Properties

-
- -
enableEvents?: boolean
-

Pool events emission.

-
-
-

Default Value

true
+

Properties

enableEvents?: boolean

Pool events integrated with async resource emission.

+

Default Value

true
 
-
-
- -
enableTasksQueue?: boolean
-

Pool worker node tasks queue.

-
-
-

Default Value

false
+
enableTasksQueue?: boolean

Pool worker node tasks queue.

+

Default Value

false
 
-
-
- -
errorHandler?: ErrorHandler<Worker>
-

A function that will listen for error event on each worker.

-
-
-
- -
exitHandler?: ExitHandler<Worker>
-

A function that will listen for exit event on each worker.

-
-
-
- -
messageHandler?: MessageHandler<Worker>
-

A function that will listen for message event on each worker.

-
-
-
- -
onlineHandler?: OnlineHandler<Worker>
-

A function that will listen for online event on each worker.

-
-
-
- -
restartWorkerOnError?: boolean
-

Restart worker on error.

-
-
-
- -
tasksQueueOptions?: TasksQueueOptions
-

Pool worker node tasks queue options.

-
-
-
- -
workerChoiceStrategy?: "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
+
errorHandler?: ErrorHandler<Worker>

A function that will listen for error event on each worker.

+

Default Value

() => {}

+
exitHandler?: ExitHandler<Worker>

A function that will listen for exit event on each worker.

+

Default Value

() => {}

+
messageHandler?: MessageHandler<Worker>

A function that will listen for message event on each worker.

+

Default Value

() => {}

+
onlineHandler?: OnlineHandler<Worker>

A function that will listen for online event on each worker.

+

Default Value

() => {}

+
restartWorkerOnError?: boolean

Restart worker on error.

+
startWorkers?: boolean

Whether to start the minimum number of workers at pool initialization.

+

Default Value

true
 
-
-
- -
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
-

The worker choice strategy options.

-
-
-
- -
workerOptions?: WorkerOptions
-

Worker options.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +
tasksQueueOptions?: TasksQueueOptions

Pool worker node tasks queue options.

+
workerChoiceStrategy?: "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
+
+
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

The worker choice strategy options.

+
workerOptions?: WorkerOptions

Worker options.

+

Generated using TypeDoc

\ No newline at end of file