X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=e48ded5373695b4f778d43da19f00c2cf5b0ee3f;hb=1d9e702392092e351b448175a77c16234eec9212;hp=aa4d058cce142ffa5214c8d2ce2965e428309d14;hpb=729c563db85562dd7d0f7733b1a3e2d98467134b;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index aa4d058c..e48ded53 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,50 +1,66 @@ -/** - * Make all properties in T non-readonly - */ -export type Draft = { -readonly [P in keyof T]?: T[P] } +import type { Worker as ClusterWorker } from 'node:cluster' +import type { MessagePort } from 'node:worker_threads' +import type { KillBehavior } from './worker/worker-options' +import type { IWorker, Task } from './pools/worker' /** - * Serializable primitive JSON value. - */ -export type JSONPrimitive = number | boolean | string | null -/** - * Serializable JSON value. - */ -// eslint-disable-next-line no-use-before-define -export type JSONValue = JSONPrimitive | JSONArray | JSONObject -/** - * Serializable JSON object. + * Make all properties in T non-readonly. */ -export type JSONObject = { [k: string]: JSONValue } -/** - * Serializable JSON array. - */ -export type JSONArray = Array +export type Draft = { -readonly [P in keyof T]?: T[P] } /** - * Message object that is passed between worker and main worker. + * Message object that is passed between main worker and worker. + * + * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam MainWorker - Type of main worker. + * @internal */ -export interface MessageValue { - /** - * Input data that will be passed to the worker. - */ - readonly data?: Data - /** - * ID of the message. - */ - readonly id?: number +export interface MessageValue< + Data = unknown, + MainWorker extends ClusterWorker | MessagePort | unknown = unknown +> extends Task { /** * Kill code. */ - readonly kill?: number + readonly kill?: KillBehavior | 1 /** * Error. */ readonly error?: string + /** + * Runtime. + */ + readonly runTime?: number /** * Reference to main worker. * - * _Only for internal use_ + * Only for internal use. + * @internal + */ + readonly parent?: MainWorker +} + +/** + * An object holding the execution response promise resolve/reject callbacks. + * + * @typeParam Worker - Type of worker. + * @typeParam Response - Type of execution response. This can only be serializable data. + * @internal + */ +export interface PromiseResponseWrapper< + Worker extends IWorker, + Response = unknown +> { + /** + * Resolve callback to fulfill the promise. + */ + readonly resolve: (value: Response) => void + /** + * Reject callback to reject the promise. + */ + readonly reject: (reason?: string) => void + /** + * The worker handling the execution. */ - readonly parent?: MessagePort + readonly worker: Worker }