X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=374f5527ef3e3d6eab5659aeaee2676963fe81be;hb=a9fc134421fb6926f4eff76d1d82c9bd8b341606;hp=3d8509d155143796c9cc23bccf712b581c24091d;hpb=b4e93467358d93166716dc6e5075d58c18c961c7;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 3d8509d1..374f5527 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,45 +1,45 @@ -MessageValue | poolifier - v3.0.6

Interface MessageValue<Data, ErrorData>Internal

Message object that is passed between main worker and worker.

-

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

  • Task<Data>
    • MessageValue

Properties

checkActive? -data? -kill? -name? -port? -ready? -statistics? -taskFunction? -taskFunctionName? -taskFunctionNames? -taskFunctionOperation? -taskFunctionOperationStatus? -taskId? -taskPerformance? -timestamp? -transferList? -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:

+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

  • 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

checkActive? +data? +kill? +name? +port? +ready? +statistics? +taskFunction? +taskFunctionName? +taskFunctionNames? +taskFunctionOperation? +taskFunctionOperationStatus? +taskId? +taskPerformance? +timestamp? +transferList? +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:

  • '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

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?: 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