X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=ae955104ce5982eb2bc06bc2cdc2bcea47b248c0;hb=2447ee8ce5d3db1253c7286482e5a54e84618ecf;hp=a88c02fc751f03eb33728a18f1d088e5a6d1cde2;hpb=ffc8d14415d44de881ee66ee60fc74da48084976;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index a88c02fc..7bd10e8e 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,4 +1,4 @@ -PoolOptions | poolifier
+PoolOptions | poolifier - v2.6.24
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.24
    -
    +
    • poolifier
      • @@ -17,20 +17,25 @@

      Interface PoolOptions<Worker>

    Options for a poolifier pool.

    -
    -
    +
    +
    +

    Type Parameters

    -
      +
      • -

        Worker

    +

    Worker extends IWorker

    +

    Type of worker.

    +
    +

    Hierarchy

    @@ -38,81 +43,110 @@

    Properties

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

    Properties

    -
    -

    Optional enableEvents

    -
    enableEvents?: boolean
    +
    +

    Optional enableEvents

    +
    enableEvents?: boolean

    Pool events emission.

    - -

    Default Value

    true

    +
    +
    +

    Default Value

    true

    -
    -

    Optional Experimental enableTasksQueue

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

    Optional enableTasksQueue

    +
    enableTasksQueue?: boolean

    Pool worker tasks queue.

    - -

    Default Value

    false

    +
    +
    +

    Default Value

    false

    -
    -

    Optional errorHandler

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

    Optional errorHandler

    +
    errorHandler?: ErrorHandler<Worker>

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

    -
    +
    -
    -

    Optional exitHandler

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

    Optional exitHandler

    +
    exitHandler?: ExitHandler<Worker>

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

    -
    +
    -
    -

    Optional messageHandler

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

    Optional messageHandler

    +
    messageHandler?: MessageHandler<Worker>

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

    -
    -
    -

    Optional onlineHandler

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

    Optional onlineHandler

    +
    onlineHandler?: OnlineHandler<Worker>

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

    -
    +
    +

    Optional restartWorkerOnError

    +
    restartWorkerOnError?: boolean
    +

    Restart worker on error.

    +
    +
    -
    -

    Optional workerChoiceStrategy

    -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    +
  • Defined in src/pools/pool.ts:142
    • +
    +

    Optional tasksQueueOptions

    +
    tasksQueueOptions?: TasksQueueOptions
    +

    Pool worker tasks queue options.

    +
    +
    +
    +

    Optional workerChoiceStrategy

    +
    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

    -
    -

    Optional workerChoiceStrategyOptions

    -
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    +
  • Defined in src/pools/pool.ts:134
    • +
    +

    Optional workerChoiceStrategyOptions

    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

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

    Settings

     +

    Settings

    Member Visibility

    @@ -122,26 +156,83 @@
    • -

    Theme

    -
    +
    +

    On This Page
    - -
    +
  • enableEvents
    • +
  • enableTasksQueue
    • +
  • errorHandler
    • +
  • exitHandler
    • +
  • messageHandler
    • +
  • onlineHandler
    • +
  • restartWorkerOnError
    • +
  • tasksQueueOptions
    • +
  • workerChoiceStrategy
    • +
  • workerChoiceStrategyOptions
    • +
    +
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file