[poolifier.git] / src / worker / worker-functions.ts

/**
 * Worker synchronous function that can be executed.
 *
 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
 * @typeParam Response - Type of execution response. This can only be serializable data.
 */
export type WorkerSyncFunction<Data = unknown, Response = unknown> = (
  data?: Data
) => Response

/**
 * Worker asynchronous function that can be executed.
 * This function must return a promise.
 *
 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
 * @typeParam Response - Type of execution response. This can only be serializable data.
 */
export type WorkerAsyncFunction<Data = unknown, Response = unknown> = (
  data?: Data
) => Promise<Response>

/**
 * Worker function that can be executed.
 * This function can be synchronous or asynchronous.
 *
 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
 * @typeParam Response - Type of execution response. This can only be serializable data.
 */
export type WorkerFunction<Data = unknown, Response = unknown> =
  | WorkerSyncFunction<Data, Response>
  | WorkerAsyncFunction<Data, Response>

/**
 * Worker functions that can be executed.
 * This object can contain synchronous or asynchronous functions.
 * The key is the name of the function.
 * The value is the function itself.
 *
 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
 * @typeParam Response - Type of execution response. This can only be serializable data.
 */
export type TaskFunctions<Data = unknown, Response = unknown> = Record<
string,
WorkerFunction<Data, Response>
>
Commit	Line	Data
b6b32453 JB	1	/**
	2	* Worker synchronous function that can be executed.
	3	*
	4	* @typeParam Data - Type of data sent to the worker. This can only be serializable data.
	5	* @typeParam Response - Type of execution response. This can only be serializable data.
	6	*/
	7	export type WorkerSyncFunction<Data = unknown, Response = unknown> = (
	8	data?: Data
	9	) => Response
	10
	11	/**
	12	* Worker asynchronous function that can be executed.
	13	* This function must return a promise.
	14	*
	15	* @typeParam Data - Type of data sent to the worker. This can only be serializable data.
	16	* @typeParam Response - Type of execution response. This can only be serializable data.
	17	*/
	18	export type WorkerAsyncFunction<Data = unknown, Response = unknown> = (
	19	data?: Data
	20	) => Promise<Response>
	21
	22	/**
	23	* Worker function that can be executed.
	24	* This function can be synchronous or asynchronous.
	25	*
	26	* @typeParam Data - Type of data sent to the worker. This can only be serializable data.
	27	* @typeParam Response - Type of execution response. This can only be serializable data.
	28	*/
	29	export type WorkerFunction<Data = unknown, Response = unknown> =
	30	\| WorkerSyncFunction<Data, Response>
	31	\| WorkerAsyncFunction<Data, Response>
	32
	33	/**
	34	* Worker functions that can be executed.
	35	* This object can contain synchronous or asynchronous functions.
	36	* The key is the name of the function.
	37	* The value is the function itself.
	38	*
	39	* @typeParam Data - Type of data sent to the worker. This can only be serializable data.
	40	* @typeParam Response - Type of execution response. This can only be serializable data.
	41	*/
	42	export type TaskFunctions<Data = unknown, Response = unknown> = Record<
	43	string,
	44	WorkerFunction<Data, Response>
	45	>