X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=e48ded5373695b4f778d43da19f00c2cf5b0ee3f;hb=1d9e702392092e351b448175a77c16234eec9212;hp=54bb7461f6fa5cafb2cb04270ce732b093d8ce53;hpb=2740a743fcbf64e0ee674530e3cbcf6df710c1ef;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 54bb7461..e48ded53 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,6 +1,7 @@ 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' /** * Make all properties in T non-readonly. @@ -8,20 +9,16 @@ import type { KillBehavior } from './worker/worker-options' 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< Data = unknown, MainWorker extends ClusterWorker | MessagePort | unknown = unknown -> { - /** - * Input data that will be passed to the worker. - */ - readonly data?: Data - /** - * Id of the message. - */ - readonly id?: string +> extends Task { /** * Kill code. */ @@ -31,13 +28,14 @@ export interface MessageValue< */ readonly error?: string /** - * Task runtime. + * Runtime. */ - readonly taskRunTime?: number + readonly runTime?: number /** * Reference to main worker. * * Only for internal use. + * @internal */ readonly parent?: MainWorker } @@ -45,9 +43,14 @@ export interface MessageValue< /** * 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 { +export interface PromiseResponseWrapper< + Worker extends IWorker, + Response = unknown +> { /** * Resolve callback to fulfill the promise. */ @@ -57,7 +60,7 @@ export interface PromiseResponseWrapper { */ readonly reject: (reason?: string) => void /** - * The worker handling the promise key . + * The worker handling the execution. */ - readonly workerKey: number + readonly worker: Worker }