Type of data this worker receives from pool's execution. This can only be serializable data.
Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
Type of response the worker sends back to the main worker. This can only be serializable data.
Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
Task function(s) processed by the worker when the pool's execution function is invoked.
execution
Protected
Optional
Readonly
Handler id of the aliveInterval worker alive check.
aliveInterval
Handler id of the activeInterval worker activity check.
activeInterval
Reference to main worker.
Options for the worker.
Performance statistics computation.
Performance statistics computation requirements.
Worker id.
Adds a task function to the worker. +If a task function with the same name already exists, it is replaced.
The name of the task function to add.
The task function to add.
Whether the task function was added or not.
Checks if the worker should be terminated, because its living too long.
Reference to the main worker.
Handles an error and convert it to a string so it can be sent back to the main worker.
The error raised by the worker.
Message of the error.
The error message.
Handles a kill message sent by the main worker.
The kill message.
Handles the ready message sent by the main worker.
The ready message.
Checks if the worker has a task function with the given name.
The name of the task function to check.
Whether the worker has a task function with the given name or not.
Lists the names of the worker's task functions.
The names of the worker's task functions.
Message received.
The received message.
Removes a task function from the worker.
The name of the task function to remove.
Whether the task function existed and was removed or not.
Runs the given task.
The task to execute.
Runs the given function asynchronously.
Runs the given task function asynchronously.
Function that will be executed.
Task function that will be executed.
Input data for the given function.
Input data for the task function.
Runs the given function synchronously.
Runs the given task function synchronously.
Sends task function names to the main worker.
Sends a message to the main worker.
Sends a message to main worker.
The response message.
Sets the default task function to use in the worker.
The name of the task function to use as default task function.
Whether the default task function was set or not.
Static
Generated using TypeDoc
Type of data this worker receives from pool's execution. This can only be serializable data.
+Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
Response = unknown
-Type of response the worker sends back to the main worker. This can only be serializable data.
+Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
-
+Index
Index
Constructors
-Properties
-Accessors
+Methods
-Constructors
constructor
+constructor
Parameters
taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
+taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
Task function(s) processed by the worker when the pool's
executionfunction is invoked.Properties
-
-ProtectedOptionalReadonlyaliveHandler id of the
+aliveIntervalworker alive check.
+ProtectedOptionalactiveHandler id of the
activeIntervalworker activity check.ProtectedReadonlyisProtectedlast
-ProtectedmainReference to main worker.
-
-ProtectedReadonlyopts
+ProtectedoptsOptions for the worker.
-ProtectedstatisticsPerformance statistics computation.
+Performance statistics computation requirements.
-ProtectedtaskTask function(s) processed by the worker when the pool's
executionfunction is invoked.Accessors
+
+Protectedid+- get id(): number
+-
+
Worker id.
+Returns number
+Methods
+add
++- add
+-
+
+
+
Adds a task function to the worker. +If a task function with the same name already exists, it is replaced.
+Parameters
++-
+
+-
+
name: string
+The name of the task function to add.
+fn: TaskFunction<Data, Response>
+The task function to add.
+Returns TaskFunctionOperationResult
Whether the task function was added or not.
+ +async
@@ -194,7 +238,7 @@ but the minimum number of workers will be guaranteed.
bind
@@ -221,19 +265,7 @@ but the minimum number of workers will be guaranteed.
-Protectedcheck-- check
--
-
Checks if the worker should be terminated, because its living too long.
-Returns void
-emit
@@ -249,7 +281,7 @@ never be called.
Protectedget@@ -259,14 +291,16 @@ never be called.
Returns Worker
Reference to the main worker.
-
-Protectedhandle-- handle
+
+- handle
-
-
-
Handles an error and convert it to a string so it can be sent back to the main worker.
Parameters
e: string | Error
+error: string | Error
The error raised by the worker.
Returns string
Message of the error.
+Returns string
The error message.
+Protectedhandle+- handle
+-
+
+
+
Handles a kill message sent by the main worker.
+Parameters
++-
+
message: MessageValue<Data, unknown>
+The kill message.
+Returns void
+
+Protectedhandle+- handle
+-
+
+
+
Handles the ready message sent by the main worker.
+Parameters
++-
+
message: MessageValue<Data, unknown>
+The ready message.
+Returns void
+
+Protectedhandle+- handle
+-
+
+
+
Parameters
++-
+
message: MessageValue<Data, unknown>
Returns void
has
++- has
+-
+
+
+
Checks if the worker has a task function with the given name.
+Parameters
++-
+
name: string
+The name of the task function to check.
+Returns TaskFunctionOperationResult
Whether the worker has a task function with the given name or not.
+ +list
++- list
+-
+
Lists the names of the worker's task functions.
+Returns string[]
The names of the worker's task functions.
+ +Protectedmessage@@ -295,40 +417,81 @@ never be called.-
-
Parameters
message: MessageValue<Data, Worker>
-Message received.
+message: MessageValue<Data, unknown>
+The received message.
Returns void
remove
++- remove
+-
+
+
+
Removes a task function from the worker.
+Parameters
++-
+
name: string
+The name of the task function to remove.
+Returns TaskFunctionOperationResult
Whether the task function existed and was removed or not.
+ +
+Protectedrun+- run(task): void
+-
+
+
+
Runs the given task.
+Parameters
++-
+
task: Task<Data>
+The task to execute.
+Returns void
+Protectedrun-- run
+- run
-
-
- Defined in node_modules/.pnpm/@types+node@20.6.2/node_modules/@types/node/async_hooks.d.ts:295
+
Runs the given function asynchronously.
+Runs the given task function asynchronously.
Parameters
-
-
-
-
+- Defined in src/worker/abstract-worker.ts:555
+fn: WorkerAsyncFunction<Data, Response>
-Function that will be executed.
+fn: TaskAsyncFunction<Data, Response>
+Task function that will be executed.
message: MessageValue<Data, Worker | MessagePort>
-Input data for the given function.
+task: Task<Data>
+Input data for the task function.
Returns void
run
@@ -383,44 +546,56 @@ then restore the original execution context.
Protectedrun-- run
+- run
-
-
-
-
-
-
+- Defined in src/worker/abstract-worker.ts:521
+
+
- send
-
-
-
-
@@ -428,7 +603,28 @@ then restore the original execution context.
+- Defined in src/worker/cluster-worker.ts:68
+
+
+- Defined in node_modules/.pnpm/@types+node@20.6.2/node_modules/@types/node/async_hooks.d.ts:312
- Defined in node_modules/.pnpm/@types+node@20.6.2/node_modules/@types/node/async_hooks.d.ts:278
+
+
+
+
-
Runs the given function synchronously.
+Runs the given task function synchronously.
Parameters
fn: WorkerSyncFunction<Data, Response>
-Function that will be executed.
+fn: TaskSyncFunction<Data, Response>
+Task function that will be executed.
message: MessageValue<Data, Worker | MessagePort>
-Input data for the given function.
+task: Task<Data>
+Input data for the task function.
Returns void
+Protectedsend+- send
+-
+
Sends task function names to the main worker.
+Returns void
+ProtectedsendSends a message to the main worker.
+Sends a message to main worker.
Parameters
message: MessageValue<Response, Worker | MessagePort>
+message: MessageValue<Response, unknown>
The response message.
set
++- set
+-
+
+
+
Sets the default task function to use in the worker.
+Parameters
++-
+
name: string
+The name of the task function to use as default task function.
+Returns TaskFunctionOperationResult
Whether the default task function was set or not.
+ +trigger
@@ -439,7 +635,7 @@ then restore the original execution context.
Staticbind@@ -475,20 +671,20 @@ then restore the original execution context.
-
+Settings
Settings
Member Visibility
Theme
@@ -496,76 +692,60 @@ then restore the original execution context.
- constructor
-- alive
+- active
- is
- last
-- main
- opts
- statistics
- task
+- id
+- add
- async
- bind
-- check
- emit
- get
-- handle
+- handle
+- handle
+- handle
+- handle
+- has
+- list
- message
+- remove
+- run
- run
- run
- run
+- send
- send
+- set
- trigger
- bind
Generated using TypeDoc
Generated using TypeDoc