X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FMessageValue.html;h=e095fb5e6ed5550e7a59e07f11c41edc5f5ca5a5;hb=4d8bf9e40e07bd233be4494fda4e4270fdd8a355;hp=a214542b1a9252d3843fa6331368f907020e0ecf;hpb=d49303bcd1dc86f36030dff08796f869681d4eae;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index a214542b..e095fb5e 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -
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?
-error?
-id?
-kill?
-parent?
-run Time?
+data?
+error?
+id?
+kill?
+parent?
+run Time?
+
data?: Data
-data?: Data
+
+
-
+Defined in src/pools/worker.ts:42
+
error?: string
+error?: string
-
+Defined in src/utility-types.ts:31
+
id?: string
-id?: string
+
+
-
+Defined in src/pools/worker.ts:46
+
kill?: 1 | "SOFT" | "HARD"
+kill?: 1 | "SOFT" | "HARD"
-
-parent?: MainWorker
+Defined in src/utility-types.ts:27
+
+parent?: MainWorker
-
+Defined in src/utility-types.ts:39
+
run Time?: number
+run Time?: number
+Defined in src/utility-types.ts:35
@@ -104,57 +111,61 @@
-
+
Properties
-Properties
-
-Optional
Readonly
dataInput data that will be passed to the worker.
+Task input 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
parent
+Optional
Readonly
parentReference to main worker.
-Only for internal use.
-- Defined in src/utility-types.ts:44
Time
-Optional
Readonly
runRuntime.
-- Defined in src/utility-types.ts:37
Theme
Theme
On This Page
-- data
-- error
-- id
-- kill
-- parent
-- run
Time
Generated using TypeDoc