X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=f4d30b5b8789b1620e454f5dc2c9fa2007dfec3a;hb=36df5bd40369d98d6ccb60400e66dce1aa980d54;hp=47a53f506dc9615c5baccdbce6ff2e21cb00a6d8;hpb=030eb5a38e62c6e381961644eab2ddac9a027aea;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 47a53f50..f4d30b5b 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -
Generated using TypeDoc
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
@@ -152,7 +156,7 @@ +'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Protected
Readonly
fileProtected
Readonly
numberProtected
Readonly
optsProtected
promiseProtected
worker Nodes
-Readonly
workerPool worker nodes.
Accessors
Protected
full@@ -239,7 +243,7 @@
info
@@ -251,7 +255,7 @@
Protected
max@@ -263,7 +267,7 @@
Protected
min@@ -275,7 +279,16 @@
+Private
ready+- get ready(): boolean
+-
+
Returns boolean
Protected
type@@ -288,7 +301,20 @@
+Private
utilization+- get utilization(): number
+-
+
+
Gets the approximate pool utilization.
+Returns number
The pool utilization.
+ +Protected
worker@@ -300,7 +326,7 @@
Methods
Protected
after@@ -349,7 +375,7 @@ Can be overridden.
Protected
before@@ -375,7 +401,23 @@ Can be overridden.
Dynamic Pool Size
+Protected
check+- check
Dynamic Pool Size(min, max): void
+-
+
+
+
Parameters
++-
+
+-
+
min: number
max: number
Returns void
Protected
create@@ -388,7 +430,7 @@ Can be overridden.
Protected
create@@ -401,7 +443,7 @@ Can be overridden.
Protected
create@@ -414,19 +456,19 @@ Can be overridden.
destroy
Terminate every current worker in this pool.
+Terminates every current worker in this pool.
Returns Promise<void>
+Protected
destroy@@ -446,7 +488,7 @@ Can be overridden.
enable Tasks Queue
@@ -471,7 +513,7 @@ Can be overridden.
execute
@@ -497,7 +539,7 @@ Can be overridden.
Protected
internal@@ -510,7 +552,7 @@ Can be overridden.
Protected
is@@ -522,7 +564,7 @@ Can be overridden.
Protected
send@@ -547,7 +589,7 @@ Can be overridden.
set Tasks Queue Options
@@ -567,7 +609,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -592,7 +634,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -612,7 +654,7 @@ Can be overridden.
Protected
setup@@ -625,7 +667,7 @@ Can be overridden.
Protected
worker@@ -653,7 +695,7 @@ Can be overridden.