X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractWorker.html;h=c3a79eecdf9d5a71e8b0258e53321f43a4f97bbf;hb=4cb259d3e1837759b8bac901d3755f1610b5ddc4;hp=3935360050b064b9ba25fe31db199584e59c3b6a;hpb=22c85455d2f30345148aa3e1304d3b0840102f72;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 39353600..c3a79eec 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,13 +1,13 @@ -
Whether this is the main worker or not.
-Reference to main worker.
-Task function(s) processed by the worker when the pool's execution
function is invoked. The first function is the default function.
Options for the worker.
-Protected
Abstract
idProtected
Readonly
isProtected
lastPrivate
Readonly
mainProtected
optsProtected
statisticsProtected
taskThe name of the task function to add.
-The task function to add.
-Whether the task function was added or not.
https://nodejs.org/api/errors.html#class-typeerror If the fn
parameter is not a function.
Optional
name: stringOptional
Optional
name: stringThe function to bind to the current AsyncResource
.
v14.8.0, v12.19.0
@@ -308,7 +316,7 @@ If a task function with the same name already exists, it is replaced.Private
checkThe 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.
Private
checkPrivate
checkPrivate
checkThe task function(s) parameter that should be checked.
-Private
checkPrivate
checkProtected
gethttps://nodejs.org/api/errors.html#class-error If the main worker is not set.
Protected
handleThe error raised by the worker.
-The error message.
Protected
handleThe kill message.
-Protected
Abstract
handleThe ready message.
-The name of the task function to check.
-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
messageThe received message.
-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-error If the name
parameter is the task function used as default task function.
Protected
runThe task to execute.
-https://nodejs.org/api/errors.html#class-error If the task function is not found.
Protected
runTask function that will be executed.
-Input data for the task function.
-The function to call in the execution context of this async resource.
Rest
...args: any[]Rest
Rest
...args: any[]Optional
thisArg: ThisThe receiver to be used for the function call.
-Optional
Rest
...args: any[]Optional arguments to pass to the function.
-Rest
v9.6.0
@@ -677,15 +699,17 @@ then restore the original execution context.Task function that will be executed.
-Input data for the task function.
-Protected
sendProtected
Abstract
sendThe response message.
-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-error If the name
parameter is a non-existing task function.
Private
startPrivate
stopStatic
bindThe function to bind to the current execution context.
-Optional
type: stringAn optional name to associate with the underlying AsyncResource
.
Optional
Optional
thisArg: ThisArgOptional
Optional
thisArg: ThisArgv14.8.0, v12.19.0
@@ -819,15 +847,15 @@ then restore the original execution context.Generated using TypeDoc
The type of async event.
-