X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FMessageValue.html;h=5f1337569a56c991b234fa6a03082e44586d5d56;hb=feec6e8c04165c3c70a12c9a1c5e64a32b40311c;hp=96fde0555946779c728e87649fb761eb4c0a23e7;hpb=e4b9c7f546318de7603566b141fd0e2d0118c794;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 96fde055..5f133756 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 = ClusterWorker | MessagePort
+Type of main worker.
+Hierarchy
-- MessageValue
@@ -38,58 +44,68 @@
data?
-error?
-id?
-kill?
-parent?
-run Time?
+data?
+error?
+id?
+kill?
+name?
+parent?
+run Time?
+
data?: Data
-data?: Data
+
+
-
+Defined in src/pools/worker.ts:47
+
error?: string
+error?: string
-
+Defined in src/utility-types.ts:31
+
id?: string
-id?: string
+
+
-
+Defined in src/pools/worker.ts:51
+
kill?: 1 | "SOFT" | "HARD"
+kill?: 1 | "SOFT" | "HARD"
-
-parent?: MainWorker
+Defined in src/utility-types.ts:27
+
+name?: string
+
+
+
+parent?: MainWorker
-
+Defined in src/utility-types.ts:39
+
run Time?: number
+run Time?: number
+Defined in src/utility-types.ts:35
@@ -104,52 +120,64 @@
-
+
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.
+Message UUID.
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
nameTask name.
+Inherited from Task.name
++- Defined in src/pools/worker.ts:43
+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