X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=f1b773eb31196c5ca827759bbbf3f70a37fc1ae9;hb=7c8381eb33aaff689afe1944d8643508003cf0b1;hp=57ff000330e29cc7dffb3541a65438c3edf65b80;hpb=4f487526a63c873d168386250b40ad8103c5a4d8;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 57ff0003..f1b773eb 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,103 +1,101 @@ -import type { Worker as ClusterWorker } from 'node:cluster' -import type { MessagePort } from 'node:worker_threads' import type { EventLoopUtilization } from 'node:perf_hooks' import type { KillBehavior } from './worker/worker-options' 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] } - /** * Task error. * - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data. */ export interface TaskError { + /** + * Worker id. + */ + readonly workerId: number /** * Error message. */ - message: string + readonly message: string /** * Data passed to the worker triggering the error. */ - data?: Data + readonly data?: Data } /** * Task performance. + * + * @internal */ export interface TaskPerformance { /** * Task performance timestamp. */ - timestamp: number + readonly timestamp: number /** * Task runtime. */ - runTime?: number - /** - * Task wait time. - */ - waitTime?: number + readonly runTime?: number /** * Task event loop utilization. */ - elu?: EventLoopUtilization + readonly elu?: EventLoopUtilization } /** * Performance statistics computation. + * + * @internal */ export interface WorkerStatistics { runTime: boolean - waitTime: boolean elu: boolean } /** * Message object that is passed between main worker and worker. * - * @typeParam MessageData - Type of data sent to and/or from the worker. This can only be serializable data. - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. - * @typeParam MainWorker - Type of main worker. + * @typeParam Data - Type of data sent to the worker or execution response. This can only be structured-cloneable data. + * @typeParam ErrorData - Type of data sent to the worker triggering an error. This can only be structured-cloneable data. * @internal */ -export interface MessageValue< - MessageData = unknown, - Data = unknown, - MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort -> extends Task { +export interface MessageValue + extends Task { + /** + * Worker id. + */ + readonly workerId?: number /** * Kill code. */ - readonly kill?: KillBehavior | 1 + readonly kill?: KillBehavior | true /** * Task error. */ - readonly taskError?: TaskError + readonly taskError?: TaskError /** * Task performance. */ readonly taskPerformance?: TaskPerformance /** - * Reference to main worker. + * Whether the worker computes the given statistics or not. */ - readonly parent?: MainWorker + readonly statistics?: WorkerStatistics /** - * Whether to compute the given statistics or not. + * Whether the worker is ready or not. */ - readonly statistics?: WorkerStatistics + readonly ready?: boolean + /** + * Whether the worker starts or stops its aliveness check. + */ + readonly checkAlive?: boolean } /** * 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. + * @typeParam Response - Type of execution response. This can only be structured-cloneable data. * @internal */ export interface PromiseResponseWrapper<