X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FThreadPoolOptions.html;h=b95c00f5eb273eb5a6d0fa554e4c571aa045abea;hb=134c1944c69547534c725e2ba8ee40fc5dacf147;hp=7ccbe719cc503d47b6b85d9966289e81469427be;hpb=e905ea64c054a25ef73885e41fc063279bc599ca;p=poolifier.git diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index 7ccbe719..b95c00f5 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -1,4 +1,4 @@ -ThreadPoolOptions | poolifier - v2.6.44
+ThreadPoolOptions | poolifier - v2.6.45
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.44
+
  • The search index is not available
    • poolifier - v2.6.45
    @@ -26,7 +26,7 @@
    • ThreadPoolOptions
    +
  • Defined in src/pools/thread/fixed.ts:18
    • @@ -41,6 +41,7 @@ messageHandler? onlineHandler? restartWorkerOnError? +startWorkers? tasksQueueOptions? workerChoiceStrategy? workerChoiceStrategyOptions? @@ -59,7 +60,7 @@
    +
  • Defined in src/pools/pool.ts:185

    • Optional enableTasksQueue

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

    • Optional errorHandler

    errorHandler?: ErrorHandler<Worker>

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

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

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>

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

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

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>

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

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

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

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

    • Optional restartWorkerOnError

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

    Optional startWorkers

    +
    startWorkers?: boolean
    +

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

    +
    +
    +

    Default Value

    true
+
    +

    Optional tasksQueueOptions

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

    • Optional workerChoiceStrategy

    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    @@ -137,7 +158,7 @@
    +
  • Defined in src/pools/pool.ts:171

    • Optional workerChoiceStrategyOptions

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

    • 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
    • -