X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=c01b93d1fccf359b082feea896f846b20b256085;hb=5decbf239157d04bdf38a642fe2757f565a8d466;hp=3560b0a6414b0906e408ad736c41280ccf70e9c0;hpb=40baeb4e66efa6646d3221029cd012fb7bda8955;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 3560b0a6..c01b93d1 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,4 +1,4 @@ -PoolOptions | poolifier
+PoolOptions | poolifier
-
+
  • poolifier
    • @@ -18,19 +18,21 @@

    Options for a poolifier pool.

    -
    +

    Type Parameters

    -
      +
      • -

        Worker

    +

    Worker extends IWorker

    +

    Type of worker.

    +

Hierarchy

@@ -38,81 +40,100 @@

Properties

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

Properties

-
+

Optional enableEvents

-
enableEvents?: boolean
+
enableEvents?: boolean

Pool events emission.

Default Value

true

-
-

Optional Experimental enableTasksQueue

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

    Optional enableTasksQueue

    +
    enableTasksQueue?: boolean

    Pool worker tasks queue.

    Default Value

    false

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

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

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

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

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

    Optional restartWorkerOnError

    +
    restartWorkerOnError?: boolean
    +

    Restart worker on error.

    +
    +
    +

    Optional tasksQueueOptions

    +
    tasksQueueOptions?: TasksQueueOptions
    +

    Pool worker tasks queue options.

    +
    +

    Optional workerChoiceStrategy

    -
    workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    +
    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

    The worker choice strategy to use in this pool.

    + +

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN

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

    Optional workerChoiceStrategyOptions

    -
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

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

    Settings

     +

    Settings

    Member Visibility

    @@ -122,26 +143,71 @@
    • -

    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