X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=28bf19e256abaef2f619051773ad55456643b842;hb=85003dff831b309b12d624215a8d67634af82b50;hp=f330d192296dcc62a5b86a4209126d21798acff6;hpb=6677a3d36e9e7241c54db7cd69daa40f52fcbcb3;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index f330d192..28bf19e2 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,6 +1,6 @@ import type { EventLoopUtilization } from 'node:perf_hooks' import type { KillBehavior } from './worker/worker-options' -import type { IWorker, Task } from './pools/worker' +import type { IWorker } from './pools/worker' /** * Task error. @@ -8,42 +8,83 @@ 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 elu: boolean } +/** + * Message object that is passed as a task between main worker and worker. + * + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. + * @internal + */ +export interface Task { + /** + * Worker id. + */ + readonly workerId: number + /** + * Task name. + */ + readonly name?: string + /** + * Task input data that will be passed to the worker. + */ + readonly data?: Data + /** + * Timestamp. + */ + readonly timestamp?: number + /** + * Message UUID. + */ + readonly id?: string +} + /** * Message object that is passed between main worker and worker. * @@ -56,7 +97,7 @@ export interface MessageValue /** * Kill code. */ - readonly kill?: KillBehavior | 1 + readonly kill?: KillBehavior | true /** * Task error. */ @@ -66,9 +107,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 is ready or not. + */ + readonly ready?: boolean + /** + * Whether the worker starts or stops its aliveness check. + */ + readonly checkAlive?: boolean } /**