+import type { AsyncResource } from 'node:async_hooks'
import type { EventLoopUtilization } from 'node:perf_hooks'
-import type { KillBehavior } from './worker/worker-options'
-import type { IWorker } from './pools/worker'
+import type { MessagePort, TransferListItem } from 'node:worker_threads'
+
+import type { KillBehavior } from './worker/worker-options.js'
/**
- * Task error.
+ * Worker error.
*
* @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
*/
-export interface TaskError<Data = unknown> {
+export interface WorkerError<Data = unknown> {
/**
- * Task name triggering the error.
+ * Task function name triggering the error.
*/
readonly name: string
/**
}
/**
- * 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
}
/**
* @internal
*/
export interface Task<Data = unknown> {
- /**
- * Worker id.
- */
- readonly workerId: number
/**
* Task name.
*/
* Task input data that will be passed to the worker.
*/
readonly data?: Data
+ /**
+ * Array of transferable objects.
+ */
+ readonly transferList?: TransferListItem[]
/**
* Timestamp.
*/
readonly timestamp?: number
/**
- * Message UUID.
+ * Task UUID.
*/
- readonly id?: string
+ readonly taskId?: string
}
/**
*/
export interface MessageValue<Data = unknown, ErrorData = unknown>
extends Task<Data> {
+ /**
+ * Worker id.
+ */
+ readonly workerId?: number
/**
* Kill code.
*/
- readonly kill?: KillBehavior | true
+ readonly kill?: KillBehavior | true | 'success' | 'failure'
/**
- * Task error.
+ * Worker error.
*/
- readonly taskError?: TaskError<ErrorData>
+ readonly workerError?: WorkerError<ErrorData>
/**
* Task performance.
*/
readonly taskPerformance?: TaskPerformance
+ /**
+ * Task function operation:
+ * - `'add'` - Add a task function.
+ * - `'remove'` - Remove a task function.
+ * - `'default'` - Set a task function as default.
+ */
+ readonly taskFunctionOperation?: 'add' | 'remove' | 'default'
+ /**
+ * Whether the task function operation is successful or not.
+ */
+ readonly taskFunctionOperationStatus?: boolean
+ /**
+ * Task function serialized to string.
+ */
+ readonly taskFunction?: string
+ /**
+ * Task function name.
+ */
+ readonly taskFunctionName?: string
+ /**
+ * Task function names.
+ */
+ readonly taskFunctionNames?: string[]
/**
* Whether the worker computes the given statistics or not.
*/
*/
readonly ready?: boolean
/**
- * Whether the worker starts or stops its aliveness check.
+ * Whether the worker starts or stops its activity check.
+ */
+ readonly checkActive?: boolean
+ /**
+ * Message port.
*/
- readonly checkAlive?: 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<Response = unknown> {
/**
* Resolve callback to fulfill the promise.
*/
- readonly resolve: (value: Response) => void
+ readonly resolve: (value: Response | PromiseLike<Response>) => 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
+ /**
+ * The asynchronous resource used to track the task execution.
+ */
+ readonly asyncResource?: AsyncResource
}
+
+export type Writable<T> = { -readonly [P in keyof T]: T[P] }