Interface MessageValue<MessageData, Data, MainWorker>Internal

Message object that is passed between main worker and worker.

Type Parameters

  • MessageData = unknown

    Type of data sent to and/or from the worker. This can only be serializable data.

  • Data = unknown

    Type of data sent to the worker. This can only be serializable data.

  • MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort

    Type of main worker.

Hierarchy

  • Task<MessageData>
    • MessageValue

Properties

data? id? kill? name? parent? statistics? taskError? taskPerformance? timestamp?

Properties

Optional Readonly data

data?: MessageData

Task input data that will be passed to the worker.

Optional Readonly id

id?: string

Message UUID.

Optional Readonly kill

kill?: 1 | "SOFT" | "HARD"

Kill code.

Optional Readonly name

name?: string

Task name.

Optional Readonly parent

parent?: MainWorker

Reference to main worker.

Optional Readonly statistics

statistics?: WorkerStatistics

Whether to compute the given statistics or not.

Optional Readonly taskError

taskError?: TaskError<Data>

Task error.

Optional Readonly taskPerformance

taskPerformance?: TaskPerformance

Task performance.

Optional Readonly timestamp

timestamp?: number

Timestamp.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc