X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FTask.html;h=d3ffcd70e2289d96ded814f40e273a83a2e9320b;hb=a8aeac440fb425585a0d597af86f616e648ae156;hp=db50344064bbb7aa09eab88f3847c2549c1a5c11;hpb=e7339cfd46bfe4600187ae2c6bd6c9e7f63e7052;p=poolifier.git diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index db503440..d3ffcd70 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -14,21 +14,25 @@
-Internal
Worker task interface.
+Message object that is passed as a task between main worker and worker.
Type Parameters
Data = unknown
Data = unknown
+Type of data sent to the worker. This can only be serializable data.
+Hierarchy
-- Task
@@ -36,25 +40,25 @@
data
-id
+data?
+id?
-data: Data
-data?: Data
+
+Defined in src/pools/worker.ts:42
-id: string
-id?: string
+
+Defined in src/pools/worker.ts:46
@@ -82,6 +86,7 @@
Pool Type
Abstract Pool
Abstract Worker
+Circular Array
Cluster Worker
Dynamic Cluster Pool
Dynamic Thread Pool
Properties
-Properties
data
-Worker task data.
+
+Optional
Readonly
dataInput data that will be passed to the worker.
-- Defined in src/pools/worker.ts:39
id
-Task UUID.
+
+Optional
Readonly
idUUID of the message.
-- Defined in src/pools/worker.ts:43