X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=f956654685be2c673006fe2356605d41b252f829;hb=a99f06d1fff8949584cd630bfaa3fa2e3cc3897e;hp=f872d6e696bd3d8386c95d317369b5029c91e467;hpb=cf4c4b77d31b88b45c9f876f6fab553e66000f4d;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index f872d6e6..f9566546 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,7 +1,7 @@ -MessageValue | poolifier - v3.1.22

Interface MessageValue<Data, ErrorData>Internal

Message object that is passed between main worker and worker.

+MessageValue | poolifier - v3.1.27

Interface MessageValue<Data, ErrorData>Internal

Message object that is passed between main worker and worker.

interface MessageValue<Data, ErrorData> {
    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)

Properties

Hierarchy (view full)

Properties

Properties

checkActive?: boolean

Whether the worker starts or stops its activity check.

-
data?: Data

Task input data that will be passed to the worker.

-
kill?: true | "success" | "SOFT" | "HARD" | "failure"

Kill code.

-
name?: string

Task name.

-
port?: MessagePort

Message port.

-
ready?: boolean

Whether the worker is ready or not.

-
statistics?: WorkerStatistics

Whether the worker computes the given statistics or not.

-
taskFunction?: string

Task function serialized to string.

-
taskFunctionName?: string

Task function name.

-
taskFunctionNames?: string[]

Task function names.

-
taskFunctionOperation?: "add" | "default" | "remove"

Task function operation:

+
data?: Data

Task input data that will be passed to the worker.

+
kill?: true | "success" | "SOFT" | "HARD" | "failure"

Kill code.

+
name?: string

Task name.

+
port?: MessagePort

Message port.

+
ready?: boolean

Whether the worker is ready or not.

+
statistics?: WorkerStatistics

Whether the worker computes the given statistics or not.

+
taskFunction?: string

Task function serialized to string.

+
taskFunctionName?: string

Task function name.

+
taskFunctionNames?: string[]

Task function names.

+
taskFunctionOperation?: "add" | "default" | "remove"

Task function operation:

  • 'add' - Add a task function.
  • 'remove' - Remove a task function.
  • 'default' - Set a task function as default.
-
taskFunctionOperationStatus?: boolean

Whether the task function operation is successful or not.

-
taskId?: string

Task UUID.

-
taskPerformance?: TaskPerformance

Task performance.

-
timestamp?: number

Timestamp.

-
transferList?: TransferListItem[]

Array of transferable objects.

-
workerError?: WorkerError<ErrorData>

Worker error.

-
workerId?: number

Worker id.

-

Generated using TypeDoc

\ No newline at end of file +
taskFunctionOperationStatus?: boolean

Whether the task function operation is successful or not.

+
taskId?: string

Task UUID.

+
taskPerformance?: TaskPerformance

Task performance.

+
timestamp?: number

Timestamp.

+
transferList?: TransferListItem[]

Array of transferable objects.

+
workerError?: WorkerError<ErrorData>

Worker error.

+
workerId?: number

Worker id.

+

Generated using TypeDoc

\ No newline at end of file