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:

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