X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=ab3ad6ceb7bb6439504f17fcfa0f920bca0e9845;hb=fe443f3119b105ccb6dd6f95260de3809e817066;hp=f5cf8b783bd8be506e93e3ebe288cb74d8200a84;hpb=665702eef3ad8153279b344e0276687f7f50c10f;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index f5cf8b78..ab3ad6ce 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,4 +1,4 @@ -ClusterPoolOptions | poolifier - v2.6.42
+ClusterPoolOptions | poolifier - v3.0.3
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.42
+
  • The search index is not available
    • poolifier - v3.0.3
    @@ -26,7 +26,7 @@
    • ClusterPoolOptions
    +
  • Defined in src/pools/cluster/fixed.ts:10
    • @@ -43,6 +43,7 @@ onlineHandler? restartWorkerOnError? settings? +startWorkers? tasksQueueOptions? workerChoiceStrategy? workerChoiceStrategyOptions? @@ -52,7 +53,7 @@

    Optional enableEvents

    enableEvents?: boolean
    -

    Pool events emission.

    +

    Pool events integrated with async resource emission.

    Default Value

    true
@@ -60,7 +61,7 @@
    +
  • Defined in src/pools/pool.ts:181

    • Optional enableTasksQueue

    enableTasksQueue?: boolean
    @@ -72,7 +73,7 @@
    +
  • Defined in src/pools/pool.ts:187

    • Optional env

    env?: Record<string, unknown>
    @@ -82,43 +83,51 @@

    See

    https://nodejs.org/api/cluster.html#cluster_cluster_fork_env

    +
  • Defined in src/pools/cluster/fixed.ts:16

    • 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
    @@ -127,7 +136,7 @@
    +
  • Defined in src/pools/pool.ts:175

    • Optional settings

    settings?: ClusterSettings
    @@ -137,7 +146,19 @@

    See

    https://nodejs.org/api/cluster.html#cluster_cluster_settings

    +
  • Defined in src/pools/cluster/fixed.ts:22
    • +
    +

    Optional startWorkers

    +
    startWorkers?: boolean
    +

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

    +
    +
    +

    Default Value

    true
+
    +

    Optional tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions
    @@ -146,19 +167,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
    @@ -167,7 +188,7 @@
    +
  • Defined in src/pools/pool.ts:171
    • @@ -177,10 +198,10 @@

    Member Visibility

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

    • Theme

    @@ -196,11 +217,12 @@
  • onlineHandler
  • restartWorkerOnError
  • settings
    • +
  • startWorkers
  • tasksQueueOptions
  • workerChoiceStrategy
  • workerChoiceStrategyOptions
    • -

    Generated using TypeDoc

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