0.0.1
-Sets the worker tasks queue options in this pool.
The worker tasks queue options.
Sets the worker choice strategy in this pool.
The worker choice strategy.
Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsOptional workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
Sets the worker choice strategy options in this pool.
The worker choice strategy options.
Protected setupSetup hook to execute code before worker node are created in the abstract constructor. Can be overridden
@@ -595,35 +606,33 @@ Can be overriddenProtected workerThis function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
The listener function to execute when a message is received from a worker.
+This function is the listener registered for each worker message.
- -The listener function to execute when a message is received from a worker.
The listener function to execute when a message is received from a worker.
+Generated using TypeDoc
Type of data sent to the worker. This can only be serializable data.
@@ -38,13 +38,13 @@Hierarchy
-- AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>
+
- AbstractPool<ThreadWorkerWithMessageChannel, Data, Response>
- FixedThreadPool
-- DynamicThreadPool
@@ -57,9 +57,9 @@
emitter?
-file
busy
-full
-number
-
Properties
Accessors
Methods
@@ -84,7 +86,6 @@ destroyconstructor
-- new
+- new
-
+
Constructs a new poolifier fixed thread pool.
Type Parameters
-+-
-
@@ -123,55 +124,57 @@
-
-
Data = unknown
Path to an implementation of a
ThreadWorkerfile, which can be relative or absolute.opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
+opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
Options for this fixed thread pool.
Returns FixedThreadPool<Data, Response>
Properties
-OptionalReadonlyemitterEmitter on which events can be listened to.
Events that can currently be listened to:
'full': Emitted when the pool is dynamic and full.'busy': Emitted when the pool is busy.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.
-Readonlyfile
+ProtectedReadonlyfilePath to the worker file.
-Readonlynumber
+ProtectedReadonlynumberNumber of workers that this pool should manage.
-Readonlyopts
+ProtectedReadonlyoptsOptions for the pool.
-ProtectedpromiseThe execution response promise map.
key: The message id of each submitted task.
-ProtectedworkerWorker choice strategy context referencing a worker choice algorithm implementation.
Default to a round robin algorithm.
-ReadonlyworkerPool worker nodes.
Accessors
Returns boolean
-Protectedfull+- get full(): boolean
-
Whether the pool is full or not.
The pool filling boolean status.
Returns boolean
-Privatenumber-- get numberOfQueuedTasks(): number
+- Defined in src/pools/abstract-pool.ts:360
info
++- get info(): PoolInfo
+-
+
Pool information.
+Returns PoolInfo
+Protectedmax+- get maxSize(): number
-
-
-
+
+
+- Defined in src/pools/abstract-pool.ts:325
Number of tasks queued in the pool.
+Pool maximum size.
Returns number
-
-Privatenumber-- get numberOfRunningTasks(): number
+- Defined in src/pools/thread/fixed.ts:115
+Protectedmin+- get minSize(): number
-
-
-
+
+
+- Defined in src/pools/thread/fixed.ts:100
+
+
+- Defined in src/pools/abstract-pool.ts:464
+- Defined in src/pools/thread/fixed.ts:90
+- Defined in src/pools/thread/fixed.ts:59
Number of tasks running in the pool.
+Pool minimum size.
Returns number
-type
--- get type(): PoolType
+- Defined in src/pools/thread/fixed.ts:110
+Protectedtype+- get type(): "fixed" | "dynamic"
-
Pool type.
If it is
'dynamic', it provides themaxproperty.Returns PoolType
+Protectedworker+- get worker(): "cluster" | "thread"
+-
+
Gets the worker type.
+Returns "cluster" | "thread"
Methods
Protectedafter-- after
+- after
-
-
-
-
-
Hook executed after the worker task execution. Can be overridden.
@@ -273,21 +298,21 @@ Can be overridden.Parameters
worker: ThreadWorkerWithMessageChannel
+worker: ThreadWorkerWithMessageChannel
The worker.
message: MessageValue<Response, unknown>
+message: MessageValue<Response, Worker | MessagePort>
The received message.
Returns void
Protectedafter-- after
+- after
-
-
-
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
Can be used to update the
@@ -296,17 +321,17 @@ Can be overridden.maxListenersor binding themain-worker<->workerconnection if not bind by default.Parameters
worker: ThreadWorkerWithMessageChannel
+worker: ThreadWorkerWithMessageChannel
The newly created worker.
Returns void
Protectedbefore-- before
+- before
-
- Defined in src/pools/abstract-pool.ts:453
+- Defined in src/pools/abstract-pool.ts:532
+- Defined in src/pools/abstract-pool.ts:596
+- Defined in src/pools/thread/fixed.ts:83
+- Defined in src/pools/abstract-pool.ts:415
Hook executed before the worker task execution. Can be overridden.
@@ -321,60 +346,58 @@ Can be overridden.Returns void
+Protectedchoose-- choose
+- choose
-
Chooses a worker node for the next task.
-The default uses a round robin algorithm to distribute the load.
- -Returns
[worker node key, worker node].
+The default worker choice strategy uses a round robin algorithm to distribute the load.
Returns [number, WorkerNode<ThreadWorkerWithMessageChannel, Data>]
Protectedcreate-- create
+- create
-
Creates a new worker and sets it up completely in the pool worker nodes.
- -Returns
New, completely set up worker.
Returns ThreadWorkerWithMessageChannel
Protectedcreate-- create
+- create
-
Returns a newly created worker.
Returns ThreadWorkerWithMessageChannel
destroy
-- destroy(): Promise<void>
+- destroy(): Promise<void>
-
Shutdowns every current worker in this pool.
Returns Promise<void>
Protecteddestroy-- destroy
+- destroy
-
-
-
Shutdowns the given worker.
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: ThreadWorkerWithMessageChannel
A worker within
workerNodes.Returns Promise<void>
enable
-- enable
+- enable
-
-
-
Enables/disables the worker tasks queue in this pool.
Whether to enable or disable the worker tasks queue.
+OptionaltasksQueueOptions: TasksQueueOptionsOptionaltasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
Returns void
execute
-- execute(data?): Promise<Response>
+- execute(data?, name?): Promise<Response>
-
-
-
+-
+
-
+- Defined in src/pools/abstract-pool.ts:371
+- Defined in src/pools/thread/fixed.ts:54
Executes the function specified in the worker constructor with the task data input parameter.
- -Returns
Promise that will be fulfilled when the task is completed.
+Executes the specified function in the worker constructor with the task data input parameter.
Parameters
@@ -426,63 +447,53 @@ Can be overridden.Optionaldata: DataThe task input data for the specified worker function. This can only be serializable data.
+
+Optionalname: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
Returns Promise<Response>
Protectedinternal-- internal
+- internal
-
Returns boolean
Protectedis-- is
+- is
-
Should return whether the worker is the main worker or not.
Returns boolean
Protectedregister-- register
+- register
-
+
-
-
-
@@ -498,16 +509,16 @@ Can be overridden.
-
-
+
Registers a listener callback on the given worker.
Type Parameters
-+-
Message
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: ThreadWorkerWithMessageChannel
The worker which should register a listener.
Parameters
message: MessageValue<Message, unknown>
message: MessageValue<Message, Worker | MessagePort>
Returns void
Returns void
Protectedsend-- send
+- send
-
-
-
-
-
Sends a message to the given worker.
Parameters
worker: ThreadWorkerWithMessageChannel
+worker: ThreadWorkerWithMessageChannel
The worker which should receive the message.
message: MessageValue<Data, unknown>
+message: MessageValue<Data, Worker | MessagePort>
The message.