X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=96cdc49104a77951d01e6e728390c3eaa6332d53;hb=e39450c0889208d6dcde666fc05b95fe7a98ee29;hp=3560b0a6414b0906e408ad736c41280ccf70e9c0;hpb=40baeb4e66efa6646d3221029cd012fb7bda8955;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 3560b0a6..96cdc491 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

    +

    The worker type.

    +

Hierarchy

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

    Default Value

    true

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

    • Optional Experimental enableTasksQueue

    enableTasksQueue?: boolean
    @@ -66,53 +69,61 @@

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

    • 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:82

    • 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:70

    • 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:78
    • +
    +

    Optional Experimental 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:86

    • Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

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

    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