X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FThreadPoolOptions.html;h=3d17d7ac300a9007606d68e1d7a39eea24dcb6e3;hb=48c6ba05d56af984567ff531fde69cb6d9f9a0fb;hp=aba001cda56e6a75c9832891f8a59e2391ddedfe;hpb=010ae1ba98e5ab018fa09870982d511c9389b48b;p=poolifier.git diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index aba001cd..3d17d7ac 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -1,13 +1,13 @@ -ThreadPoolOptions | poolifier - v2.6.37
+ThreadPoolOptions | poolifier - v2.7.3
-
+
  • The search index is not available
    • poolifier - v2.7.3 +
    @@ -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,9 +50,9 @@

    Properties

    -

    Optional enableEvents

    +

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