X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=fb0e435a81ac949b0b82740f1b17c1561bd9d762;hb=d29bce7c35c0be75535b4d1eb0f22ef38b3f8204;hp=458b31a055ef7d4a92e86bd9f9fbd1be46512d80;hpb=f06e48d8e14dcfe3277bd16b1bd2463136af13e6;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 458b31a0..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 { IWorker } from './pools/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. */ @@ -37,8 +35,6 @@ export interface MessageValue< readonly runTime?: number /** * Reference to main worker. - * - * Only for internal use. */ readonly parent?: MainWorker } @@ -48,6 +44,7 @@ export interface MessageValue< * * @typeParam Worker - Type of worker. * @typeParam Response - Type of execution response. This can only be serializable data. + * @internal */ export interface PromiseResponseWrapper< Worker extends IWorker, @@ -62,7 +59,7 @@ export interface PromiseResponseWrapper< */ readonly reject: (reason?: string) => void /** - * The worker handling the promise. + * The worker handling the execution. */ readonly worker: Worker }