X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=2035235022d13f49cb39c98e3ea10b91cf7ca8ec;hb=48487131ad37630e3021c3e4feee1b311d8bcd11;hp=f330d192296dcc62a5b86a4209126d21798acff6;hpb=6677a3d36e9e7241c54db7cd69daa40f52fcbcb3;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index f330d192..20352350 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -8,36 +8,44 @@ 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 { + /** + * 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 + readonly runTime?: number /** * Task event loop utilization. */ - elu?: EventLoopUtilization + readonly elu?: EventLoopUtilization } /** * Performance statistics computation. + * + * @internal */ export interface WorkerStatistics { runTime: boolean @@ -53,10 +61,14 @@ export interface WorkerStatistics { */ export interface MessageValue extends Task { + /** + * Worker id. + */ + readonly workerId?: number /** * Kill code. */ - readonly kill?: KillBehavior | 1 + readonly kill?: KillBehavior | true /** * Task error. */ @@ -66,9 +78,17 @@ export interface MessageValue */ readonly taskPerformance?: TaskPerformance /** - * Whether to compute the given statistics or not. + * Whether the worker computes the given statistics or not. */ readonly statistics?: WorkerStatistics + /** + * Whether the worker has started or not. + */ + readonly started?: boolean + /** + * Whether the worker starts or stops its aliveness check. + */ + readonly checkAlive?: boolean } /**