Interface MessageValue<Data, MainWorker>Internal

Message object that is passed between main worker and worker.

Type Parameters

  • 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<Data>
    • MessageValue

Properties

data? elu? error? errorData? id? kill? name? parent? runTime? statistics? timestamp? waitTime?

Properties

Optional Readonly data

data?: Data

Task input data that will be passed to the worker.

Optional Readonly elu

elu?: EventLoopUtilization

Event loop utilization.

Optional Readonly error

error?: string

Task error.

Optional Readonly errorData

errorData?: unknown

Task data triggering task error.

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 runTime

runTime?: number

Runtime.

Optional Readonly statistics

statistics?: WorkerStatistics

Whether to compute the given statistics or not.

Optional Readonly timestamp

timestamp?: number

Timestamp.

Optional Readonly waitTime

waitTime?: number

Wait time.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc