X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=6288456b81f3728c5bfbe099b8eceb5494a5642d;hb=41e3e08eb7fbcde0a69cea17e697aacb222990a6;hp=302dfd643a084c437cad260171d5066b8e516954;hpb=bf4dcb92f8d370524a2975961731fe6c4e8b083c;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 302dfd64..6288456b 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,13 +1,13 @@ -PoolOptions | poolifier
+PoolOptions | poolifier - v2.6.45
-
+
  • The search index is not available
  • poolifier - v2.6.45 +
    @@ -17,183 +17,209 @@

    Interface PoolOptions<Worker>

    Options for a poolifier pool.

    -
    +
    +

    Type Parameters

    +
    +

    Hierarchy

    - +

    Properties

    - +
    enableEvents?: boolean

    Pool events emission.

    - -

    Default Value

    true

    +
    +
    +

    Default Value

    true
    +
    +
  • Defined in src/pools/pool.ts:185
  • - +
    enableTasksQueue?: boolean
    -

    Pool worker tasks queue.

    - -

    Default Value

    false

    +

    Pool worker node tasks queue.

    +
    +
    +

    Default Value

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

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

    +
    +
    +

    Default Value

    () => {}

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

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

    +
    +
    +

    Default Value

    () => {}

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

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

    +
    +
    +

    Default Value

    () => {}

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

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

    +
    +
    +

    Default Value

    () => {}

    +
  • Defined in src/pools/pool.ts:141
  • +
    + +
    restartWorkerOnError?: boolean
    +

    Restart worker on error.

    +
    +
    +
    + +
    startWorkers?: boolean
    +

    Whether to start the minimum number of workers at pool initialization.

    +
    +
    +

    Default Value

    true
    +
    +
    - +
    tasksQueueOptions?: TasksQueueOptions
    -

    Pool worker tasks queue options.

    -
    +
  • Defined in src/pools/pool.ts:195
  • - -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    + +
    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

    The worker choice strategy to use in this pool.

    - -

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

    +
    +
    +

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN
    +
    +
  • Defined in src/pools/pool.ts:171
  • - +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

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

    On This Page

    +

    On This Page

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

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file