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.
* @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
*/
export interface TaskError<Data = unknown> {
+ /**
+ * 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<Data = unknown> {
+ /**
+ * 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.
*
*/
export interface MessageValue<Data = unknown, ErrorData = unknown>
extends Task<Data> {
- /**
- * Worker id.
- */
- readonly workerId?: number
/**
* Kill code.
*/
- readonly kill?: KillBehavior | 1
+ readonly kill?: KillBehavior | true
/**
* Task error.
*/
*/
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 aliveness check.
*/
- readonly started?: boolean
+ readonly checkAlive?: boolean
}
/**