X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=c9ea431f32cbac2d859bf1e7c6d11d491b03f5af;hb=2ad2e730485a924c6a03e6f6a1bc64b413b01527;hp=8125a32423b0959ce8e5538580a41eeebbb7f791;hpb=b142df6d1278e9d0b6c4c7226bf3dae36c486410;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 8125a324..c9ea431f 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,11 +1,13 @@ PoolOptions | poolifier
-
+
@@ -28,7 +30,7 @@ +
  • Defined in src/pools/pool.ts:34
    • @@ -37,11 +39,13 @@

    Properties

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

    Properties

    @@ -50,45 +54,61 @@
    enableEvents?: boolean

    Pool events emission.

    -

    Default

    true

    +

    Default Value

    true

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

    Optional Experimental enableTasksQueue

    +
    enableTasksQueue?: boolean
    +

    Pool worker tasks queue.

    + +

    Default Value

    false

    +

    Optional errorHandler

    errorHandler?: ErrorHandler<Worker>

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

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

    • Optional exitHandler

    exitHandler?: ExitHandler<Worker>

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

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

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

    • Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

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

    • Optional workerChoiceStrategy

    -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
    -

    The work choice strategy to use in this pool.

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

    The worker choice strategy to use in this pool.

    +
    +
    +

    Optional workerChoiceStrategyOptions

    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    +

    The worker choice strategy options.

    +
  • Defined in src/pools/pool.ts:58
    • @@ -115,11 +135,13 @@
  • PoolOptions
    • +
  • workerChoiceStrategy?
    • +
  • workerChoiceStrategyOptions?

    • Generated using TypeDoc

    \ No newline at end of file