repositories
/
poolifier.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
docs: enhance documentation
[poolifier.git]
/
src
/
pools
/
worker.ts
diff --git
a/src/pools/worker.ts
b/src/pools/worker.ts
index 1e23ee872aa0b9f1a5ae97d48c2a8c87b06e6567..3bb0ac9d66ef550f254b8535d3fd23d4f369a4f6 100644
(file)
--- a/
src/pools/worker.ts
+++ b/
src/pools/worker.ts
@@
-31,9
+31,18
@@
export type ExitHandler<Worker extends IWorker> = (
/**
* Worker task interface.
/**
* Worker task interface.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @internal
*/
export interface Task<Data = unknown> {
*/
export interface Task<Data = unknown> {
+ /**
+ * Worker task data.
+ */
data: Data
data: Data
+ /**
+ * Task UUID.
+ */
id: string
}
id: string
}
@@
-75,9
+84,22
@@
export interface IWorker {
/**
* Worker node interface.
/**
* Worker node interface.
+ *
+ * @typeParam Worker - Type of worker.
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @internal
*/
export interface WorkerNode<Worker extends IWorker, Data = unknown> {
*/
export interface WorkerNode<Worker extends IWorker, Data = unknown> {
+ /**
+ * Worker node worker.
+ */
worker: Worker
worker: Worker
+ /**
+ * Worker node tasks usage statistics.
+ */
tasksUsage: TasksUsage
tasksUsage: TasksUsage
+ /**
+ * Worker node tasks queue.
+ */
tasksQueue: Array<Task<Data>>
}
tasksQueue: Array<Task<Data>>
}