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

Methods

Methods

destroy

destroy(): Promise<void>

- Defined in src/pools/pool.ts:20
Shut down every current worker in this pool.

Returns Promise<void>

execute

execute(data: Data): Promise<Response>

- Defined in src/pools/pool.ts:16
Perform the task specified in the constructor with the data parameter.

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

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"): void

- Defined in src/pools/pool.ts:26
Set the worker choice strategy in this pool.

Parameters
- workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
  
  The worker choice strategy.
Returns void

Generated using TypeDoc