X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=7bcd076c291736cad1729d66a671a51b2115c1b7;hb=473c717a499d52ce8a069c43ee168b70cb5701f1;hp=aa4d058cce142ffa5214c8d2ce2965e428309d14;hpb=729c563db85562dd7d0f7733b1a3e2d98467134b;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index aa4d058c..7bcd076c 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,50 +1,68 @@ -/** - * Make all properties in T non-readonly - */ -export type Draft = { -readonly [P in keyof T]?: T[P] } +import type { Worker as ClusterWorker } from 'cluster' +import type { MessagePort } from 'worker_threads' +import type { IPoolWorker } from './pools/pool-worker' +import type { KillBehavior } from './worker/worker-options' /** - * Serializable primitive JSON value. + * Make all properties in T non-readonly. */ -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. - */ -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. */ -export interface MessageValue { +export interface MessageValue< + Data = unknown, + MainWorker extends ClusterWorker | MessagePort | unknown = unknown +> { /** * Input data that will be passed to the worker. */ readonly data?: Data /** - * ID of the message. + * Id of the message. */ readonly id?: number /** * Kill code. */ - readonly kill?: number + readonly kill?: KillBehavior | 1 /** * Error. */ readonly error?: string + /** + * Task runtime. + */ + readonly taskRunTime?: number /** * Reference to main worker. * - * _Only for internal use_ + * Only for internal use. + */ + readonly parent?: MainWorker +} + +/** + * An object holding the worker that will be used to resolve/rejects the promise later on. + * + * @template Worker Type of worker. + * @template Response Type of response of execution. This can only be serializable data. + */ +export interface PromiseWorkerResponseWrapper< + Worker extends IPoolWorker, + 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 that has the assigned task. */ - readonly parent?: MessagePort + readonly worker: Worker }