Readonly
Protected
Id of the next message.
Path to the worker-file.
The promise map.
The promise response map.
key
value
When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message.
Worker choice strategy instance implementing the worker choice algorithm.
Default to a strategy implementing a round robin algorithm.
Worker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
Private
Number of tasks concurrently running in the pool.
Hook executed after the worker task promise resolution. Can be overridden.
The received message.
The worker.
The Promise response.
Hook executed before the worker task promise resolution. Can be overridden.
The worker key.
Chooses a worker for the next task.
The default implementation uses a round robin algorithm to distribute the load.
The default uses a round robin algorithm to distribute the load.
Worker.
[worker key, worker].
Setup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.
Id of the next message.
+Path to the worker-file.
-Readonlynumber
-Readonlyopts
-ProtectedpromiseThe promise map.
+
+ProtectedpromiseThe promise response map.
-
-key: This is the message Id of each submitted task.value: An object that contains the worker, the resolve function and the reject function.key: The message id of each submitted task.value: An object that contains the worker, the promise resolve and reject callbacks.When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
+When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message.
ProtectedworkerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
+Worker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
-ReadonlyworkersInherit Doc
-ReadonlyworkersInherit Doc
Accessors
Returns boolean
number
--- get numberOfRunningTasks(): number
+- Defined in src/pools/thread/fixed.ts:105
full
++- get full(): boolean
-
+
Inherit Doc
Returns boolean
+Privatenumber+- get numberOfRunningTasks(): number
+-
+
Number of tasks concurrently running in the pool.
+Returns number
type
@@ -240,13 +236,13 @@
Returns PoolType
Methods
-
+ProtectedafterProtectedafter-- after
+- after
-
- Defined in src/pools/abstract-pool.ts:164
- setup
-
+- Defined in src/pools/abstract-pool.ts:242
- Defined in src/pools/abstract-pool.ts:392
Hook executed after the worker task promise resolution. Can be overridden.
@@ -255,17 +251,17 @@ Can be overridden.Parameters
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:268
-
-- Defined in src/pools/thread/fixed.ts:85
+
+
+message: MessageValue<Response, unknown>
-The received message.
+worker: ThreadWorkerWithMessageChannel
+The worker.
promise: PromiseWorkerResponseWrapper<ThreadWorkerWithMessageChannel, Response>
-The Promise response.
+message: MessageValue<Response, unknown>
+The received message.
Returns void
Protectedafter@@ -281,11 +277,11 @@ Can be overridden.
Returns void
+ProtectedbeforeProtectedbefore-- before
+- before
-
- Defined in src/pools/abstract-pool.ts:257
+- Defined in src/pools/abstract-pool.ts:297
+- Defined in src/pools/abstract-pool.ts:363
+- Defined in src/pools/thread/fixed.ts:78
+- Defined in src/pools/abstract-pool.ts:220
+- Defined in src/pools/thread/fixed.ts:54
-
-
-
-
-
-- Defined in src/pools/abstract-pool.ts:204
+
+
-
-
-
-
-
-- Defined in src/pools/abstract-pool.ts:197
+
+
+- Defined in src/pools/abstract-pool.ts:189
+- Defined in src/pools/thread/fixed.ts:49
+- Defined in src/pools/thread/fixed.ts:70
+- Defined in src/pools/abstract-pool.ts:487
+- Defined in src/pools/thread/fixed.ts:62
Hook executed before the worker task promise resolution. Can be overridden.
@@ -294,27 +290,27 @@ Can be overridden.Parameters
-
-
+worker: ThreadWorkerWithMessageChannel
-The worker.
+workerKey: number
+The worker key.
Returns void
Protectedchoose-- choose
+- choose
-
Chooses a worker for the next task.
-The default implementation uses a round robin algorithm to distribute the load.
+The default uses a round robin algorithm to distribute the load.
-Returns
Worker.
+Returns
[worker key, worker].
Returns ThreadWorkerWithMessageChannel
Protectedcreate@@ -327,7 +323,7 @@ Can be overridden.
Returns ThreadWorkerWithMessageChannel
Protectedcreate@@ -338,7 +334,7 @@ Can be overridden.
Returns ThreadWorkerWithMessageChannel
destroy
@@ -349,7 +345,7 @@ Can be overridden.
Returns Promise<void>
destroy
@@ -365,7 +361,7 @@ Can be overridden.
Returns Promise<void>
execute
@@ -381,91 +377,27 @@ Can be overridden.
Returns Promise<Response>
find
--- find
--
-
-
-
Inherit Doc
Returns false | ThreadWorkerWithMessageChannel
get
--- get
--
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
Returns undefined | number
get
+find
-- get
+- find
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
Returns number
get
--- get
--
-
-
-
-
-
Inherit Doc
Parameters
---
-
worker: ThreadWorkerWithMessageChannel
Returns undefined | number
-Protectedinternal-- internal
--
-
-
-
Parameters
---
-
--
-
worker: ThreadWorkerWithMessageChannel
messageId: number
Returns Promise<Response>
+ProtectedinternalProtectedinternal-- internal
+- internal
-
Returns boolean
Protectedis@@ -476,7 +408,7 @@ Can be overridden.
Returns boolean
register
@@ -510,7 +442,7 @@ Can be overridden.
Returns void
Protectedremove@@ -528,7 +460,7 @@ Can be overridden.
Returns void
Protectedsend@@ -546,11 +478,11 @@ Can be overridden.
Returns void
set
-- set
+- set
-
@@ -558,23 +490,24 @@ Can be overridden.
-
-
Inherit Doc
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
Returns void
ProtectedsetupSetup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.
+to run code before workers are created in the abstract constructor. +Can be overriddenReturns void
Protectedworker@@ -602,7 +535,7 @@ to run code before workers are created in the abstract constructor.
Returns void
@@ -631,31 +564,26 @@ to run code before workers are created in the abstract constructor.constructor
emitter?
file
-next
number
opts
-promise
+promise
worker
workers
-workers
busy
-number
+full
+number
type
-after
+after
after
-before
+before
choose
create
create
destroy
destroy
execute
-find
-get
-get
-get
-internal
-internal
+find
+internal
is
register
remove