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

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