X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=2eef830a888232807366fa6ff5dc8a32dfe80ff6;hb=9867896b122160ea5d8e6dbccba4cc5916bf523b;hp=ffb1d84054f30f97a22c845894311fe08002d42a;hpb=e905ea64c054a25ef73885e41fc063279bc599ca;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index ffb1d840..2eef830a 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,4 +1,4 @@ -ClusterPoolOptions | poolifier - v2.6.44
+ClusterPoolOptions | poolifier - v2.6.45
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.44
+
  • The search index is not available
    • poolifier - v2.6.45
    @@ -26,7 +26,7 @@
    • ClusterPoolOptions
    +
  • Defined in src/pools/cluster/fixed.ts:10
    • @@ -43,6 +43,7 @@ onlineHandler? restartWorkerOnError? settings? +startWorkers? tasksQueueOptions? workerChoiceStrategy? workerChoiceStrategyOptions? @@ -60,7 +61,7 @@
    +
  • Defined in src/pools/pool.ts:185

    • Optional enableTasksQueue

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

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

    • 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,7 +167,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"
    @@ -158,7 +179,7 @@
    +
  • Defined in src/pools/pool.ts:171

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -167,7 +188,7 @@
    +
  • Defined in src/pools/pool.ts:175
    • @@ -196,11 +217,12 @@
  • onlineHandler
  • restartWorkerOnError
  • settings
    • +
  • startWorkers
  • tasksQueueOptions
  • workerChoiceStrategy
  • workerChoiceStrategyOptions
    • -