X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=6c1ffa5c074006ee9f302f2b57b4f66587acd6c6;hb=800480935c90f3847c389dd5dbfca11760e78675;hp=0c74a971ac921b2e0222d397f7c42a67d5590a62;hpb=7455be54c58f74c6f0d0dd597aa431a88da0a9d8;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 0c74a971..6c1ffa5c 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,4 +1,4 @@ -PoolOptions | poolifier - v2.6.42
+PoolOptions | poolifier - v3.0.1
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.42
+
  • The search index is not available
    • poolifier - v3.0.1
    @@ -35,7 +35,7 @@
  • ClusterPoolOptions
  • ThreadPoolOptions
    • +
  • Defined in src/pools/pool.ts:131
    • @@ -50,6 +50,7 @@ messageHandler? onlineHandler? restartWorkerOnError? +startWorkers? tasksQueueOptions? workerChoiceStrategy? workerChoiceStrategyOptions? @@ -59,14 +60,14 @@

    Optional enableEvents

    enableEvents?: boolean
    -

    Pool events emission.

    +

    Pool events integrated with async resource emission.

    Default Value

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

    • Optional enableTasksQueue

    enableTasksQueue?: boolean
    @@ -77,39 +78,47 @@
    +
  • 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
    @@ -117,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
    @@ -125,18 +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
    @@ -144,7 +164,7 @@
    +
  • Defined in src/pools/pool.ts:171
    • @@ -154,10 +174,10 @@

    Member Visibility

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

    • Theme

    @@ -171,11 +191,12 @@
  • messageHandler
  • onlineHandler
  • restartWorkerOnError
    • +
  • startWorkers
  • tasksQueueOptions
  • workerChoiceStrategy
  • workerChoiceStrategyOptions
    • -

    Generated using TypeDoc

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