X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FThreadPoolOptions.html;h=da63aeb803473cf559b04ff9c369beb16d7a110f;hb=1ed7fb6c99f2fcb5f319d9c1fa2aefc5434f82e4;hp=1a2b42339ddf8ad5ca81e45bb36915ffe81dce3e;hpb=603ce450e1c02a53a06aff9e9ba5f3cdee24a3f2;p=poolifier.git diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index 1a2b4233..da63aeb8 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -1,13 +1,13 @@ -ThreadPoolOptions | poolifier - v2.6.34
+ThreadPoolOptions | poolifier - v3.0.2
-
+
  • The search index is not available
  • poolifier - v3.0.2 +
    @@ -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,63 +50,73 @@

    Properties

    - +
    enableEvents?: boolean
    -

    Pool events emission.

    +

    Pool events integrated with async resource emission.

    -

    Default Value

    true

    +

    Default Value

    true
    +
    +
  • Defined in src/pools/pool.ts:181
  • enableTasksQueue?: boolean

    Pool worker node tasks queue.

    -

    Default Value

    false

    +

    Default Value

    false
    +
    +
  • Defined in src/pools/pool.ts:187
  • errorHandler?: ErrorHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:149
  • exitHandler?: ExitHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:155
  • messageHandler?: MessageHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:143
  • onlineHandler?: OnlineHandler<Worker>

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

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

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

    +
    +
    +

    Default Value

    true
    +
    +
    tasksQueueOptions?: TasksQueueOptions
    @@ -123,18 +146,19 @@
    +
  • Defined in src/pools/pool.ts:191
  • 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
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -143,7 +167,7 @@
    +
  • Defined in src/pools/pool.ts:171
  • workerOptions?: WorkerOptions
    @@ -153,12 +177,12 @@

    See

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

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

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file