X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=302dfd643a084c437cad260171d5066b8e516954;hb=bf4dcb92f8d370524a2975961731fe6c4e8b083c;hp=0025f6c459c50f5e45260f20ecf9489709306f42;hpb=3aaed019abde0022e986c1db05db9d5d7bc76594;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 0025f6c4..302dfd64 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,4 +1,4 @@ -PoolOptions | poolifier
+PoolOptions | poolifier
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier
    -
    +
    • poolifier
      • @@ -18,19 +18,21 @@

      Options for a poolifier pool.

      -
      +

      Type Parameters

      -
        +
        • -

          Worker

      +

      Worker extends IWorker

      +

      Type of worker.

      +

    Hierarchy

    @@ -38,63 +40,92 @@

    Properties

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

    Properties

    -
    +

    Optional enableEvents

    -
    enableEvents?: boolean
    +
    enableEvents?: boolean

    Pool events emission.

    -

    Default

    true

    +

    Default Value

    true

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

    Optional 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:75
    • +

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

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

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

    Optional 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.

    + +

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

    +
    +
    +

    Optional workerChoiceStrategyOptions

    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    +

    The worker choice strategy options.

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

    Settings

     +

    Settings

    Member Visibility

    @@ -104,24 +135,65 @@
    • -

    Theme

    -
    +
    +

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

    Generated using TypeDoc

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