X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=77356b8c59d70b1ef0df635ef50e4506f2c533fb;hb=aec509b85e7d73e9883c8885e27fc4e34fdaef1e;hp=b3e10e06cbe785a45fdad563fa3ca982007a0772;hpb=301c53e7ae6cf1120298ea10868a9091904c01a2;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index b3e10e06..77356b8c 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,13 +1,15 @@ -PoolOptions | poolifier
+PoolOptions | poolifier
-
+
-
+

Hierarchy

+
  • Defined in src/pools/pool.ts:64
    • @@ -37,11 +39,14 @@

    Properties

    enableEvents? +enableTasksQueue? errorHandler? exitHandler? messageHandler? onlineHandler? +tasksQueueOptions? workerChoiceStrategy? +workerChoiceStrategyOptions?

    Properties

    @@ -50,49 +55,73 @@
    enableEvents?: boolean

    Pool events emission.

    -

    Default

    true

    +

    Default Value

    true

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

    Optional Experimental enableTasksQueue

    +
    enableTasksQueue?: boolean
    +

    Pool worker tasks queue.

    + +

    Default Value

    false

    +

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

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

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

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

    Optional Experimental tasksQueueOptions

    +
    tasksQueueOptions?: TasksQueueOptions
    +

    Pool worker tasks queue options.

    +

    Optional workerChoiceStrategy

    -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    +
    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:84
    • +
    +

    Optional workerChoiceStrategyOptions

    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    +

    The worker choice strategy options.

    +
    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -103,23 +132,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