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.
Constructs a new poolifier worker.
Task function(s) processed by the worker when the pool's execution function is invoked. The first function is the default function.
execution
Reference to main worker.
Options for the worker.
Protected
Optional
Readonly
Handler id of the aliveInterval worker alive check.
aliveInterval
Handler id of the activeInterval worker activity check.
activeInterval
Abstract
Worker id.
Private
Performance statistics computation requirements.
Task function(s) processed by the worker when the pool's execution function is invoked.
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.
Check if the message worker id is set and matches the worker id.
The message to check.
https://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.
Checks if the taskFunctions parameter is passed to the constructor.
taskFunctions
Checks if the taskFunctions parameter is passed to the constructor and valid.
The task function(s) parameter that should be checked.
Reference to the main worker.
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
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.
The error message.
Gets the task function in the given scope.
Handles a kill message sent by the main worker.
Name of the function that will be returned.
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.
Message of the error.
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.
Starts the worker check active interval.
Stops the worker check active interval.
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
-Methods
-Constructors
constructor
+constructor
-- new
+- new
-
-
-
+
-
-
@@ -117,17 +135,17 @@
Constructs a new poolifier worker.
Type Parameters
MainWorker extends Worker | MessagePort
MainWorker extends MessagePort | Worker
Data = unknown
taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
-Task function(s) processed by the worker when the pool's
+executionfunction is invoked. The first function is the default function.mainWorker: MainWorker
+Reference to main worker.
mainWorker: undefined | null | MainWorker
-Reference to main worker.
+taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
+Task function(s) processed by the worker when the pool's
executionfunction is invoked. The first function is the default function.opts: WorkerOptions = ...
+opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
Options for the worker.
Properties
-
-ProtectedOptionalReadonlyaliveHandler id of the
+aliveIntervalworker alive check.
+ProtectedOptionalactiveHandler id of the
activeIntervalworker activity check.
+ProtectedAbstractidWorker id.
+ProtectedReadonlyisProtectedlast
-Protectedmain
+PrivateReadonlymainReference to main worker.
-ProtectedReadonlyopts
+ProtectedoptsOptions for the worker.
+ProtectedstatisticsPerformance statistics computation requirements.
+
-ProtectedtaskTask function(s) processed by the worker when the pool's
executionfunction is invoked.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
@@ -198,7 +258,20 @@
+Privatebegin+- begin
+-
+
+
+
Parameters
++-
+
Optionalname: stringReturns TaskPerformance
bind
@@ -225,37 +298,66 @@
-Protectedcheck-- check
+- Defined in node_modules/.pnpm/@types+node@20.6.2/node_modules/@types/node/async_hooks.d.ts:284
+Privatecheck+- check
-
Checks if the worker should be terminated, because its living too long.
Returns void
+Privatecheck+- check
+-
+
+
+
+
Check if the message worker id is set and matches the worker id.
+Parameters
++-
+
message: MessageValue<Data, unknown>
+The message to check.
+Returns void
+Throws
https://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.
+
+Privatecheck+- check
+-
+
Returns void
PrivatecheckChecks if the
+taskFunctionsparameter is passed to the constructor.Checks if the
taskFunctionsparameter is passed to the constructor and valid.Parameters
taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
+taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
The task function(s) parameter that should be checked.
Returns void
+Privatecheck@@ -268,7 +370,7 @@
opts: WorkerOptions
Returns void
emit
@@ -284,7 +386,20 @@ never be called.
+Privateend+- end
+-
+
+
+
Parameters
++-
+
taskPerformance: TaskPerformance
Returns TaskPerformance
Protectedget@@ -294,48 +409,114 @@ never be called.
Returns MainWorker
Reference to the main worker.
+Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+
+Protectedhandle+- handle
+-
+
+
+
Handles an error and convert it to a string so it can be sent back to the main worker.
+Parameters
++-
+
error: string | Error
+The error raised by the worker.
+Returns string
The error message.
+
-Privateget-- get
+- Defined in src/worker/abstract-worker.ts:485
+Protectedhandle+- handle
-
-
-- Defined in src/worker/abstract-worker.ts:371
+
+
+
\ No newline at end of file
Gets the task function in the given scope.
+Handles a kill message sent by the main worker.
Parameters
-
-
-
-Optionalname: stringName of the function that will be returned.
+message: MessageValue<Data, unknown>
+The kill message.
Returns WorkerFunction<Data, Response>
+Returns void
+ProtectedhandleProtectedAbstracthandle-- handle
+- handle
-
-
+
+
+
+
+
+- Defined in src/worker/abstract-worker.ts:243
+- Defined in src/worker/abstract-worker.ts:306
+
+
+
+
-
-
\ No newline at end of file
+
Handles an error and convert it to a string so it can be sent back to the main worker.
+Handles the ready message sent by the main worker.
Parameters
-
-
+e: string | Error
-The error raised by the worker.
+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 string
Message of the error.
+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@@ -347,38 +528,77 @@ never be called.-
-
Parameters
message: MessageValue<Data, MainWorker>
-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
@@ -433,50 +653,103 @@ then restore the original execution context.
Protectedrun-- run
+- run
-
-
-
-
-
-
+- Defined in src/worker/abstract-worker.ts:521
+
+
- send
-
-
-
-
- Defined in src/worker/abstract-worker.ts:466
+
+
+
+
+
+
+- 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
+ProtectedAbstractsendSends a message to the main worker.
+Sends a message to main worker.
Parameters
message: MessageValue<Response, Worker | MessagePort>
+message: MessageValue<Response, Data>
The response message.
Returns void
+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.
+ +
+Privatestart+- start
+-
+
Starts the worker check active interval.
+Returns void
+
+Privatestop+- stop
+-
+
Stops the worker check active interval.
+Returns void
+trigger
@@ -487,7 +760,15 @@ then restore the original execution context.
+Privateupdate+- update
+-
+
Returns void
Staticbind@@ -523,20 +804,20 @@ then restore the original execution context.
-
+Settings
Settings
Member Visibility
Theme
@@ -544,78 +825,71 @@ then restore the original execution context.
- constructor
-- alive
+- active
+- id
- is
- last
-- main
+- main
- opts
+- statistics
- task
+- add
- async
+- begin
- bind
-- check
+- check
+- check
+- check
- check
- check
- emit
+- end
- get
-- get
- handle
+- handle
+- handle
+- handle
+- has
+- list
- message
+- remove
+- run
- run
- run
- run
+- send
- send
+- set
+- start
+- stop
- trigger
+- update
- bind
Generated using TypeDoc
Generated using TypeDoc