X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Futility-types.ts;h=fa1c0ffefdf27e6996789cc444f44d81de9076fc;hb=3e406edee2c758263a2e8d8bbbaaeff951a3db7a;hp=da2fa22300c58c99998a637c31f531dba8c982c0;hpb=e102732c0e3966b81834b2c0bdd087eb051162ad;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index da2fa223..fa1c0ffe 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -8,36 +8,48 @@ import type { IWorker, Task } from './pools/worker' * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data. */ export interface TaskError { + /** + * Task name triggering the error. + */ + readonly name: string /** * Error message. */ - message: string + readonly message: string /** - * Data passed to the worker triggering the error. + * Data triggering the error. */ - data?: Data + readonly data?: Data } /** * Task performance. + * + * @internal */ export interface TaskPerformance { + /** + * Task name. + */ + readonly name: string /** * Task performance timestamp. */ - timestamp: number + readonly timestamp: number /** * Task runtime. */ - runTime?: number + readonly runTime?: number /** * Task event loop utilization. */ - elu?: EventLoopUtilization + readonly elu?: EventLoopUtilization } /** * Performance statistics computation. + * + * @internal */ export interface WorkerStatistics { runTime: boolean @@ -49,18 +61,14 @@ export interface WorkerStatistics { * * @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. - * @typeParam MainWorker - Type of main worker. * @internal */ -export interface MessageValue< - Data = unknown, - ErrorData = unknown, - MainWorker = NodeJS.Process | MessagePort -> extends Task { +export interface MessageValue + extends Task { /** * Kill code. */ - readonly kill?: KillBehavior | 1 + readonly kill?: KillBehavior | true /** * Task error. */ @@ -70,13 +78,17 @@ export interface MessageValue< */ readonly taskPerformance?: TaskPerformance /** - * Reference to main worker. + * Whether the worker computes the given statistics or not. + */ + readonly statistics?: WorkerStatistics + /** + * Whether the worker is ready or not. */ - readonly parent?: MainWorker + readonly ready?: boolean /** - * Whether to compute the given statistics or not. + * Whether the worker starts or stops its aliveness check. */ - readonly statistics?: WorkerStatistics + readonly checkAlive?: boolean } /**