X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Futility-types.ts;h=ea90afd688d8622ee2128366c2b3e20d5302977a;hb=09564a833b20cff37a199cabe15ee5470b63e071;hp=fb0e435a81ac949b0b82740f1b17c1561bd9d762;hpb=b40ed51168059b59f6f5827def37f622be139ddb;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index fb0e435a..ea90afd6 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -39,6 +39,36 @@ export interface MessageValue< readonly parent?: MainWorker } +/** + * 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?: 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?: Data +) => Promise +/** + * 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 = + | WorkerSyncFunction + | WorkerAsyncFunction + /** * An object holding the execution response promise resolve/reject callbacks. *