IPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=61d1b615339d614f5a4bdc682e20f12d7041e67f;hb=ec06e4dd01adf7aa4bab470c59da42c19d863d0b;hp=2f0722e9821d4906197a335050a240ed5ce6331e;hpb=5a94e4b950eaf2234e07f87261ddea1482e839c6;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 2f0722e9..61d1b615 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier

+IPool | poolifier

@@ -63,27 +63,28 @@

Returns Promise<void>

Defined in src/pools/pool.ts:120

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

Events that can currently be listened to:

'busy'
'full': Emitted when the pool is dynamic and full.
'busy': Emitted when the pool is busy.

Defined in src/pools/pool.ts:109

execute

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

Type declaration

- (data: Data): Promise<Response>
- (data: Data): Promise<Response>
- Performs the task specified in the constructor with the data parameter.
  @@ -93,21 +94,21 @@
  Parameters
  - -
    data: Data
    +
    data: Data
    
    The input for the specified task. This can only be serializable data.
  -
  Returns Promise<Response>

Defined in src/pools/pool.ts:116

setWorkerChoiceStrategy

setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)

setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)

Type declaration

- (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
- (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
- Sets the worker choice strategy in this pool.
  
  @@ -115,16 +116,17 @@
  Parameters
  - -
    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.