Protected getReference to the main worker.
+https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+Protected handlePrivate getProtected handleGets the task function in the given scope.
+Handles a kill message sent by the main worker.
Optional name: stringName of the function that will be returned.
+The kill message.
Protected handleProtected Abstract handleHandles 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.
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.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
Protected messageRemoves a task function from the worker.
+The name of the task function to remove.
+Whether the task function existed and was removed or not.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.
https://nodejs.org/api/errors.html#class-error If the name parameter is the task function used as default task function.
Protected runRuns the given task.
+The task to execute.
+https://nodejs.org/api/errors.html#class-error If the task function is not found.
+Protected runRuns the given function asynchronously.
+Runs the given task function asynchronously.
Function that will be executed.
+Task function that will be executed.
Protected runRuns the given function synchronously.
+Runs the given task function synchronously.
Function that will be executed.
+Task function that will be executed.
Protected sendProtected Abstract sendSends 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.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.
https://nodejs.org/api/errors.html#class-error If the name parameter is a non-existing task function.
Private startPrivate stopPrivate updateStatic bindGenerated using TypeDoc
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
-
-
-
+
-
-
@@ -120,17 +136,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.
+Performance 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 boolean
Whether the task function was added or not.
+ +Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+ +nameparameter is not a string or an empty string.Throws
https://nodejs.org/api/errors.html#class-error If the
+ +nameparameter is the default task function reserved name.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+fnparameter is not a function.async
@@ -209,20 +265,20 @@
Privatebegin-- begin
+- begin
-
-
-
-
Parameters
message: MessageValue<Data, Worker | MessagePort>
Returns TaskPerformance
Returns TaskPerformance
bind
@@ -249,18 +305,60 @@
-Protectedcheck-- check
+- Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/async_hooks.d.ts:283
+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
+Privatecheck+- check
+-
+
+
+
Parameters
++-
+
name: string
Returns void
Privatecheck@@ -272,14 +370,29 @@-
-
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+- check
+-
+
+
+
Parameters
++-
+
+-
+
name: string
fn: TaskFunction<Data, Response>
Returns void
Privatecheck@@ -292,7 +405,7 @@
opts: WorkerOptions
Returns void
emit
@@ -308,20 +421,20 @@ never be called.
Privateend-- end
+- end
-
-
-
-
Parameters
taskPerformance: TaskPerformance
Returns TaskPerformance