81a57698f5fa6a7dc5e631cbdec844ee68c44c2c
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 * @typeParam T - Type in which properties will be non-readonly.
11 export type Draft
<T
> = { -readonly [P
in keyof T
]?: T
[P
] }
14 * Message object that is passed between main worker and worker.
16 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
17 * @typeParam MainWorker - Type of main worker.
20 export interface MessageValue
<
22 MainWorker
extends ClusterWorker
| MessagePort
| unknown
= unknown
23 > extends Task
<Data
> {
27 readonly kill
?: KillBehavior
| 1
31 readonly error
?: string
35 readonly runTime
?: number
37 * Reference to main worker.
39 readonly parent?: MainWorker
43 * Worker function that can be executed types.
45 export type WorkerSyncFunction
<Data
= unknown
, Response
= unknown
> = (
48 export type WorkerAsyncFunction
<Data
= unknown
, Response
= unknown
> = (
50 ) => Promise
<Response
>
51 export type WorkerFunction
<Data
= unknown
, Response
= unknown
> =
52 | WorkerSyncFunction
<Data
, Response
>
53 | WorkerAsyncFunction
<Data
, Response
>
56 * An object holding the execution response promise resolve/reject callbacks.
58 * @typeParam Worker - Type of worker.
59 * @typeParam Response - Type of execution response. This can only be serializable data.
62 export interface PromiseResponseWrapper
<
63 Worker
extends IWorker
,
67 * Resolve callback to fulfill the promise.
69 readonly resolve
: (value
: Response
) => void
71 * Reject callback to reject the promise.
73 readonly reject
: (reason
?: string) => void
75 * The worker handling the execution.
77 readonly worker
: Worker