ThreadWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FThreadWorker.html;h=857696e685f9b240467d9d780cee5d00be5e9514;hb=71d327d5587f0ce2b746ba33ec0cfbb3a0dc5d1b;hp=386f04c1381b3a38072cbef927d74fb4c0b739f0;hpb=9867896b122160ea5d8e6dbccba4cc5916bf523b;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 386f04c1..857696e6 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier - v2.6.45

+ThreadWorker | poolifier - v2.7.4

@@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

ThreadWorker

Defined in src/worker/thread-worker.ts:26

@@ -81,15 +81,16 @@ but the minimum number of workers will be guaranteed.

handleError handleKillMessage handleReadyMessage +handleTaskFunctionOperationMessage hasTaskFunction -listTaskFunctions +listTaskFunctionNames messageListener removeTaskFunction run runAsync runInAsyncScope runSync -sendTaskFunctionsListToMainWorker +sendTaskFunctionNamesToMainWorker sendToMainWorker setDefaultTaskFunction triggerAsyncId @@ -128,7 +129,7 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/thread-worker.ts:40

Properties

@@ -139,7 +140,7 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:79

`Protected` `Readonly` isMain

isMain: boolean

@@ -148,7 +149,7 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:91

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -157,7 +158,7 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:71

`Protected` opts

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

@@ -166,7 +167,7 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:94

`Private` port

port: MessagePort

@@ -174,7 +175,7 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/thread-worker.ts:33

`Protected` statistics

statistics: WorkerStatistics

@@ -183,7 +184,7 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:75

`Protected` taskFunctions

taskFunctions: Map<string, TaskFunction<Data, Response>>

@@ -192,7 +193,7 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:67

Accessors

@@ -206,13 +207,13 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/thread-worker.ts:84

Methods

addTaskFunction

addTaskFunction(name, fn): boolean
addTaskFunction(name, fn): TaskFunctionOperationResult
Adds a task function to the worker. If a task function with the same name already exists, it is replaced.
@@ -230,18 +231,12 @@ If a task function with the same name already exists, it is replaced.

The task function to add.

Returns boolean

Whether the task function was added or not.

Returns TaskFunctionOperationResult

Whether the task function was added or not.

Throws

https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

- -

Throws

https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.

- -

Throws

https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.

asyncId

Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:315

bind

Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:288

emitDestroy

Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:311

`Protected` handleTaskFunctionOperationMessage

handleTaskFunctionOperationMessage(message): void
+
+
Parameters
+
- +
  message: MessageValue<Data, unknown>
+
Returns void
+
Inherited from AbstractWorker.handleTaskFunctionOperationMessage
+
- Defined in src/worker/abstract-worker.ts:326

hasTaskFunction

hasTaskFunction(name): boolean
hasTaskFunction(name): TaskFunctionOperationResult
Checks if the worker has a task function with the given name.

@@ -387,27 +396,25 @@ never be called.

The name of the task function to check.

Returns boolean

Whether the worker has a task function with the given name or not.

Returns TaskFunctionOperationResult

Whether the worker has a task function with the given name or not.

Throws

https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

listTaskFunctions

Defined in src/worker/abstract-worker.ts:162

listTaskFunctionNames

listTaskFunctions(): string[]
listTaskFunctionNames(): string[]
Lists the names of the worker's task functions.

Returns string[]
The names of the worker's task functions.
-
Inherited from AbstractWorker.listTaskFunctions
+
Inherited from AbstractWorker.listTaskFunctionNames
- Defined in src/worker/abstract-worker.ts:255

Defined in src/worker/abstract-worker.ts:243

`Protected` messageListener

Defined in src/worker/abstract-worker.ts:306

removeTaskFunction

removeTaskFunction(name): boolean
removeTaskFunction(name): TaskFunctionOperationResult
Removes a task function from the worker.

@@ -443,18 +450,12 @@ never be called.

The name of the task function to remove.

Returns boolean

Whether the task function existed and was removed or not.

- -

Throws

https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

- -

Throws

https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.

Returns TaskFunctionOperationResult

Whether the task function existed and was removed or not.

Throws

https://nodejs.org/api/errors.html#class-error If the name parameter is the task function used as default task function.

Defined in src/worker/abstract-worker.ts:214

`Protected` run

Returns void

Throws

https://nodejs.org/api/errors.html#class-error If the task function is not found.

Defined in src/worker/abstract-worker.ts:494

`Protected` runAsync

Defined in src/worker/abstract-worker.ts:555

runInAsyncScope

Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:299

`Protected` runSync

`Protected` sendTaskFunctionsListToMainWorker

Defined in src/worker/abstract-worker.ts:521

`Protected` sendTaskFunctionNamesToMainWorker

sendTaskFunctionsListToMainWorker(): void
sendTaskFunctionNamesToMainWorker(): void
-
Sends the list of task function names to the main worker.
+
Sends task function names to the main worker.

Returns void
-
Inherited from AbstractWorker.sendTaskFunctionsListToMainWorker
+
Inherited from AbstractWorker.sendTaskFunctionNamesToMainWorker
- Defined in src/worker/abstract-worker.ts:453

Defined in src/worker/abstract-worker.ts:473

`Protected` sendToMainWorker

Defined in src/worker/thread-worker.ts:89

setDefaultTaskFunction

setDefaultTaskFunction(name): boolean
setDefaultTaskFunction(name): TaskFunctionOperationResult
Sets the default task function to use in the worker.

@@ -629,18 +628,12 @@ then restore the original execution context.

The name of the task function to use as default task function.

Returns boolean

Whether the default task function was set or not.

- -

Throws

https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

Returns TaskFunctionOperationResult

Whether the default task function was set or not.

Throws

https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.

- -

Throws

https://nodejs.org/api/errors.html#class-error If the name parameter is a non-existing task function.

Defined in src/worker/abstract-worker.ts:270

triggerAsyncId

Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:319

`Static` bind

Defined in node_modules/.pnpm/@types+node@20.6.5/node_modules/@types/node/async_hooks.d.ts:278

Generated using TypeDoc