X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=fb0e435a81ac949b0b82740f1b17c1561bd9d762;hb=a3f5f781d7f502c040dd2baacd225f308446bff6;hp=0fdaa36e19c34e1ace772866e174c4d5b6905381;hpb=c923ce5670eeae4194aa996d44a1071e88cb21ad;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 0fdaa36e..fb0e435a 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,28 +1,26 @@ import type { Worker as ClusterWorker } from 'node:cluster' import type { MessagePort } from 'node:worker_threads' import type { KillBehavior } from './worker/worker-options' -import type { IPoolWorker } from './pools/pool-worker' +import type { IWorker, Task } from './pools/worker' /** * Make all properties in T non-readonly. + * + * @typeParam T - Type in which properties will be non-readonly. */ 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. */ @@ -32,13 +30,11 @@ export interface MessageValue< */ readonly error?: string /** - * Task runtime. + * Runtime. */ - readonly taskRunTime?: number + readonly runTime?: number /** * Reference to main worker. - * - * Only for internal use. */ readonly parent?: MainWorker } @@ -46,10 +42,12 @@ 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< - Worker extends IPoolWorker, + Worker extends IWorker, Response = unknown > { /** @@ -61,7 +59,7 @@ export interface PromiseResponseWrapper< */ readonly reject: (reason?: string) => void /** - * The worker handling the promise. + * The worker handling the execution. */ readonly worker: Worker }