README.md: Small refinements
[poolifier.git] / src / pools / pool.ts
1 /**
2 * Contract definition for a poolifier pool.
3 *
4 * @template Data Type of data sent to the worker.
5 * @template Response Type of response of execution.
6 */
7 export interface IPool<Data = unknown, Response = unknown> {
8 /**
9 * Perform the task specified in the constructor with the data parameter.
10 *
11 * @param data The input for the specified task.
12 * @returns Promise that will be resolved when the task is successfully completed.
13 */
14 execute(data: Data): Promise<Response>
15 /**
16 * Shut down every current worker in this pool.
17 */
18 destroy(): Promise<void>
19 }