X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=685e5c4c606755bf801dd6c13d582d3657f8fe8e;hb=12ae3210477b0c54380db24470ff3b0e78926bd8;hp=1a660434f07dee07dd300b0f3473a33b529af045;hpb=fc3e65861bc1939ae047ee1e8e91a1ce577035f4;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 1a660434..685e5c4c 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,7 +1,7 @@ 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' +import type { IWorker } from './pools/worker' /** * Make all properties in T non-readonly. @@ -10,6 +10,9 @@ export type Draft = { -readonly [P in keyof T]?: T[P] } /** * 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, @@ -32,25 +35,27 @@ 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 } /** - * An object holding the worker that will be used to resolve/rejects the promise later on. + * An object holding the execution response promise resolve/reject callbacks. * * @typeParam Worker - Type of worker. - * @typeParam Response - Type of response of execution. This can only be serializable data. + * @typeParam Response - Type of execution response. This can only be serializable data. + * @internal */ -export interface PromiseWorkerResponseWrapper< - Worker extends IPoolWorker, +export interface PromiseResponseWrapper< + Worker extends IWorker, Response = unknown > { /** @@ -62,7 +67,7 @@ export interface PromiseWorkerResponseWrapper< */ readonly reject: (reason?: string) => void /** - * The worker that has the assigned task. + * The worker handling the execution. */ readonly worker: Worker }