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

checkAlive? data? id? kill? name? ready? statistics? taskError? taskPerformance? timestamp? workerId?

Properties

Optional Readonly checkAlive

checkAlive?: boolean

Whether the worker starts or stops its aliveness check.

Optional Readonly data

data?: Data

Task input data that will be passed to the worker.

Optional Readonly id

id?: string

Message UUID.

Optional Readonly kill

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

Kill code.

Optional Readonly name

name?: string

Task name.

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 taskError

taskError?: TaskError<ErrorData>

Task error.

Optional Readonly taskPerformance

taskPerformance?: TaskPerformance

Task performance.

Optional Readonly timestamp

timestamp?: number

Timestamp.

Optional Readonly workerId

workerId?: number

Worker id.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc