Interface MessageValue<Data, ErrorData>`Internal`

Message object that is passed between main worker and worker.

+MessageValue | poolifier - v4.0.11

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

Index

Properties

checkActive? +

Hierarchy (view full)

Task<Data>
- MessageValue

Index

Properties

checkActive? data? kill? name? @@ -22,30 +22,30 @@ 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` priority

priority?: number

Task priority. Lower values have higher priority.

Default Value

0
+

Optional Readonly data
data?: Data
Task input data that will be passed to the worker.
+
Inherited from Task.data
Defined in src/utility-types.ts:100

Optional Readonly kill
kill?: true | "success" | "SOFT" | "HARD" | "failure"
Kill code.
+
Defined in src/utility-types.ts:141

Optional Readonly name
name?: string
Task name.
+
Inherited from Task.name
Defined in src/utility-types.ts:96

Optional Readonly port
port?: MessagePort
Message port.
+
Defined in src/utility-types.ts:188

Optional Readonly priority
priority?: number
Task priority. Lower values have higher priority.
+
Default Value
0
 
-
Inherited from Task.priority
Defined in src/utility-types.ts:106

Optional Readonly ready
ready?: boolean
Whether the worker is ready or not.
-
Defined in src/utility-types.ts:180

Optional Readonly statistics
statistics?: WorkerStatistics
Whether the worker computes the given statistics or not.
-
Defined in src/utility-types.ts:176

Optional Readonly strategy
strategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Task worker choice strategy.
-
Inherited from Task.strategy
Defined in src/utility-types.ts:110

Optional Readonly taskFunction
taskFunction?: string
Task function serialized to string.
-
Defined in src/utility-types.ts:168

Optional Readonly taskFunctionOperation
taskFunctionOperation?: "add" | "default" | "remove"
Task function operation:
+
Inherited from Task.priority
Defined in src/utility-types.ts:106

Optional Readonly ready
ready?: boolean
Whether the worker is ready or not.
+
Defined in src/utility-types.ts:180

Optional Readonly statistics
statistics?: WorkerStatistics
Whether the worker computes the given statistics or not.
+
Defined in src/utility-types.ts:176

Optional Readonly strategy
strategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Task worker choice strategy.
+
Inherited from Task.strategy
Defined in src/utility-types.ts:110

Optional Readonly taskFunction
taskFunction?: string
Task function serialized to string.
+
Defined in src/utility-types.ts:168

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.
 
-
Defined in src/utility-types.ts:156

Optional Readonly taskFunctionOperationStatus
taskFunctionOperationStatus?: boolean
Whether the task function operation is successful or not.
-
Defined in src/utility-types.ts:160

Optional Readonly taskFunctionProperties
taskFunctionProperties?: TaskFunctionProperties
Task function properties.
-
Defined in src/utility-types.ts:164

Optional Readonly taskFunctionsProperties
taskFunctionsProperties?: TaskFunctionProperties[]
Task functions properties.
-
Defined in src/utility-types.ts:172

Optional Readonly taskId
taskId?: `${string}-${string}-${string}-${string}-${string}`
Task UUID.
-
Inherited from Task.taskId
Defined in src/utility-types.ts:122

Optional Readonly taskPerformance
taskPerformance?: TaskPerformance
Task performance.
-
Defined in src/utility-types.ts:149

Optional Readonly timestamp
timestamp?: number
Timestamp.
-
Inherited from Task.timestamp
Defined in src/utility-types.ts:118

Optional Readonly transferList
transferList?: readonly TransferListItem[]
Array of transferable objects.
-
Inherited from Task.transferList
Defined in src/utility-types.ts:114

Optional Readonly workerError
workerError?: WorkerError<ErrorData>
Worker error.
-
Defined in src/utility-types.ts:145

Optional Readonly workerId
workerId?: number
Worker id.
-
Defined in src/utility-types.ts:137


\ No newline at end of file
+

Optional Readonly taskFunctionOperationStatus
taskFunctionOperationStatus?: boolean
Whether the task function operation is successful or not.
+
Defined in src/utility-types.ts:160

Optional Readonly taskFunctionProperties
taskFunctionProperties?: TaskFunctionProperties
Task function properties.
+
Defined in src/utility-types.ts:164

Optional Readonly taskFunctionsProperties
taskFunctionsProperties?: TaskFunctionProperties[]
Task functions properties.
+
Defined in src/utility-types.ts:172

Optional Readonly taskId
taskId?: `${string}-${string}-${string}-${string}-${string}`
Task UUID.
+
Inherited from Task.taskId
Defined in src/utility-types.ts:122

Optional Readonly taskPerformance
taskPerformance?: TaskPerformance
Task performance.
+
Defined in src/utility-types.ts:149

Optional Readonly timestamp
timestamp?: number
Timestamp.
+
Inherited from Task.timestamp
Defined in src/utility-types.ts:118

Optional Readonly transferList
transferList?: readonly TransferListItem[]
Array of transferable objects.
+
Inherited from Task.transferList
Defined in src/utility-types.ts:114

Optional Readonly workerError
workerError?: WorkerError<ErrorData>
Worker error.
+
Defined in src/utility-types.ts:145

Optional Readonly workerId
workerId?: number
Worker id.
+
Defined in src/utility-types.ts:137

Interface MessageValue<Data, ErrorData>Internal

Interface MessageValue<Data, ErrorData>Internal

Type Parameters

Hierarchy (view full)

Index

Properties

Hierarchy (view full)

Index

Properties

Properties

Optional Readonly checkActive

Optional Readonly data

Optional Readonly kill

Optional Readonly name

Optional Readonly port

Optional Readonly priority

Default Value

Optional Readonly data

Optional Readonly kill

Optional Readonly name

Optional Readonly port

Optional Readonly priority

Default Value

Optional Readonly ready

Optional Readonly statistics

Optional Readonly strategy

Optional Readonly taskFunction

Optional Readonly taskFunctionOperation

Optional Readonly ready

Optional Readonly statistics

Optional Readonly strategy

Optional Readonly taskFunction

Optional Readonly taskFunctionOperation

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

Settings

Member Visibility

Theme

On This Page

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

Settings

Member Visibility

Theme

On This Page

Interface MessageValue<Data, ErrorData>`Internal`

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

`Optional` `Readonly` statistics

`Optional` `Readonly` strategy

`Optional` `Readonly` taskFunction

`Optional` `Readonly` taskFunctionOperation

`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

`Settings`

`Member Visibility`

`Theme`

`On This Page`

`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

`Settings`

`Member Visibility`

`Theme`

`On This Page`