1 import type { Worker
as ClusterWorker
} from
'node:cluster'
2 import type { MessagePort
} from
'node:worker_threads'
3 import type { KillBehavior
} from
'./worker/worker-options'
4 import type { IWorker
, Task
} from
'./pools/worker'
7 * Make all properties in T non-readonly.
9 export type Draft
<T
> = { -readonly [P
in keyof T
]?: T
[P
] }
12 * Message object that is passed between main worker and worker.
14 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
15 * @typeParam MainWorker - Type of main worker.
17 export interface MessageValue
<
19 MainWorker
extends ClusterWorker
| MessagePort
| unknown
= unknown
20 > extends Task
<Data
> {
24 readonly kill
?: KillBehavior
| 1
28 readonly error
?: string
32 readonly runTime
?: number
34 * Reference to main worker.
36 * Only for internal use.
39 readonly parent?: MainWorker
43 * An object holding the execution response promise resolve/reject callbacks.
45 * @typeParam Worker - Type of worker.
46 * @typeParam Response - Type of execution response. This can only be serializable data.
49 export interface PromiseResponseWrapper
<
50 Worker
extends IWorker
,
54 * Resolve callback to fulfill the promise.
56 readonly resolve
: (value
: Response
) => void
58 * Reject callback to reject the promise.
60 readonly reject
: (reason
?: string) => void
62 * The worker handling the execution.
64 readonly worker
: Worker