X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FMessageValue.html;h=31b45ff6a249386c4e395eda5751a964aaa6e514;hb=53221c4e8cbcc585c670275e7c1c700c3d1b5f37;hp=a214542b1a9252d3843fa6331368f907020e0ecf;hpb=e7339cfd46bfe4600187ae2c6bd6c9e7f63e7052;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index a214542b..31b45ff6 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -14,23 +14,29 @@
-Internal
Message object that is passed between worker and main worker.
+Message object that is passed between main worker and worker.
Type Parameters
Data = unknown
Data = unknown
+Type of data sent to the worker. This can only be serializable data.
+MainWorker extends ClusterWorker | MessagePort | unknown = unknown
MainWorker extends ClusterWorker | MessagePort | unknown = unknown
+Type of main worker.
+Hierarchy
-- MessageValue
@@ -38,58 +44,59 @@
data?
+data?
error?
-id?
+id?
kill?
parent?
run Time?
+
data?: Data
+
+Defined in src/pools/worker.ts:42
error?: string
-
+Defined in src/utility-types.ts:31
+
id?: string
-
+
+Defined in src/pools/worker.ts:46
kill?: 1 | "SOFT" | "HARD"
+Defined in src/utility-types.ts:27
-
parent?: MainWorker
+Defined in src/utility-types.ts:39
Time
run Time?: number
+Defined in src/utility-types.ts:35
@@ -109,9 +116,9 @@
@@ -121,6 +128,7 @@
Pool Type
Abstract Pool
Abstract Worker
+Circular Array
Cluster Worker
Dynamic Cluster Pool
Dynamic Thread Pool
Properties
-Properties
-Optional
Readonly
dataInput data that will be passed to the worker.
Inherited from Task.data
-- Defined in src/utility-types.ts:21
Optional
Readonly
errorError.
-- Defined in src/utility-types.ts:33
Optional
Readonly
idId of the message.
+UUID of the message.
Inherited from Task.id
-- Defined in src/utility-types.ts:25
Optional
Readonly
killKill code.
-- Defined in src/utility-types.ts:29
+Optional
Readonly
Internal
parentOptional
Readonly
parentReference to main worker.
-Only for internal use.
-- Defined in src/utility-types.ts:44
Optional
Readonly
runRuntime.
-- Defined in src/utility-types.ts:37
On This Page
-- data
+- data
- error
-- id
+- id
- kill
- parent
- run
Time