X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=fc3bb3c0bdcbb6fa3ad7efa41fff0f9d182388bb;hb=a4a88903255bd661b57480ce9b07dd2f2962f069;hp=b5efb6318980e8e5ddb21c82447d14d4cb25e4fa;hpb=069e56f4a71b48e89eeb1b4b2ccf693b75116f07;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index b5efb631..fc3bb3c0 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,13 +1,13 @@ -PoolOptions | poolifier - v2.6.34
+PoolOptions | poolifier - v3.0.5
-
+
  • The search index is not available
    • poolifier - v3.0.5 +
    @@ -35,21 +35,22 @@
  • ClusterPoolOptions
  • ThreadPoolOptions
    • +
  • Defined in src/pools/pool.ts:131
    • - +

    Properties

    -
    enableEvents? +
    enableEvents? enableTasksQueue? errorHandler? exitHandler? messageHandler? onlineHandler? restartWorkerOnError? +startWorkers? tasksQueueOptions? workerChoiceStrategy? workerChoiceStrategyOptions? @@ -57,57 +58,67 @@

    Properties

    -

    Optional enableEvents

    +

    Optional enableEvents

    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

    • Optional enableTasksQueue

    enableTasksQueue?: boolean

    Pool worker node tasks queue.

    -

    Default Value

    false

    +

    Default Value

    false
+
    +
  • 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
    @@ -115,7 +126,18 @@
    +
  • 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
    @@ -123,17 +145,18 @@
    +
  • 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
    @@ -141,12 +164,12 @@
    +
  • Defined in src/pools/pool.ts:171
    • -

    Settings

     +

    Settings

    Member Visibility

    @@ -168,74 +191,35 @@
  • messageHandler
  • onlineHandler
  • restartWorkerOnError
    • +
  • startWorkers
  • tasksQueueOptions
  • workerChoiceStrategy
  • workerChoiceStrategyOptions
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file