IPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=c6e2995e72f26d899d8bb6aaed60a5b8c82f28e3;hb=8d1797ad15cb2d87ac3c9904ce6df3db45c0c742;hp=7efd9779ab1e386b03c87ca8ffb0a7f53c7749e9;hpb=a8aeac440fb425585a0d597af86f616e648ae156;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 7efd9779..c6e2995e 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier

+IPool | poolifier

@@ -22,15 +22,15 @@

Type Parameters

-
Worker extends IWorker
+
Worker extends IWorker

Type of worker which manages this pool.
-
Data = unknown
+
Data = unknown

Type of data sent to the worker. This can only be serializable data.
-
Response = unknown
+
Response = unknown

Type of execution response. This can only be serializable data.

@@ -40,9 +40,9 @@

Implemented by

AbstractPool

Defined in src/pools/pool.ts:119

Properties

destroy

destroy: (() => Promise<void>)

Type declaration

-
- (): Promise<void>

Defined in src/pools/pool.ts:163

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

Events that can currently be listened to:

@@ -89,16 +89,16 @@

Defined in src/pools/pool.ts:142

enableTasksQueue

enableTasksQueue: ((enable: boolean, opts?: TasksQueueOptions) => void)

enableTasksQueue: ((enable, tasksQueueOptions?) => void)

Type declaration

-
- (enable: boolean, opts?: TasksQueueOptions): void

`Optional` tasksQueueOptions: TasksQueueOptions

The worker tasks queue options.

Returns void

Defined in src/pools/pool.ts:188

execute

execute: ((data: Data) => Promise<Response>)

execute: ((data?) => Promise<Response>)

Type declaration

-
- (data: Data): Promise<Response>

Defined in src/pools/pool.ts:159

findFreeWorkerNodeKey

findFreeWorkerNodeKey: (() => number)

Type declaration

Defined in src/pools/pool.ts:152

setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions: TasksQueueOptions) => void)

setTasksQueueOptions: ((tasksQueueOptions) => void)

Type declaration

-
- (tasksQueueOptions: TasksQueueOptions): void

Returns void

Defined in src/pools/pool.ts:197

setWorkerChoiceStrategy

setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions) => void)

setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)

Type declaration

-
- (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions): void