X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FPoolOptions.html;h=220ca0fee2433780607dd4aa25f51a039d19e710;hb=812ad701baefad24cad2df8f9a60bf4d581d8697;hp=3560b0a6414b0906e408ad736c41280ccf70e9c0;hpb=18ba88e2f8612c6137bf564388ce8f905ae6d4ee;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 3560b0a6..220ca0fe 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,4 +1,4 @@ -PoolOptions | poolifier
+PoolOptions | poolifier
-
+
  • poolifier
  • @@ -22,7 +22,7 @@

    Type Parameters

    • -

      Worker

    +

    Worker extends IWorker

Hierarchy

+
  • Defined in src/pools/pool.ts:47
  • @@ -44,6 +44,7 @@ exitHandler? messageHandler? onlineHandler? +tasksQueueOptions? workerChoiceStrategy? workerChoiceStrategyOptions?
    @@ -57,7 +58,7 @@

    Default Value

    true

    +
  • Defined in src/pools/pool.ts:77
  • enableTasksQueue?: boolean
    @@ -66,53 +67,63 @@

    Default Value

    false

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

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

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

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

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

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

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

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

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

    Pool worker tasks queue options.

    + +

    Default Value

    { concurrency: 1 }

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

    The worker choice strategy to use in this pool.

    +
  • Defined in src/pools/pool.ts:67
  • 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