X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=25978b6908b60c2ae131d62a5775bdbf48a526e3;hb=d655c2c2b159a39f900230c14b301ba123653362;hp=a88c02fc751f03eb33728a18f1d088e5a6d1cde2;hpb=74f29142ea20199700ef7021402616ea9de714a8;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index a88c02fc..25978b69 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,70 @@

    Default Value

    true

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

    Optional Experimental enableTasksQueue

    +

    Optional enableTasksQueue

    enableTasksQueue?: boolean

    Pool worker tasks queue.

    Default Value

    false

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

    • Optional errorHandler

    -
    errorHandler?: ErrorHandler<Worker>
    +
    errorHandler?: ErrorHandler<Worker>

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

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

    • Optional exitHandler

    -
    exitHandler?: ExitHandler<Worker>
    +
    exitHandler?: ExitHandler<Worker>

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

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

    • Optional messageHandler

    -
    messageHandler?: MessageHandler<Worker>
    +
    messageHandler?: MessageHandler<Worker>

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

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

    • Optional onlineHandler

    -
    onlineHandler?: OnlineHandler<Worker>
    +
    onlineHandler?: OnlineHandler<Worker>

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

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

    Optional tasksQueueOptions

    +
    tasksQueueOptions?: TasksQueueOptions
    +

    Pool worker tasks queue options.

    +

    Optional workerChoiceStrategy

    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:87

    • Optional workerChoiceStrategyOptions

    -
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

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

    Settings

     +

    Settings

    Member Visibility

    @@ -123,25 +134,60 @@

    • Theme

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

    Generated using TypeDoc

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