import type { Worker as ClusterWorker } from 'node:cluster'
import type { MessagePort } from 'node:worker_threads'
import type { KillBehavior } from './worker/worker-options'
+import type { IWorker, Task } from './pools/worker'
/**
* Make all properties in T non-readonly.
+ *
+ * @typeParam T - Type in which properties will be non-readonly.
*/
export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
/**
- * Message object that is passed between worker and main worker.
+ * Message object that is passed between main worker and worker.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam MainWorker - Type of main worker.
+ * @internal
*/
export interface MessageValue<
Data = unknown,
MainWorker extends ClusterWorker | MessagePort | unknown = unknown
-> {
- /**
- * Input data that will be passed to the worker.
- */
- readonly data?: Data
- /**
- * Id of the message.
- */
- readonly id?: string
+> extends Task<Data> {
/**
* Kill code.
*/
*/
readonly error?: string
/**
- * Task runtime.
+ * Runtime.
*/
- readonly taskRunTime?: number
+ readonly runTime?: number
/**
* Reference to main worker.
- *
- * Only for internal use.
*/
readonly parent?: MainWorker
}
+/**
+ * Worker synchronous function that can be executed.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ */
+export type WorkerSyncFunction<Data = unknown, Response = unknown> = (
+ data?: Data
+) => Response
+/**
+ * Worker asynchronous function that can be executed.
+ * This function must return a promise.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ */
+export type WorkerAsyncFunction<Data = unknown, Response = unknown> = (
+ data?: Data
+) => Promise<Response>
+/**
+ * Worker function that can be executed.
+ * This function can be synchronous or asynchronous.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ */
+export type WorkerFunction<Data = unknown, Response = unknown> =
+ | WorkerSyncFunction<Data, Response>
+ | WorkerAsyncFunction<Data, Response>
+
/**
* An object holding the execution response promise resolve/reject callbacks.
*
+ * @typeParam Worker - Type of worker.
* @typeParam Response - Type of execution response. This can only be serializable data.
+ * @internal
*/
-export interface PromiseResponseWrapper<Response = unknown> {
+export interface PromiseResponseWrapper<
+ Worker extends IWorker,
+ Response = unknown
+> {
/**
* Resolve callback to fulfill the promise.
*/
*/
readonly reject: (reason?: string) => void
/**
- * The worker handling the promise key .
+ * The worker handling the execution.
*/
- readonly workerKey: number
+ readonly worker: Worker
}