Abstract 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.
-Private startPrivate stopPrivate updateStatic bindBinds the given function to the current execution context.
+Private startPrivate stopPrivate updateStatic bindBinds the given function to the current execution context.
The function to bind to the current execution context.
Optional type: stringAn optional name to associate with the underlying AsyncResource.
Optional thisArg: ThisArgv14.8.0, v12.19.0
-Generated using TypeDoc
Generated using TypeDoc
Base class that implements some shared logic for all poolifier workers.
+- Preparing search index...
- The search index is not available
poolifier - v3.0.10Class AbstractWorker<MainWorker, Data, Response>
AbstractBase class that implements some shared logic for all poolifier workers.
Type Parameters
MainWorker extends Worker | MessagePort
Type of main worker.
Data = unknown
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 structured-cloneable data.
-Hierarchy
Index
Constructors
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Constructs a new poolifier worker.
+Constructors
constructor
Constructs a new poolifier worker.
Type Parameters
MainWorker extends MessagePort | Worker
Data = unknown
Response = unknown
Parameters
type: string
The type of async event.
isMain: boolean
Whether this is the main worker or not.
mainWorker: 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 = DEFAULT_WORKER_OPTIONS
Options for the worker.
-Returns AbstractWorker<MainWorker, Data, Response>
Properties
ProtectedOptionalactiveHandler id of the
-activeIntervalworker activity check.ProtectedAbstractidWorker id.
-ProtectedReadonlyisWhether this is the main worker or not.
-ProtectedlastTimestamp of the last task processed by this worker.
-PrivateReadonlymainReference to main worker.
-ProtectedoptsOptions for the worker.
-ProtectedstatisticsPerformance statistics computation requirements.
-ProtectedtaskTask function(s) processed by the worker when the pool's
-executionfunction is invoked.Methods
add
Adds a task function to the worker. +
Returns AbstractWorker<MainWorker, Data, Response>
Properties
ProtectedOptionalactiveHandler id of the
+activeIntervalworker activity check.ProtectedAbstractidWorker id.
+ProtectedReadonlyisWhether this is the main worker or not.
+ProtectedlastTimestamp of the last task processed by this worker.
+PrivateReadonlymainReference to main worker.
+ProtectedoptsOptions for the worker.
+ProtectedstatisticsPerformance statistics computation requirements.
+ProtectedtaskTask function(s) processed by the worker when the pool's
+executionfunction is invoked.Methods
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
Returns number
The unique
-asyncIdassigned to the resource.PrivatebeginParameters
Optionalname: stringReturns TaskPerformance
bind
Binds the given function to execute to this
+AsyncResource's scope.async
Returns number
The unique
+asyncIdassigned to the resource.PrivatebeginParameters
Optionalname: stringReturns TaskPerformance
bind
Binds the given function to execute to this
AsyncResource's scope.Type Parameters
Func extends ((...args) => any)
Parameters
fn: Func
The function to bind to the current
AsyncResource.Returns Func
Since
v14.8.0, v12.19.0
-PrivatecheckChecks if the worker should be terminated, because its living too long.
-Returns void
PrivatecheckCheck if the message worker id is set and matches the worker id.
+PrivatecheckChecks if the worker should be terminated, because its living too long.
+Returns void
PrivatecheckCheck 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.
-PrivatecheckReturns void
PrivatecheckChecks if the
+taskFunctionsparameter is passed to the constructor and valid.PrivatecheckReturns void
PrivatecheckChecks if the
taskFunctionsparameter is passed to the constructor and valid.Parameters
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
The task function(s) parameter that should be checked.
-Returns void
PrivatecheckParameters
opts: WorkerOptions
Returns void
emit
Call all
destroyhooks. This should only ever be called once. An error will +Returns void
PrivatecheckParameters
opts: WorkerOptions
Returns void
emit
Call all
destroyhooks. This should only ever be called once. An error will be thrown if it is called more than once. This must be manually called. If the resource is left to be collected by the GC then thedestroyhooks will never be called.Returns AbstractWorker<MainWorker, Data, Response>
A reference to
-asyncResource.PrivateendParameters
taskPerformance: TaskPerformance
Returns TaskPerformance
ProtectedgetReturns the main worker.
+PrivateendParameters
taskPerformance: TaskPerformance
Returns TaskPerformance
ProtectedgetReturns the main worker.
Returns MainWorker
Reference to the main worker.
Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
-ProtectedhandleHandles an error and convert it to a string so it can be sent back to the main worker.
+ProtectedhandleHandles 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.
-ProtectedhandleHandles a kill message sent by the main worker.
-Parameters
_message: MessageValue<Data, unknown>
Returns void
ProtectedAbstracthandleHandles the ready message sent by the main worker.
+ProtectedhandleHandles a kill message sent by the main worker.
+Parameters
_message: MessageValue<Data, unknown>
Returns void
ProtectedAbstracthandleHandles the ready message sent by the main worker.
Parameters
message: MessageValue<Data, unknown>
The ready message.
-Returns void
ProtectedhandleParameters
message: MessageValue<Data, unknown>
Returns void
has
Checks if the worker has a task function with the given name.
+Returns void
ProtectedhandleParameters
message: MessageValue<Data, unknown>
Returns void
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
Lists the names of the worker's task functions.
+list
Lists the names of the worker's task functions.
Returns string[]
The names of the worker's task functions.
-ProtectedmessageWorker message listener.
+ProtectedmessageWorker message listener.
Parameters
message: MessageValue<Data, unknown>
The received message.
-Returns void
remove
Removes a task function from the worker.
+Returns void
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.
-ProtectedrunRuns the given task.
+ProtectedrunRuns the given task.
Parameters
task: Task<Data>
The task to execute.
-Returns void
ProtectedrunRuns the given task function asynchronously.
+Returns void
ProtectedrunRuns the given task function asynchronously.
Parameters
fn: TaskAsyncFunction<Data, Response>
Task function that will be executed.
task: Task<Data>
Input data for the task function.
-Returns void
run
Call the provided function with the provided arguments in the execution context +
Returns void
run
Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks before callbacks, call the function, trigger the AsyncHooks after callbacks, and then restore the original execution context.
@@ -109,20 +109,20 @@ then restore the original execution context.Parameters
this: This
Rest...args: any[]Returns Result
OptionalthisArg: ThisThe receiver to be used for the function call.
Rest...args: any[]Optional arguments to pass to the function.
Returns Result
Since
v9.6.0
-ProtectedrunRuns the given task function synchronously.
+ProtectedrunRuns the given task function synchronously.
Parameters
fn: TaskSyncFunction<Data, Response>
Task function that will be executed.
task: Task<Data>
Input data for the task function.
-Returns void
ProtectedsendSends task function names to the main worker.
-Returns void
ProtectedAbstractsendSends a message to main worker.
+Returns void
ProtectedsendSends task function names to the main worker.
+Returns void
ProtectedAbstractsendSends a message to main worker.
Parameters
message: MessageValue<Response, Data>
The response message.
-Returns void
set
Sets the default task function to use in the worker.
+Returns void