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? error? id? kill? name? parent? runTime? submissionTimestamp? waitTime?

Properties

Optional Readonly data

data?: Data

Task input data that will be passed to the worker.

Optional Readonly error

error?: string

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 submissionTimestamp

submissionTimestamp?: number

Submission timestamp.

Optional Readonly waitTime

waitTime?: number

Wait time.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc