X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=f885e35d9029c0ae70b190704ef46b5db3ede894;hb=e1d3eccbb484bfbe36f6dcb9c4ef22a11621a00b;hp=3560b0a6414b0906e408ad736c41280ccf70e9c0;hpb=40baeb4e66efa6646d3221029cd012fb7bda8955;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 3560b0a6..f885e35d 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,4 +1,4 @@ -PoolOptions | poolifier
+PoolOptions | poolifier
-
+
  • poolifier
  • @@ -22,7 +22,9 @@

    Type Parameters

    • -

      Worker

    +

    Worker extends IWorker

    +

    Type of worker.

    +

Hierarchy

+
  • Defined in src/pools/pool.ts:67
  • @@ -44,6 +46,7 @@ exitHandler? messageHandler? onlineHandler? +tasksQueueOptions? workerChoiceStrategy? workerChoiceStrategyOptions?
    @@ -57,62 +60,72 @@

    Default Value

    true

    +
  • Defined in src/pools/pool.ts:99
  • - +
    enableTasksQueue?: boolean

    Pool worker tasks queue.

    Default Value

    false

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

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

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

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

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

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

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

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

    +
  • Defined in src/pools/pool.ts:79
  • +
    + +
    tasksQueueOptions?: TasksQueueOptions
    +

    Pool worker tasks queue options.

    +
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

    The worker choice strategy to use in this pool.

    + +

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

    +
  • Defined in src/pools/pool.ts:89
  • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    - +
    +
    -
    +
  • enableEvents
  • +
  • enableTasksQueue
  • +
  • errorHandler
  • +
  • exitHandler
  • +
  • messageHandler
  • +
  • onlineHandler
  • +
  • tasksQueueOptions
  • +
  • workerChoiceStrategy
  • +
  • workerChoiceStrategyOptions
  • + +

    Generated using TypeDoc

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