PoolOptions | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=0d8f167fa5081a0711fa55c7a22151e68bcec537;hb=811dc01fd8bb1b23cc3e6e72f7fbc82cc8f473ae;hp=220ca0fee2433780607dd4aa25f51a039d19e710;hpb=812ad701baefad24cad2df8f9a60bf4d581d8697;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 220ca0fe..0d8f167f 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,4 +1,4 @@ -PoolOptions | poolifier

+PoolOptions | poolifier

@@ -18,19 +18,21 @@

Options for a poolifier pool.

-

+

Type Parameters

-

-
Worker extends IWorker

+

Worker extends IWorker

+

Type of worker.

+

Hierarchy

PoolOptions
- ClusterPoolOptions

@@ -38,87 +40,87 @@

Properties

-

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

enableEvents? +enableTasksQueue? +errorHandler? +exitHandler? +messageHandler? +onlineHandler? +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:99

+

+

`Optional` enableTasksQueue

+

enableTasksQueue?: boolean

Pool worker tasks queue.

Default Value

false

-

+

Defined in src/pools/pool.ts:105

+

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

-

-

`Optional` `Experimental` tasksQueueOptions

-

tasksQueueOptions?: TasksQueueOptions

+

Defined in src/pools/pool.ts:79

+

+

`Optional` tasksQueueOptions

+

tasksQueueOptions?: TasksQueueOptions

Pool worker tasks queue options.

- -

Default Value

{ concurrency: 1 }

-

+

Defined in src/pools/pool.ts:109

+

`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:89

+

`Optional` workerChoiceStrategyOptions

-

workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

+

workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

The worker choice strategy options.

+

Defined in src/pools/pool.ts:93

+

Theme

+

+

enableTasksQueue

+

+

+

+

+

tasksQueueOptions

+

workerChoiceStrategy

+

workerChoiceStrategyOptions

+

+

+

+

+

+

DynamicClusterPool

+

DynamicThreadPool

+

FixedClusterPool

+

FixedThreadPool

+

+

+

+

WorkerChoiceStrategyContext

+

ClusterPoolOptions

+

+

+

IWorkerChoiceStrategy

+

+

+

PromiseResponseWrapper

+

RequiredStatistics

+

+

TasksQueueOptions

+

+

WorkerChoiceStrategyOptions

+

+

+

+

+

+

+

+

+

+

+

ThreadWorkerWithMessageChannel

+

WorkerAsyncFunction

+

WorkerChoiceStrategy

+

+

WorkerSyncFunction

+

+

+

WorkerChoiceStrategies

Generated using TypeDoc

\ No newline at end of file