X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=e1fb311e45b4eb8ed0e5d33cda3b3806d7526f5b;hb=b6fea09e6a8174e664770741943cf08445066e2b;hp=fa1c0ffefdf27e6996789cc444f44d81de9076fc;hpb=ff128cc9dc9cee365f55b15721d5b90707577a0a;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index fa1c0ffe..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. @@ -47,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 } /** @@ -68,7 +107,7 @@ export interface MessageValue /** * Kill code. */ - readonly kill?: KillBehavior | true + readonly kill?: KillBehavior | true | 'success' | 'failure' /** * Task error. */ @@ -77,6 +116,10 @@ export interface MessageValue * Task performance. */ readonly taskPerformance?: TaskPerformance + /** + * Task function names. + */ + readonly taskFunctions?: string[] /** * Whether the worker computes the given statistics or not. */ @@ -86,32 +129,34 @@ export interface MessageValue */ readonly ready?: boolean /** - * Whether the worker starts or stops its aliveness check. + * Whether the worker starts or stops its activity check. */ - readonly checkAlive?: boolean + readonly checkActive?: boolean + /** + * Message port. + */ + 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] }