X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FClusterPoolOptions.html;h=0caab6e7a5e8c1bdbdd2f8614c220814361f6dc7;hb=2771e5dcac6411a9731c66730072fcc578ff701c;hp=0bc90ef666b859b46cc0e7eaba8954a15911d30c;hpb=6b83e544b1827a8a04898c3032dab73fe19687e6;p=poolifier.git diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index 0bc90ef6..0caab6e7 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,13 +1,13 @@ -ClusterPoolOptions | poolifier - v2.6.23
+ClusterPoolOptions | poolifier - v2.7.2
-
+
  • The search index is not available
    • poolifier - v2.7.2 +
    @@ -26,15 +26,15 @@
    • ClusterPoolOptions
    +
  • Defined in src/pools/cluster/fixed.ts:10
    • - +

    Properties

    -
    enableEvents? +
    enableEvents? enableTasksQueue? env? errorHandler? @@ -43,6 +43,7 @@ onlineHandler? restartWorkerOnError? settings? +startWorkers? tasksQueueOptions? workerChoiceStrategy? workerChoiceStrategyOptions? @@ -50,27 +51,29 @@

    Properties

    -

    Optional enableEvents

    +

    Optional enableEvents

    enableEvents?: boolean

    Pool events emission.

    -

    Default Value

    true

    +

    Default Value

    true
+
    +
  • Defined in src/pools/pool.ts:186

    • Optional enableTasksQueue

    enableTasksQueue?: boolean
    -

    Pool worker tasks queue.

    +

    Pool worker node tasks queue.

    -

    Default Value

    false

    +

    Default Value

    false
+
    +
  • Defined in src/pools/pool.ts:192

    • Optional env

    env?: Record<string, unknown>
    @@ -80,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:154

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:160

    • Optional messageHandler

    messageHandler?: MessageHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:148

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:142

    • Optional restartWorkerOnError

    restartWorkerOnError?: boolean
    @@ -125,7 +136,7 @@
    +
  • Defined in src/pools/pool.ts:180

    • Optional settings

    settings?: ClusterSettings
    @@ -135,27 +146,40 @@

    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
    -

    Pool worker tasks queue options.

    +

    Pool worker node tasks queue options.

    +
  • Defined in src/pools/pool.ts:196

    • 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:172

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -164,20 +188,20 @@
    +
  • Defined in src/pools/pool.ts:176
    • -

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    @@ -193,71 +217,35 @@
  • onlineHandler
  • restartWorkerOnError
  • settings
    • +
  • startWorkers
  • tasksQueueOptions
  • workerChoiceStrategy
  • workerChoiceStrategyOptions
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file