X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=342b3f9725f03a783003287b9ff6073c3e3183b2;hb=1ed7fb6c99f2fcb5f319d9c1fa2aefc5434f82e4;hp=a853d63003d60db7273ac5e3645c9311a536bf18;hpb=396360a789e4806699533ddf899c79dc2b7ae868;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index a853d630..342b3f97 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,13 +1,13 @@ -PoolOptions | poolifier
+PoolOptions | poolifier - v3.0.2
-
+
  • The search index is not available
  • poolifier - v3.0.2 +
    @@ -17,115 +17,159 @@

    Interface PoolOptions<Worker>

    Options for a poolifier pool.

    -
    +
    +

    Type Parameters

    +
    +

    Hierarchy

    - +

    Properties

    - +
    enableEvents?: boolean
    -

    Pool events emission.

    - -

    Default Value

    true

    +

    Pool events integrated with async resource emission.

    +
    +
    +

    Default Value

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

    Pool worker tasks queue.

    - -

    Default Value

    false

    +

    Pool worker node tasks queue.

    +
    +
    +

    Default Value

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

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

    +
    +
    +

    Default Value

    () => {}

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

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

    +
    +
    +

    Default Value

    () => {}

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

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

    +
    +
    +

    Default Value

    () => {}

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

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

    +
    +
    +

    Default Value

    () => {}

    +
  • Defined in src/pools/pool.ts:137
  • +
    + +
    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:191
  • - -
    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:167
  • - +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    +
  • Defined in src/pools/pool.ts:171
  • +
  • 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