X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=685e5c4c606755bf801dd6c13d582d3657f8fe8e;hb=c319c66bad0611acf6087950a1f8a20f8124167b;hp=eb3f9727369f837d9cd36d5bd6b7dd69c9d5f0c3;hpb=d56f6cfde3b9eeb2a5e4341b91ec474580a0c07a;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index eb3f9727..685e5c4c 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,56 +1,73 @@ -import type { Worker } from 'cluster' -import type { MessagePort } from 'worker_threads' +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 } from './pools/worker' /** - * Make all properties in T non-readonly + * Make all properties in T non-readonly. */ export type Draft = { -readonly [P in keyof T]?: T[P] } -/** - * 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. - */ -export type JSONObject = { [k: string]: JSONValue } -/** - * Serializable JSON array. - */ -export type JSONArray = Array - /** * Message object that is passed between worker and main worker. + * + * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam MainWorker - Type of main worker. */ export interface MessageValue< Data = unknown, - MainWorker extends Worker | MessagePort | unknown = 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 + readonly id?: string /** * 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 worker: Worker +}