Interface MessageValue<Data, ErrorData>Internal

Message object that is passed between main worker and worker.

interface MessageValue<Data, ErrorData> {
    checkActive?: boolean;
    data?: Data;
    kill?:
        | true
        | "success"
        | "SOFT"
        | "HARD"
        | "failure";
    name?: string;
    port?: MessagePort;
    priority?: number;
    ready?: boolean;
    statistics?: WorkerStatistics;
    strategy?:
        | "ROUND_ROBIN"
        | "LEAST_USED"
        | "LEAST_BUSY"
        | "LEAST_ELU"
        | "FAIR_SHARE"
        | "WEIGHTED_ROUND_ROBIN"
        | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
    taskFunction?: string;
    taskFunctionOperation?: "add" | "default" | "remove";
    taskFunctionOperationStatus?: boolean;
    taskFunctionProperties?: TaskFunctionProperties;
    taskFunctionsProperties?: TaskFunctionProperties[];
    taskId?: `${string}-${string}-${string}-${string}-${string}`;
    taskPerformance?: TaskPerformance;
    timestamp?: number;
    transferList?: readonly TransferListItem[];
    workerError?: WorkerError<ErrorData>;
    workerId?: number;
}

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 (view full)

Properties

checkActive? data? kill? name? port? priority? ready? statistics? strategy? taskFunction? taskFunctionOperation? taskFunctionOperationStatus? taskFunctionProperties? taskFunctionsProperties? taskId? taskPerformance? timestamp? transferList? workerError? workerId?

Properties

Optional ReadonlycheckActive

checkActive?: boolean

Whether the worker starts or stops its activity check.

Optional Readonlydata

data?: Data

Task input data that will be passed to the worker.

Optional Readonlykill

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

Kill code.

Optional Readonlyname

name?: string

Task name.

Optional Readonlyport

port?: MessagePort

Message port.

Optional Readonlypriority

priority?: number

Task priority. Lower values have higher priority.

Default Value

0

Optional Readonlyready

ready?: boolean

Whether the worker is ready or not.

Optional Readonlystatistics

statistics?: WorkerStatistics

Whether the worker computes the given statistics or not.

Optional Readonlystrategy

strategy?:
    | "ROUND_ROBIN"
    | "LEAST_USED"
    | "LEAST_BUSY"
    | "LEAST_ELU"
    | "FAIR_SHARE"
    | "WEIGHTED_ROUND_ROBIN"
    | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

Task worker choice strategy.

Optional ReadonlytaskFunction

taskFunction?: string

Task function serialized to string.

Optional ReadonlytaskFunctionOperation

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 ReadonlytaskFunctionOperationStatus

taskFunctionOperationStatus?: boolean

Whether the task function operation is successful or not.

Optional ReadonlytaskFunctionProperties

taskFunctionProperties?: TaskFunctionProperties

Task function properties.

Optional ReadonlytaskFunctionsProperties

taskFunctionsProperties?: TaskFunctionProperties[]

Task functions properties.

Optional ReadonlytaskId

taskId?: `${string}-${string}-${string}-${string}-${string}`

Task UUID.

Optional ReadonlytaskPerformance

taskPerformance?: TaskPerformance

Task performance.

Optional Readonlytimestamp

timestamp?: number

Timestamp.

Optional ReadonlytransferList

transferList?: readonly TransferListItem[]

Array of transferable objects.

Optional ReadonlyworkerError

workerError?: WorkerError<ErrorData>

Worker error.

Optional ReadonlyworkerId

workerId?: number

Worker id.

Settings

Member Visibility

On This Page

Properties