- -

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

Index

Properties

checkActive? -data? -kill? -name? -port? -ready? -statistics? -taskFunction? -taskFunctionName? -taskFunctionNames? -taskFunctionOperation? -taskFunctionOperationStatus? -taskId? -taskPerformance? -timestamp? -transferList? -workerError? -workerId? -

Properties

`Optional` `Readonly` checkActive

checkActive?: boolean

Whether the worker starts or stops its activity check.

`Optional` `Readonly` data

data?: Data

Task input data that will be passed to the worker.

`Optional` `Readonly` kill

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

Kill code.

`Optional` `Readonly` name

name?: string

Task name.

`Optional` `Readonly` port

port?: MessagePort

Message port.

`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` taskFunction

taskFunction?: string

Task function serialized to string.

`Optional` `Readonly` taskFunctionName

taskFunctionName?: string

Task function name.

`Optional` `Readonly` taskFunctionNames

taskFunctionNames?: string[]

Task function names.

`Optional` `Readonly` taskFunctionOperation

taskFunctionOperation?: "add" | "default" | "remove"

Task function operation:

'add' - Add a task function.
'remove' - Remove a task function.
'default' - Set a task function as default.

MessageValue | poolifier - v4.0.15

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)

Task<Data>
- MessageValue

Properties

`Optional` `Readonly`checkActive

checkActive?: boolean

Whether the worker starts or stops its activity check.

`Optional` `Readonly`data

data?: Data

Task input data that will be passed to the worker.

`Optional` `Readonly`kill

Kill code.

`Optional` `Readonly`name

name?: string

Task name.

`Optional` `Readonly`port

port?: MessagePort

Message port.

`Optional` `Readonly`priority

priority?: number

Task priority. Lower values have higher priority.

Default Value

0
+

+ +

`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`strategy

Task worker choice strategy.

`Optional` `Readonly`taskFunction

taskFunction?: string

Task function serialized to string.

`Optional` `Readonly`taskFunctionOperation

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` `Readonly` taskFunctionOperationStatus

taskFunctionOperationStatus?: boolean

Whether the task function operation is successful or not.

`Optional` `Readonly` taskId

taskId?: string

Task UUID.

`Optional` `Readonly` taskPerformance

taskPerformance?: TaskPerformance

Task performance.

`Optional` `Readonly` timestamp

timestamp?: number

Timestamp.

`Optional` `Readonly` transferList

transferList?: TransferListItem[]

Array of transferable objects.

`Optional` `Readonly` workerError

workerError?: WorkerError<ErrorData>

Worker error.

`Optional` `Readonly` workerId

workerId?: number

Worker id.

Generated using TypeDoc

`Optional` `Readonly`taskFunctionOperationStatus

taskFunctionOperationStatus?: boolean

Whether the task function operation is successful or not.

`Optional` `Readonly`taskFunctionProperties

taskFunctionProperties?: TaskFunctionProperties

Task function properties.

`Optional` `Readonly`taskFunctionsProperties

taskFunctionsProperties?: TaskFunctionProperties[]

Task functions properties.

`Optional` `Readonly`taskId

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

Task UUID.

`Optional` `Readonly`taskPerformance

taskPerformance?: TaskPerformance

Task performance.

`Optional` `Readonly`timestamp

timestamp?: number

Timestamp.

`Optional` `Readonly`transferList

transferList?: readonly TransferListItem[]

Array of transferable objects.

`Optional` `Readonly`workerError

workerError?: WorkerError<ErrorData>

Worker error.

`Optional` `Readonly`workerId

workerId?: number

Worker id.

Interface MessageValue<Data, ErrorData>Internal

Type Parameters

Data = unknown

ErrorData = unknown

Hierarchy

Index

Properties

Properties

Optional Readonly checkActive

Optional Readonly data

Optional Readonly kill

Optional Readonly name

Optional Readonly port

Optional Readonly ready

Optional Readonly statistics

Optional Readonly taskFunction

Optional Readonly taskFunctionName

Optional Readonly taskFunctionNames

Optional Readonly taskFunctionOperation

Interface MessageValue<Data, ErrorData>Internal

Type Parameters

Hierarchy (view full)

Index

Properties

Properties

Optional ReadonlycheckActive

Optional Readonlydata

Optional Readonlykill

Optional Readonlyname

Optional Readonlyport

Optional Readonlypriority

Default Value

Optional Readonlyready

Optional Readonlystatistics

Optional Readonlystrategy

Optional ReadonlytaskFunction

Optional ReadonlytaskFunctionOperation

Optional Readonly taskFunctionOperationStatus

Optional Readonly taskId

Optional Readonly taskPerformance

Optional Readonly timestamp

Optional Readonly transferList

Optional Readonly workerError

Optional Readonly workerId

Settings

Member Visibility

Theme

On This Page

Optional ReadonlytaskFunctionOperationStatus

Optional ReadonlytaskFunctionProperties

Optional ReadonlytaskFunctionsProperties

Optional ReadonlytaskId

Optional ReadonlytaskPerformance

Optional Readonlytimestamp

Optional ReadonlytransferList

Optional ReadonlyworkerError

Optional ReadonlyworkerId

Settings

On This Page

Interface MessageValue<Data, ErrorData>`Internal`

`Optional` `Readonly` checkActive

`Optional` `Readonly` data

`Optional` `Readonly` kill

`Optional` `Readonly` name

`Optional` `Readonly` port

`Optional` `Readonly` ready

`Optional` `Readonly` statistics

`Optional` `Readonly` taskFunction

`Optional` `Readonly` taskFunctionName

`Optional` `Readonly` taskFunctionNames

`Optional` `Readonly` taskFunctionOperation

Interface MessageValue<Data, ErrorData>`Internal`

`Optional` `Readonly`checkActive

`Optional` `Readonly`data

`Optional` `Readonly`kill

`Optional` `Readonly`name

`Optional` `Readonly`port

`Optional` `Readonly`priority

`Optional` `Readonly`ready

`Optional` `Readonly`statistics

`Optional` `Readonly`strategy

`Optional` `Readonly`taskFunction

`Optional` `Readonly`taskFunctionOperation

`Optional` `Readonly` taskFunctionOperationStatus

`Optional` `Readonly` taskId

`Optional` `Readonly` taskPerformance

`Optional` `Readonly` timestamp

`Optional` `Readonly` transferList

`Optional` `Readonly` workerError

`Optional` `Readonly` workerId

`Optional` `Readonly`taskFunctionOperationStatus

`Optional` `Readonly`taskFunctionProperties

`Optional` `Readonly`taskFunctionsProperties

`Optional` `Readonly`taskId

`Optional` `Readonly`taskPerformance

`Optional` `Readonly`timestamp

`Optional` `Readonly`transferList

`Optional` `Readonly`workerError

`Optional` `Readonly`workerId