[poolifier.git] / src / pools / pool.ts

/**
 * Contract definition for a poolifier pool.
 *
 * @template Data Type of data sent to the worker.
 * @template Response Type of response of execution.
 */
export interface IPool<Data = unknown, Response = unknown> {
  /**
   * Shut down every current worker in this pool.
   */
  destroy(): Promise<void>
  /**
   * Perform the task specified in the constructor with the data parameter.
   *
   * @param data The input for the specified task.
   * @returns Promise that will be resolved when the task is successfully completed.
   */
  execute(data: Data): Promise<Response>
}
Commit	Line	Data
	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	* Shut down every current worker in this pool.
	10	*/
	11	destroy(): Promise<void>
	12	/**
	13	* Perform the task specified in the constructor with the data parameter.
	14	*
	15	* @param data The input for the specified task.
	16	* @returns Promise that will be resolved when the task is successfully completed.
	17	*/
	18	execute(data: Data): Promise<Response>
	19	}