ThreadWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=bd7cbabcbb4aeba6822b9c90262425cdc956602c;hb=ef9f489c870680b9a754ab8e5b142b3f042a9ebb;hp=1c1dfc5e34279b51494913709759cf25ee587abb;hpb=85c03385d4a5d06c979104ae7e96d68b2301d10a;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 1c1dfc5e..bd7cbabc 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier - v2.6.11

+ThreadWorker | poolifier - v2.6.12

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

ThreadWorker

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

@@ -73,16 +73,21 @@ but the minimum number of workers will be guaranteed.

Methods

asyncId +

addTaskFunction +asyncId bind emitDestroy getMainWorker handleError +hasTaskFunction messageListener +removeTaskFunction +run runAsync runInAsyncScope runSync sendToMainWorker +setDefaultTaskFunction triggerAsyncId workerReady bind @@ -120,7 +125,7 @@ but the minimum number of workers will be guaranteed.

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

Properties

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

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

`Protected` `Readonly` isMain

isMain: boolean

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

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

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

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

`Protected` `Readonly` mainWorker

mainWorker: MessagePort

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

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

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

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

`Protected` statistics

statistics: WorkerStatistics

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

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

`Protected` taskFunctions

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

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

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

Accessors

@@ -199,9 +204,42 @@ but the minimum number of workers will be guaranteed.

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

Methods

addTaskFunction

addTaskFunction(name, fn): boolean
+
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: WorkerFunction<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 name parameter is not a 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.
+
+
Inherited from AbstractWorker.addTaskFunction
+
- Defined in src/worker/abstract-worker.ts:172

asyncId

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

`Protected` handleError

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

hasTaskFunction

hasTaskFunction(name): boolean
+
Checks if the worker has a task function with the given name.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function to check.
  +
  +
+
Returns boolean
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.
+
+
Inherited from AbstractWorker.hasTaskFunction
+
- Defined in src/worker/abstract-worker.ts:154

`Protected` messageListener

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

removeTaskFunction

removeTaskFunction(name): boolean
+
Removes a task function from the worker.
+
+
+
Parameters
+
- +
  name: string
  +
  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.
+ +
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 the task function used as default task function.
+
+
Inherited from AbstractWorker.removeTaskFunction
+
- Defined in src/worker/abstract-worker.ts:210

`Protected` run

run(task): void
+
Runs the given task.
+
+
+
Parameters
+
- +
  task: Task<Data>
  +
  The task to execute.
  +
  +
+
Returns void
+
+
Throws
https://nodejs.org/api/errors.html#class-error If the task function is not found.
+
+
Inherited from AbstractWorker.run
+
- Defined in src/worker/abstract-worker.ts:368

`Protected` runAsync

runAsync(fn, message): void
runAsync(fn, task): void
Runs the given function asynchronously.

@@ -322,19 +432,19 @@ never be called.
- fn: WorkerAsyncFunction<Data, Response>
  -
  Function that will be executed.
  +
  Task function that will be executed.
- -
  message: MessageValue<Data, unknown>
  -
  Input data for the given function.
  +
  task: Task<Data>
  +
  Input data for the task function.

Returns void

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

runInAsyncScope

`Protected` runSync

runSync(fn, message): void
runSync(fn, task): void
Runs the given function synchronously.

@@ -402,19 +512,19 @@ then restore the original execution context.
- fn: WorkerSyncFunction<Data, Response>
  -
  Function that will be executed.
  +
  Task function that will be executed.
- -
  message: MessageValue<Data, unknown>
  -
  Input data for the given function.
  +
  task: Task<Data>
  +
  Input data for the task function.
Returns void
Inherited from AbstractWorker.runSync
- Defined in src/worker/abstract-worker.ts:251

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

`Protected` sendToMainWorker

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

setDefaultTaskFunction

setDefaultTaskFunction(name): boolean
+
Sets the default task function to use when no task function name is specified.
+
+
+
Parameters
+
- +
  name: string
  +
  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.
+ +
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.
+
+
Inherited from AbstractWorker.setDefaultTaskFunction
+
- Defined in src/worker/abstract-worker.ts:238

triggerAsyncId

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

`Static` bind

statistics
taskFunctions
id
addTaskFunction
asyncId
bind
emitDestroy
getMainWorker
handleError
hasTaskFunction
messageListener
removeTaskFunction
run
runAsync
runInAsyncScope
runSync
sendToMainWorker
setDefaultTaskFunction
triggerAsyncId
workerReady
bind

name: string

fn: WorkerFunction<Data, Response>

task: Task<Data>