X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FPoolOptions.html;h=b7cfe9cf30f97f87c7c7fb89710262b17392386a;hb=afc34f0c8ee4e44ba301212a5eed3fb01035b1fb;hp=30985c43132f6a43b62f05cca3be0e6cc9f8929c;hpb=d0f1dce33156fdb99f0ca3627839001909419497;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 30985c43..b7cfe9cf 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,16 +1,198 @@ -PoolOptions | poolifier
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PoolOptions<Worker>

-

Options for a poolifier pool.

-

Type parameters

  • Worker

Hierarchy

Index

Properties

Properties

Optional enableEvents

enableEvents?: boolean
-

Pool events emission.

-
default

true

-

Optional errorHandler

errorHandler?: ErrorHandler<Worker>
-

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

-

Optional exitHandler

exitHandler?: ExitHandler<Worker>
-

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

-

Optional messageHandler

messageHandler?: MessageHandler<Worker>
-

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

-

Optional onlineHandler

onlineHandler?: OnlineHandler<Worker>
-

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

-

Optional workerChoiceStrategy

workerChoiceStrategy?: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
-

The work choice strategy to use in this pool.

-

Generated using TypeDoc

\ No newline at end of file +PoolOptions | poolifier
+
+ +
+
+
+
+ +

Interface PoolOptions<Worker>

+
+

Options for a poolifier pool.

+
+
+

Type Parameters

+
    +
  • +

    Worker extends IWorker

    +

    Type of worker.

    +
+
+

Hierarchy

+
+
+
+
+ +
+
+

Properties

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

Properties

+
+

Optional enableEvents

+
enableEvents?: boolean
+

Pool events emission.

+ +

Default Value

true

+
+
+

Optional enableTasksQueue

+
enableTasksQueue?: boolean
+

Pool worker tasks queue.

+ +

Default Value

false

+
+
+

Optional errorHandler

+
errorHandler?: ErrorHandler<Worker>
+

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

+
+
+

Optional exitHandler

+
exitHandler?: ExitHandler<Worker>
+

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

+
+
+

Optional messageHandler

+
messageHandler?: MessageHandler<Worker>
+

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

+
+
+

Optional onlineHandler

+
onlineHandler?: OnlineHandler<Worker>
+

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

+
+
+

Optional tasksQueueOptions

+
tasksQueueOptions?: TasksQueueOptions
+

Pool worker tasks queue options.

+
+
+

Optional workerChoiceStrategy

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

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file