X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FThreadPoolOptions.html;h=56c71b9eddca8c2037811e5fa7b14ba61770fa04;hb=97cf8c0ddbe1fdba4fde9f94e5b781eeec4d71b5;hp=bdd70ff81d8b6209bc1e0eaed2e0b3b8d5e0ef40;hpb=41ad8560b4bc9bed1f1840deda65d619ba68d485;p=poolifier.git diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index bdd70ff8..56c71b9e 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -1,4 +1,4 @@ -ThreadPoolOptions | poolifier - v2.6.41
+ThreadPoolOptions | poolifier - v2.7.5
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.41
+
  • The search index is not available
    • poolifier - v2.7.5
    @@ -26,7 +26,7 @@
    • ThreadPoolOptions
    +
  • Defined in src/pools/thread/fixed.ts:18
    • @@ -41,6 +41,7 @@ messageHandler? onlineHandler? restartWorkerOnError? +startWorkers? tasksQueueOptions? workerChoiceStrategy? workerChoiceStrategyOptions? @@ -51,7 +52,7 @@

    Optional enableEvents

    enableEvents?: boolean
    -

    Pool events emission.

    +

    Pool events integrated with async resource emission.

    Default Value

    true
@@ -59,7 +60,7 @@
    +
  • Defined in src/pools/pool.ts:181

    • Optional enableTasksQueue

    enableTasksQueue?: boolean
    @@ -71,43 +72,51 @@
    +
  • Defined in src/pools/pool.ts:187

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:149

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:155

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:143

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:137

    • Optional restartWorkerOnError

    restartWorkerOnError?: boolean
    @@ -116,7 +125,19 @@
    +
  • Defined in src/pools/pool.ts:175
    • +
    +

    Optional startWorkers

    +
    startWorkers?: boolean
    +

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

    +
    +
    +

    Default Value

    true
+
    +

    Optional tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions
    @@ -125,19 +146,19 @@
    +
  • Defined in src/pools/pool.ts:191

    • Optional workerChoiceStrategy

    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
+
    Default Value
    WorkerChoiceStrategies.ROUND_ROBIN
    +
  • Defined in src/pools/pool.ts:167

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -146,7 +167,7 @@
    +
  • Defined in src/pools/pool.ts:171

    • Optional workerOptions

    workerOptions?: WorkerOptions
    @@ -156,7 +177,7 @@

    See

    https://nodejs.org/api/worker_threads.html#new-workerfilename-options

    +
  • Defined in src/pools/thread/fixed.ts:24
    • @@ -183,12 +204,13 @@
  • messageHandler
  • onlineHandler
  • restartWorkerOnError
    • +
  • startWorkers
  • tasksQueueOptions
  • workerChoiceStrategy
  • workerChoiceStrategyOptions
  • workerOptions
    • -

    Generated using TypeDoc