Interface IPool<Data, Response>

Contract definition for a poolifier pool.

Type Parameters

Data = unknown

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

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

Hierarchy

IPool

Index

Properties

destroy emitter? execute setWorkerChoiceStrategy

Properties

destroy

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

Type declaration

- (): Promise<void>
- Shutdowns every current worker in this pool.
  
  Returns Promise<void>

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

Events that can currently be listened to:

'busy'

execute

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

Type declaration

- (data: Data): Promise<Response>
- Performs the task specified in the constructor with the data parameter.
  
  Returns
  Promise that will be resolved when the task is successfully completed.
  Parameters
  - data: Data
    
    The input for the specified task. This can only be serializable data.
  Returns Promise<Response>

setWorkerChoiceStrategy

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

Type declaration

- (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
- Sets the worker choice strategy in this pool.
  Parameters
  - workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
    
    The worker choice strategy.
  Returns void

Generated using TypeDoc