X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=6c1ffa5c074006ee9f302f2b57b4f66587acd6c6;hb=800480935c90f3847c389dd5dbfca11760e78675;hp=e48ddb38261faeeeee73478f29572003bc4c5d2e;hpb=a25c335d7e5573a171fc96c445cb6092852b2c4a;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index e48ddb38..6c1ffa5c 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,13 +1,13 @@ -PoolOptions | poolifier - v2.6.30
+PoolOptions | poolifier - v3.0.1
-
+
  • The search index is not available
  • poolifier - v3.0.1 +
    @@ -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

    - +
    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
  • enableTasksQueue?: boolean
    -

    Pool worker tasks queue.

    +

    Pool worker node tasks queue.

    -

    Default Value

    false

    +

    Default Value

    false
    +
    +
  • Defined in src/pools/pool.ts:187
  • errorHandler?: ErrorHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:149
  • exitHandler?: ExitHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:155
  • messageHandler?: MessageHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:143
  • onlineHandler?: OnlineHandler<Worker>

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

    -
    +
  • Defined in src/pools/pool.ts:137
  • restartWorkerOnError?: boolean
    @@ -115,25 +126,37 @@
    +
  • Defined in src/pools/pool.ts:175
  • +
    + +
    startWorkers?: boolean
    +

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

    +
    +
    +

    Default Value

    true
    +
    +
    tasksQueueOptions?: TasksQueueOptions
    -

    Pool worker tasks queue options.

    +

    Pool worker node tasks queue options.

    +
  • Defined in src/pools/pool.ts:191
  • 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
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    @@ -141,12 +164,12 @@
    +
  • Defined in src/pools/pool.ts:171
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file