X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FThreadPoolOptions.html;h=b95c00f5eb273eb5a6d0fa554e4c571aa045abea;hb=134c1944c69547534c725e2ba8ee40fc5dacf147;hp=aba001cda56e6a75c9832891f8a59e2391ddedfe;hpb=dd7dfcc292a646940f5f0263d24d8f5f528e8a51;p=poolifier.git diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index aba001cd..b95c00f5 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -1,13 +1,13 @@ -ThreadPoolOptions | poolifier - v2.6.37
+ThreadPoolOptions | poolifier - v2.6.45
-
+
  • The search index is not available
    • poolifier - v2.6.45 +
    @@ -26,21 +26,22 @@
    • ThreadPoolOptions
    +
  • Defined in src/pools/thread/fixed.ts:18
    • - +

    Properties

    -
    enableEvents? +
    enableEvents? enableTasksQueue? errorHandler? exitHandler? messageHandler? onlineHandler? restartWorkerOnError? +startWorkers? tasksQueueOptions? workerChoiceStrategy? workerChoiceStrategyOptions? @@ -49,7 +50,7 @@

    Properties

    -

    Optional enableEvents

    +

    Optional enableEvents

    enableEvents?: boolean

    Pool events emission.

    @@ -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,20 +177,20 @@

    See

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

    +
  • Defined in src/pools/thread/fixed.ts:24
    • -

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -183,76 +204,36 @@
  • messageHandler
  • onlineHandler
  • restartWorkerOnError
    • +
  • startWorkers
  • tasksQueueOptions
  • workerChoiceStrategy
  • workerChoiceStrategyOptions
  • workerOptions
    • -
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file