X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=928e57b09931d2872100dd6e3517bd1779cfa359;hb=2ad9905df3e945c219006b32a48962b4af04d2cc;hp=dc75cc4ee56b70b959f1756871f88c590ff1e781;hpb=a3294554408b42a4df2e37eb69f9c8a554a0c2f3;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index dc75cc4e..928e57b0 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,7 +1,7 @@ -
Internal
Generated using TypeDoc
Message object that is passed between main worker and worker.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.8Interface MessageValue<Data, ErrorData>
Internal
Message object that is passed between main worker and worker.
    checkActive?: boolean;
    data?: Data;
    kill?: true | "success" | "SOFT" | "HARD" | "failure";
    name?: string;
    port?: MessagePort;
    ready?: boolean;
    statistics?: WorkerStatistics;
    taskFunction?: string;
    taskFunctionName?: string;
    taskFunctionNames?: string[];
    taskFunctionOperation?: "add" | "default" | "remove";
    taskFunctionOperationStatus?: boolean;
    taskId?: string;
    taskPerformance?: TaskPerformance;
    timestamp?: number;
    transferList?: TransferListItem[];
    workerError?: WorkerError<ErrorData>;
    workerId?: number;
}
Type Parameters
Data = unknown
Type of data sent to the worker or execution response. This can only be structured-cloneable data.
ErrorData = unknown
Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
-Hierarchy
Index
Properties
Hierarchy
Index
Properties
Properties
Optional
Readonly
checkWhether the worker starts or stops its activity check.
-Optional
Readonly
dataTask input data that will be passed to the worker.
-Optional
Readonly
killKill code.
-Optional
Readonly
nameTask name.
-Optional
Readonly
portMessage port.
-Optional
Readonly
readyWhether the worker is ready or not.
-Optional
Readonly
statisticsWhether the worker computes the given statistics or not.
-Optional
Readonly
taskTask function serialized to string.
-Optional
Readonly
taskTask function name.
-Optional
Readonly
taskTask function names.
-Optional
Readonly
taskTask function operation:
+Optional
Readonly
dataTask input data that will be passed to the worker.
+Optional
Readonly
killKill code.
+Optional
Readonly
nameTask name.
+Optional
Readonly
portMessage port.
+Optional
Readonly
readyWhether the worker is ready or not.
+Optional
Readonly
statisticsWhether the worker computes the given statistics or not.
+Optional
Readonly
taskTask function serialized to string.
+Optional
Readonly
taskTask function name.
+Optional
Readonly
taskTask function names.
+Optional
Readonly
taskTask function operation:
'add'
- Add a task function.'remove'
- Remove a task function.'default'
- Set a task function as default.Optional
Readonly
taskWhether the task function operation is successful or not.
-Optional
Readonly
taskTask UUID.
-Optional
Readonly
taskTask performance.
-Optional
Readonly
timestampTimestamp.
-Optional
Readonly
transferArray of transferable objects.
-Optional
Readonly
workerWorker error.
-Optional
Readonly
workerWorker id.
-Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc
Optional
Readonly
taskWhether the task function operation is successful or not.
+Optional
Readonly
taskTask UUID.
+Optional
Readonly
taskTask performance.
+Optional
Readonly
timestampTimestamp.
+Optional
Readonly
transferArray of transferable objects.
+Optional
Readonly
workerWorker error.
+Optional
Readonly
workerWorker id.
+Settings
Member Visibility
Theme
On This Page