X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=e1fb311e45b4eb8ed0e5d33cda3b3806d7526f5b;hb=6c20f667c669ee5a1f9f041d52ac6c1570a84c06;hp=980c00896a0ebf23f75162605cccf52548cc535f;hpb=75d3401a50550a9fc53e2e7d107bc2d776df83e3;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 980c0089..e1fb311e 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,6 +1,6 @@ import type { EventLoopUtilization } from 'node:perf_hooks' +import type { MessagePort, TransferListItem } from 'node:worker_threads' import type { KillBehavior } from './worker/worker-options' -import type { IWorker, Task } from './pools/worker' /** * Task error. @@ -9,15 +9,15 @@ import type { IWorker, Task } from './pools/worker' */ export interface TaskError { /** - * Worker id. + * Task name triggering the error. */ - readonly workerId: number + readonly name: string /** * Error message. */ readonly message: string /** - * Data passed to the worker triggering the error. + * Data triggering the error. */ readonly data?: Data } @@ -28,6 +28,10 @@ export interface TaskError { * @internal */ export interface TaskPerformance { + /** + * Task name. + */ + readonly name: string /** * Task performance timestamp. */ @@ -43,13 +47,52 @@ export interface TaskPerformance { } /** - * Performance statistics computation. + * Worker task performance statistics computation settings. * * @internal */ export interface WorkerStatistics { - runTime: boolean - elu: boolean + /** + * Whether the worker computes the task runtime or not. + */ + readonly runTime: boolean + /** + * Whether the worker computes the task event loop utilization (ELU) or not. + */ + readonly 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 + /** + * Array of transferable objects. + */ + readonly transferList?: TransferListItem[] + /** + * Timestamp. + */ + readonly timestamp?: number + /** + * Task UUID. + */ + readonly taskId?: string } /** @@ -61,14 +104,10 @@ export interface WorkerStatistics { */ export interface MessageValue extends Task { - /** - * Worker id. - */ - readonly workerId?: number /** * Kill code. */ - readonly kill?: KillBehavior | 1 + readonly kill?: KillBehavior | true | 'success' | 'failure' /** * Task error. */ @@ -77,41 +116,47 @@ export interface MessageValue * Task performance. */ readonly taskPerformance?: TaskPerformance + /** + * Task function names. + */ + readonly taskFunctions?: string[] /** * Whether the worker computes the given statistics or not. */ readonly statistics?: WorkerStatistics /** - * Whether the worker has started or not. + * Whether the worker is ready or not. + */ + readonly ready?: boolean + /** + * Whether the worker starts or stops its activity check. */ - readonly started?: boolean + readonly checkActive?: boolean /** - * Whether the worker is dynamic or not. + * Message port. */ - readonly dynamic?: boolean + readonly port?: MessagePort } /** - * An object holding the execution response promise resolve/reject callbacks. + * An object holding the task execution response promise resolve/reject callbacks. * - * @typeParam Worker - Type of worker. * @typeParam Response - Type of execution response. This can only be structured-cloneable data. * @internal */ -export interface PromiseResponseWrapper< - Worker extends IWorker, - Response = unknown -> { +export interface PromiseResponseWrapper { /** * Resolve callback to fulfill the promise. */ - readonly resolve: (value: Response) => void + readonly resolve: (value: Response | PromiseLike) => void /** * Reject callback to reject the promise. */ - readonly reject: (reason?: string) => void + readonly reject: (reason?: unknown) => void /** - * The worker handling the execution. + * The worker node key executing the task. */ - readonly worker: Worker + readonly workerNodeKey: number } + +export type Writable = { -readonly [P in keyof T]: T[P] }