X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;fp=docs%2Finterfaces%2FMessageValue.html;h=486bad9010ad94410ae599e2c7300d86a1608197;hb=772b5f23dd379211a734346981ac26651c9d6802;hp=374f5527ef3e3d6eab5659aeaee2676963fe81be;hpb=48eab5902faccd2b14649e0fe4477778ec70ba96;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 374f5527..486bad90 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,7 +1,7 @@ -MessageValue | poolifier - v3.1.29

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

Hierarchy (view full)

Properties

checkActive? data? kill? name? @@ -20,26 +20,26 @@ workerError? workerId?

Properties

Optional Readonly checkActive

checkActive?: boolean

Whether the worker starts or stops its activity check.

-

Optional Readonly data

data?: Data

Task input data that will be passed to the worker.

-

Optional Readonly kill

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

Kill code.

-

Optional Readonly name

name?: string

Task name.

-

Optional Readonly port

port?: MessagePort

Message port.

-

Optional Readonly ready

ready?: boolean

Whether the worker is ready or not.

-

Optional Readonly statistics

statistics?: WorkerStatistics

Whether the worker computes the given statistics or not.

-

Optional Readonly taskFunction

taskFunction?: string

Task function serialized to string.

-

Optional Readonly taskFunctionName

taskFunctionName?: string

Task function name.

-

Optional Readonly taskFunctionNames

taskFunctionNames?: string[]

Task function names.

-

Optional Readonly taskFunctionOperation

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

Task function operation:

+

Optional Readonly data

data?: Data

Task input data that will be passed to the worker.

+

Optional Readonly kill

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

Kill code.

+

Optional Readonly name

name?: string

Task name.

+

Optional Readonly port

port?: MessagePort

Message port.

+

Optional Readonly ready

ready?: boolean

Whether the worker is ready or not.

+

Optional Readonly statistics

statistics?: WorkerStatistics

Whether the worker computes the given statistics or not.

+

Optional Readonly taskFunction

taskFunction?: string

Task function serialized to string.

+

Optional Readonly taskFunctionName

taskFunctionName?: string

Task function name.

+

Optional Readonly taskFunctionNames

taskFunctionNames?: string[]

Task function names.

+

Optional Readonly taskFunctionOperation

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

Task function operation:

  • 'add' - Add a task function.
  • 'remove' - Remove a task function.
  • 'default' - Set a task function as default.
-

Optional Readonly taskFunctionOperationStatus

taskFunctionOperationStatus?: boolean

Whether the task function operation is successful or not.

-

Optional Readonly taskId

taskId?: string

Task UUID.

-

Optional Readonly taskPerformance

taskPerformance?: TaskPerformance

Task performance.

-

Optional Readonly timestamp

timestamp?: number

Timestamp.

-

Optional Readonly transferList

transferList?: TransferListItem[]

Array of transferable objects.

-

Optional Readonly workerError

workerError?: WorkerError<ErrorData>

Worker error.

-

Optional Readonly workerId

workerId?: number

Worker id.

-

Settings

Member Visibility

Theme

On This Page

checkActivedatakillnameportreadystatisticstaskFunctiontaskFunctionNametaskFunctionNamestaskFunctionOperationtaskFunctionOperationStatustaskIdtaskPerformancetimestamptransferListworkerErrorworkerId

Generated using TypeDoc

\ No newline at end of file +

Optional Readonly taskFunctionOperationStatus

taskFunctionOperationStatus?: boolean

Whether the task function operation is successful or not.

+

Optional Readonly taskId

taskId?: string

Task UUID.

+

Optional Readonly taskPerformance

taskPerformance?: TaskPerformance

Task performance.

+

Optional Readonly timestamp

timestamp?: number

Timestamp.

+

Optional Readonly transferList

transferList?: readonly TransferListItem[]

Array of transferable objects.

+

Optional Readonly workerError

workerError?: WorkerError<ErrorData>

Worker error.

+

Optional Readonly workerId

workerId?: number

Worker id.

+

Settings

Member Visibility

Theme

On This Page

checkActivedatakillnameportreadystatisticstaskFunctiontaskFunctionNametaskFunctionNamestaskFunctionOperationtaskFunctionOperationStatustaskIdtaskPerformancetimestamptransferListworkerErrorworkerId
\ No newline at end of file