X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=1a660434f07dee07dd300b0f3473a33b529af045;hb=fc3e65861bc1939ae047ee1e8e91a1ce577035f4;hp=d680fa16ddc7e4748a41f2e878def0384eb2e305;hpb=1a81f8af06213d08267e8e7d593c5ec7be087535;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index d680fa16..1a660434 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,45 +1,28 @@ -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 { IPoolWorker } from './pools/pool-worker' import type { KillBehavior } from './worker/worker-options' /** - * 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. */ 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. */ @@ -48,10 +31,38 @@ export interface MessageValue< * 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. + * + * @typeParam Worker - Type of worker. + * @typeParam 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 worker: Worker +}