repositories
/
poolifier.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
chore: v2.4.9
[poolifier.git]
/
src
/
utility-types.ts
diff --git
a/src/utility-types.ts
b/src/utility-types.ts
index 9c8d9650b15ccc31007a19d199117860a650ac58..fb0e435a81ac949b0b82740f1b17c1561bd9d762 100644
(file)
--- a/
src/utility-types.ts
+++ b/
src/utility-types.ts
@@
-1,28
+1,26
@@
-import type { Worker } from 'cluster'
-import type { MessagePort } from 'worker_threads'
-import type { IWorker } from './pools/abstract-pool'
+import type { Worker as ClusterWorker } from 'node:cluster'
+import type { MessagePort } from 'node:worker_threads'
import type { KillBehavior } from './worker/worker-options'
import type { KillBehavior } from './worker/worker-options'
+import type { IWorker, Task } from './pools/worker'
/**
* Make all properties in T non-readonly.
/**
* 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] }
/**
*/
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,
*/
export interface MessageValue<
Data = unknown,
- MainWorker extends Worker | MessagePort | unknown = unknown
-> {
- /**
- * Input data that will be passed to the worker.
- */
- readonly data?: Data
- /**
- * Id of the message.
- */
- readonly id?: number
+ MainWorker extends ClusterWorker | MessagePort | unknown = unknown
+> extends Task<Data> {
/**
* Kill code.
*/
/**
* Kill code.
*/
@@
-31,21
+29,24
@@
export interface MessageValue<
* Error.
*/
readonly error?: string
* Error.
*/
readonly error?: string
+ /**
+ * Runtime.
+ */
+ readonly runTime?: number
/**
* Reference to main worker.
/**
* Reference to main worker.
- *
- * _Only for internal use_
*/
readonly parent?: MainWorker
}
/**
*/
readonly parent?: MainWorker
}
/**
- * An object holding the
worker that will be used to resolve/rejects the promise later on
.
+ * An object holding the
execution response promise resolve/reject callbacks
.
*
*
- * @template Worker Type of worker.
- * @template Response Type of response of execution. This can only be serializable data.
+ * @typeParam Worker - Type of worker.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @internal
*/
*/
-export interface Promise
Worker
ResponseWrapper<
+export interface PromiseResponseWrapper<
Worker extends IWorker,
Response = unknown
> {
Worker extends IWorker,
Response = unknown
> {
@@
-58,7
+59,7
@@
export interface PromiseWorkerResponseWrapper<
*/
readonly reject: (reason?: string) => void
/**
*/
readonly reject: (reason?: string) => void
/**
- * The worker
that has the assigned task
.
+ * The worker
handling the execution
.
*/
readonly worker: Worker
}
*/
readonly worker: Worker
}