X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FMessageValue.html;h=75a248da7e38e4aad2b2bc8c6237e7513c6aa2a8;hb=6df7fd58278efabaca36bc515ba038ebcae807ec;hp=07a2c31228ba45c3e373f6a9aec9aa2882169596;hpb=5a8cac091245f45e5cf4e919d4defcbab916f783;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 07a2c312..75a248da 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.19Interface 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 (view full)
Index
Properties
Hierarchy (view full)
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