1 <!DOCTYPE html
><html class=
"default" lang=
"en"><head><meta charSet=
"utf-8"/><meta http-equiv=
"x-ua-compatible" content=
"IE=edge"/><title>AbstractPool | poolifier - v3.1
.21</title><meta name=
"description" content=
"Documentation for poolifier"/><meta name=
"viewport" content=
"width=device-width, initial-scale=1"/><link rel=
"stylesheet" href=
"../assets/style.css"/><link rel=
"stylesheet" href=
"../assets/highlight.css"/><script defer
src=
"../assets/main.js"></script><script async
src=
"../assets/icons.js" id=
"tsd-icons-script"></script><script async
src=
"../assets/search.js" id=
"tsd-search-script"></script><script async
src=
"../assets/navigation.js" id=
"tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem(
"tsd-theme") ||
"os";document.body.style.
display=
"none";setTimeout(() =
> document.body.style.removeProperty(
"display"),
500)
</script><header class=
"tsd-page-toolbar"><div class=
"tsd-toolbar-contents container"><div class=
"table-cell" id=
"tsd-search" data-base=
".."><div class=
"field"><label for=
"tsd-search-field" class=
"tsd-widget tsd-toolbar-icon search no-caption"><svg width=
"16" height=
"16" viewBox=
"0 0 16 16" fill=
"none"><use href=
"../assets/icons.svg#icon-search"></use></svg></label><input type=
"text" id=
"tsd-search-field" aria-label=
"Search"/></div><div class=
"field"><div id=
"tsd-toolbar-links"></div></div><ul class=
"results"><li class=
"state loading">Preparing search index...
</li><li class=
"state failure">The search index is not available
</li></ul><a href=
"../index.html" class=
"title">poolifier - v3.1
.21</a></div><div class=
"table-cell" id=
"tsd-widgets"><a href=
"#" class=
"tsd-widget tsd-toolbar-icon menu no-caption" data-toggle=
"menu" aria-label=
"Menu"><svg width=
"16" height=
"16" viewBox=
"0 0 16 16" fill=
"none"><use href=
"../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class=
"container container-main"><div class=
"col-content"><div class=
"tsd-page-title"><ul class=
"tsd-breadcrumb"><li><a href=
"../index.html">poolifier
</a></li><li><a href=
"AbstractPool.html">AbstractPool
</a></li></ul><h1>Class AbstractPool
<Worker, Data, Response
><code class=
"tsd-tag ts-flagAbstract">Abstract
</code> </h1></div><section class=
"tsd-panel tsd-comment"><div class=
"tsd-comment tsd-typography"><p>Base class that implements some shared logic for all poolifier pools.
</p>
2 </div><div class=
"tsd-comment tsd-typography"></div></section> <section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"Worker" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">Worker
</span><span class=
"tsd-signature-keyword"> extends
</span><a href=
"../interfaces/IWorker.html" class=
"tsd-signature-type tsd-kind-interface">IWorker
</a></span><div class=
"tsd-comment tsd-typography"><p>Type of worker which manages this pool.
</p>
3 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><a id=
"Data" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">Data
</span> =
<span class=
"tsd-signature-type">unknown
</span></span><div class=
"tsd-comment tsd-typography"><p>Type of data sent to the worker. This can only be structured-cloneable data.
</p>
4 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><a id=
"Response" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">Response
</span> =
<span class=
"tsd-signature-type">unknown
</span></span><div class=
"tsd-comment tsd-typography"><p>Type of execution response. This can only be structured-cloneable data.
</p>
5 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></section> <section class=
"tsd-panel tsd-hierarchy"><h4>Hierarchy (
<a class=
"link" href=
"../hierarchy.html#AbstractPool">view full
</a>)
</h4><ul class=
"tsd-hierarchy"><li><span class=
"target">AbstractPool
</span><ul class=
"tsd-hierarchy"><li><a href=
"FixedClusterPool.html" class=
"tsd-signature-type tsd-kind-class">FixedClusterPool
</a></li><li><a href=
"FixedThreadPool.html" class=
"tsd-signature-type tsd-kind-class">FixedThreadPool
</a></li></ul></li></ul></section><section class=
"tsd-panel"><h4>Implements
</h4><ul class=
"tsd-hierarchy"><li><a href=
"../interfaces/IPool.html" class=
"tsd-signature-type tsd-kind-interface">IPool
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">></span></li></ul></section><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L70">src/pools/abstract-pool.ts:
70</a></li></ul></aside><section class=
"tsd-panel-group tsd-index-group"><section class=
"tsd-panel tsd-index-panel"><details class=
"tsd-index-content tsd-index-accordion" open
><summary class=
"tsd-accordion-summary tsd-index-summary"><h5 class=
"tsd-index-heading uppercase" role=
"button" aria-expanded=
"false" tabIndex=
"0"><svg width=
"16" height=
"16" viewBox=
"0 0 16 16" fill=
"none"><use href=
"../assets/icons.svg#icon-chevronSmall"></use></svg> Index
</h5></summary><div class=
"tsd-accordion-details"><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Constructors
</h3><div class=
"tsd-index-list"><a href=
"AbstractPool.html#constructor" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-512"></use></svg><span>constructor
</span></a>
6 </div></section><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Properties
</h3><div class=
"tsd-index-list"><a href=
"AbstractPool.html#destroying" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>destroying
</span></a>
7 <a href=
"AbstractPool.html#emitter" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>emitter?
</span></a>
8 <a href=
"AbstractPool.html#filePath" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>file
<wbr/>Path
</span></a>
9 <a href=
"AbstractPool.html#maximumNumberOfWorkers" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>maximum
<wbr/>Number
<wbr/>Of
<wbr/>Workers?
</span></a>
10 <a href=
"AbstractPool.html#minimumNumberOfWorkers" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>minimum
<wbr/>Number
<wbr/>Of
<wbr/>Workers
</span></a>
11 <a href=
"AbstractPool.html#opts" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>opts
</span></a>
12 <a href=
"AbstractPool.html#promiseResponseMap" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>promise
<wbr/>Response
<wbr/>Map
</span></a>
13 <a href=
"AbstractPool.html#readyEventEmitted" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>ready
<wbr/>Event
<wbr/>Emitted
</span></a>
14 <a href=
"AbstractPool.html#startTimestamp" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>start
<wbr/>Timestamp
</span></a>
15 <a href=
"AbstractPool.html#started" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>started
</span></a>
16 <a href=
"AbstractPool.html#starting" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>starting
</span></a>
17 <a href=
"AbstractPool.html#taskFunctions" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>task
<wbr/>Functions
</span></a>
18 <a href=
"AbstractPool.html#workerChoiceStrategyContext" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Context?
</span></a>
19 <a href=
"AbstractPool.html#workerNodes" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>worker
<wbr/>Nodes
</span></a>
20 </div></section><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Accessors
</h3><div class=
"tsd-index-list"><a href=
"AbstractPool.html#busy" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>busy
</span></a>
21 <a href=
"AbstractPool.html#empty" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>empty
</span></a>
22 <a href=
"AbstractPool.html#full" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>full
</span></a>
23 <a href=
"AbstractPool.html#info" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>info
</span></a>
24 <a href=
"AbstractPool.html#ready" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>ready
</span></a>
25 <a href=
"AbstractPool.html#type" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>type
</span></a>
26 <a href=
"AbstractPool.html#utilization" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>utilization
</span></a>
27 <a href=
"AbstractPool.html#worker-2" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>worker
</span></a>
28 </div></section><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Methods
</h3><div class=
"tsd-index-list"><a href=
"AbstractPool.html#addTaskFunction" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>add
<wbr/>Task
<wbr/>Function
</span></a>
29 <a href=
"AbstractPool.html#addWorkerNode" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>add
<wbr/>Worker
<wbr/>Node
</span></a>
30 <a href=
"AbstractPool.html#afterTaskExecutionHook" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>after
<wbr/>Task
<wbr/>Execution
<wbr/>Hook
</span></a>
31 <a href=
"AbstractPool.html#afterWorkerNodeSetup" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>after
<wbr/>Worker
<wbr/>Node
<wbr/>Setup
</span></a>
32 <a href=
"AbstractPool.html#beforeTaskExecutionHook" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>before
<wbr/>Task
<wbr/>Execution
<wbr/>Hook
</span></a>
33 <a href=
"AbstractPool.html#buildTasksQueueOptions" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>build
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span></a>
34 <a href=
"AbstractPool.html#cannotStealTask" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>cannot
<wbr/>Steal
<wbr/>Task
</span></a>
35 <a href=
"AbstractPool.html#checkAndEmitDynamicWorkerCreationEvents" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>And
<wbr/>Emit
<wbr/>Dynamic
<wbr/>Worker
<wbr/>Creation
<wbr/>Events
</span></a>
36 <a href=
"AbstractPool.html#checkAndEmitEmptyEvent" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>And
<wbr/>Emit
<wbr/>Empty
<wbr/>Event
</span></a>
37 <a href=
"AbstractPool.html#checkAndEmitReadyEvent" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>And
<wbr/>Emit
<wbr/>Ready
<wbr/>Event
</span></a>
38 <a href=
"AbstractPool.html#checkAndEmitTaskExecutionEvents" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>And
<wbr/>Emit
<wbr/>Task
<wbr/>Execution
<wbr/>Events
</span></a>
39 <a href=
"AbstractPool.html#checkAndEmitTaskQueuingEvents" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>And
<wbr/>Emit
<wbr/>Task
<wbr/>Queuing
<wbr/>Events
</span></a>
40 <a href=
"AbstractPool.html#checkMessageWorkerId" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Message
<wbr/>Worker
<wbr/>Id
</span></a>
41 <a href=
"AbstractPool.html#checkMinimumNumberOfWorkers" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Minimum
<wbr/>Number
<wbr/>Of
<wbr/>Workers
</span></a>
42 <a href=
"AbstractPool.html#checkPoolOptions" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Pool
<wbr/>Options
</span></a>
43 <a href=
"AbstractPool.html#checkPoolType" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Pool
<wbr/>Type
</span></a>
44 <a href=
"AbstractPool.html#checkValidWorkerChoiceStrategyOptions" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Valid
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span></a>
45 <a href=
"AbstractPool.html#chooseWorkerNode" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>choose
<wbr/>Worker
<wbr/>Node
</span></a>
46 <a href=
"AbstractPool.html#createAndSetupDynamicWorkerNode" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>create
<wbr/>And
<wbr/>Setup
<wbr/>Dynamic
<wbr/>Worker
<wbr/>Node
</span></a>
47 <a href=
"AbstractPool.html#createAndSetupWorkerNode" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>create
<wbr/>And
<wbr/>Setup
<wbr/>Worker
<wbr/>Node
</span></a>
48 <a href=
"AbstractPool.html#createWorkerNode" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>create
<wbr/>Worker
<wbr/>Node
</span></a>
49 <a href=
"AbstractPool.html#deleteTaskFunctionWorkerUsages" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>delete
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usages
</span></a>
50 <a href=
"AbstractPool.html#dequeueTask" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>dequeue
<wbr/>Task
</span></a>
51 <a href=
"AbstractPool.html#deregisterWorkerMessageListener" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>deregister
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span></a>
52 <a href=
"AbstractPool.html#destroy" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>destroy
</span></a>
53 <a href=
"AbstractPool.html#destroyWorkerNode" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>destroy
<wbr/>Worker
<wbr/>Node
</span></a>
54 <a href=
"AbstractPool.html#enableTasksQueue" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>enable
<wbr/>Tasks
<wbr/>Queue
</span></a>
55 <a href=
"AbstractPool.html#enqueueTask" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>enqueue
<wbr/>Task
</span></a>
56 <a href=
"AbstractPool.html#execute" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>execute
</span></a>
57 <a href=
"AbstractPool.html#executeTask" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>execute
<wbr/>Task
</span></a>
58 <a href=
"AbstractPool.html#flagWorkerNodeAsNotReady" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>flag
<wbr/>Worker
<wbr/>Node
<wbr/>As
<wbr/>Not
<wbr/>Ready
</span></a>
59 <a href=
"AbstractPool.html#flushTasksQueue" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>flush
<wbr/>Tasks
<wbr/>Queue
</span></a>
60 <a href=
"AbstractPool.html#flushTasksQueues" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>flush
<wbr/>Tasks
<wbr/>Queues
</span></a>
61 <a href=
"AbstractPool.html#getWorkerInfo" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>get
<wbr/>Worker
<wbr/>Info
</span></a>
62 <a href=
"AbstractPool.html#getWorkerNodeKeyByWorkerId" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>get
<wbr/>Worker
<wbr/>Node
<wbr/>Key
<wbr/>By
<wbr/>Worker
<wbr/>Id
</span></a>
63 <a href=
"AbstractPool.html#handleTask" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>handle
<wbr/>Task
</span></a>
64 <a href=
"AbstractPool.html#handleTaskExecutionResponse" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>handle
<wbr/>Task
<wbr/>Execution
<wbr/>Response
</span></a>
65 <a href=
"AbstractPool.html#handleWorkerNodeBackPressureEvent" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>handle
<wbr/>Worker
<wbr/>Node
<wbr/>Back
<wbr/>Pressure
<wbr/>Event
</span></a>
66 <a href=
"AbstractPool.html#handleWorkerNodeIdleEvent" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>handle
<wbr/>Worker
<wbr/>Node
<wbr/>Idle
<wbr/>Event
</span></a>
67 <a href=
"AbstractPool.html#handleWorkerReadyResponse" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>handle
<wbr/>Worker
<wbr/>Ready
<wbr/>Response
</span></a>
68 <a href=
"AbstractPool.html#hasBackPressure" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>has
<wbr/>Back
<wbr/>Pressure
</span></a>
69 <a href=
"AbstractPool.html#hasTaskFunction" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>has
<wbr/>Task
<wbr/>Function
</span></a>
70 <a href=
"AbstractPool.html#initializeEventEmitter" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>initialize
<wbr/>Event
<wbr/>Emitter
</span></a>
71 <a href=
"AbstractPool.html#internalBusy" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>internal
<wbr/>Busy
</span></a>
72 <a href=
"AbstractPool.html#isMain" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>is
<wbr/>Main
</span></a>
73 <a href=
"AbstractPool.html#isWorkerNodeBusy" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>is
<wbr/>Worker
<wbr/>Node
<wbr/>Busy
</span></a>
74 <a href=
"AbstractPool.html#listTaskFunctionNames" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>list
<wbr/>Task
<wbr/>Function
<wbr/>Names
</span></a>
75 <a href=
"AbstractPool.html#redistributeQueuedTasks" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>redistribute
<wbr/>Queued
<wbr/>Tasks
</span></a>
76 <a href=
"AbstractPool.html#registerOnceWorkerMessageListener" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>register
<wbr/>Once
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span></a>
77 <a href=
"AbstractPool.html#registerWorkerMessageListener" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>register
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span></a>
78 <a href=
"AbstractPool.html#removeTaskFunction" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>remove
<wbr/>Task
<wbr/>Function
</span></a>
79 <a href=
"AbstractPool.html#removeWorkerNode" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>remove
<wbr/>Worker
<wbr/>Node
</span></a>
80 <a href=
"AbstractPool.html#resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>reset
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usage
</span></a>
81 <a href=
"AbstractPool.html#resetTaskSequentiallyStolenStatisticsWorkerUsage" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>reset
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Worker
<wbr/>Usage
</span></a>
82 <a href=
"AbstractPool.html#sendKillMessageToWorker" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>send
<wbr/>Kill
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span></a>
83 <a href=
"AbstractPool.html#sendStartupMessageToWorker" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>send
<wbr/>Startup
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span></a>
84 <a href=
"AbstractPool.html#sendStatisticsMessageToWorker" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>send
<wbr/>Statistics
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span></a>
85 <a href=
"AbstractPool.html#sendTaskFunctionOperationToWorker" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>send
<wbr/>Task
<wbr/>Function
<wbr/>Operation
<wbr/>To
<wbr/>Worker
</span></a>
86 <a href=
"AbstractPool.html#sendTaskFunctionOperationToWorkers" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>send
<wbr/>Task
<wbr/>Function
<wbr/>Operation
<wbr/>To
<wbr/>Workers
</span></a>
87 <a href=
"AbstractPool.html#sendToWorker" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>send
<wbr/>To
<wbr/>Worker
</span></a>
88 <a href=
"AbstractPool.html#setDefaultTaskFunction" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Default
<wbr/>Task
<wbr/>Function
</span></a>
89 <a href=
"AbstractPool.html#setTaskStealing" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Task
<wbr/>Stealing
</span></a>
90 <a href=
"AbstractPool.html#setTasksQueueOptions" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span></a>
91 <a href=
"AbstractPool.html#setTasksQueueSize" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Size
</span></a>
92 <a href=
"AbstractPool.html#setTasksStealingOnBackPressure" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Tasks
<wbr/>Stealing
<wbr/>On
<wbr/>Back
<wbr/>Pressure
</span></a>
93 <a href=
"AbstractPool.html#setWorkerChoiceStrategy" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
</span></a>
94 <a href=
"AbstractPool.html#setWorkerChoiceStrategyOptions" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span></a>
95 <a href=
"AbstractPool.html#setupHook" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>setup
<wbr/>Hook
</span></a>
96 <a href=
"AbstractPool.html#shallCreateDynamicWorker" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>shall
<wbr/>Create
<wbr/>Dynamic
<wbr/>Worker
</span></a>
97 <a href=
"AbstractPool.html#shallExecuteTask" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>shall
<wbr/>Execute
<wbr/>Task
</span></a>
98 <a href=
"AbstractPool.html#shallUpdateTaskFunctionWorkerUsage" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>shall
<wbr/>Update
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usage
</span></a>
99 <a href=
"AbstractPool.html#start" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>start
</span></a>
100 <a href=
"AbstractPool.html#tasksQueueSize" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>tasks
<wbr/>Queue
<wbr/>Size
</span></a>
101 <a href=
"AbstractPool.html#unsetTaskStealing" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>unset
<wbr/>Task
<wbr/>Stealing
</span></a>
102 <a href=
"AbstractPool.html#unsetTasksStealingOnBackPressure" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>unset
<wbr/>Tasks
<wbr/>Stealing
<wbr/>On
<wbr/>Back
<wbr/>Pressure
</span></a>
103 <a href=
"AbstractPool.html#updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>update
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usage
</span></a>
104 <a href=
"AbstractPool.html#updateTaskSequentiallyStolenStatisticsWorkerUsage" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>update
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Worker
<wbr/>Usage
</span></a>
105 <a href=
"AbstractPool.html#updateTaskStolenStatisticsWorkerUsage" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>update
<wbr/>Task
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Worker
<wbr/>Usage
</span></a>
106 <a href=
"AbstractPool.html#workerMessageListener" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>worker
<wbr/>Message
<wbr/>Listener
</span></a>
107 <a href=
"AbstractPool.html#workerNodeStealTask" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>worker
<wbr/>Node
<wbr/>Steal
<wbr/>Task
</span></a>
108 </div></section></div></details></section></section><section class=
"tsd-panel-group tsd-member-group"><h2>Constructors
</h2><section class=
"tsd-panel tsd-member"><a id=
"constructor" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>constructor
</span><a href=
"#constructor" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"constructor.new_AbstractPool" class=
"tsd-anchor"></a><span class=
"tsd-kind-constructor-signature">new
<wbr/>Abstract
<wbr/>Pool
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">minimumNumberOfWorkers
</span>,
<span class=
"tsd-kind-parameter">filePath
</span>,
<span class=
"tsd-kind-parameter">opts
</span>,
<span class=
"tsd-kind-parameter">maximumNumberOfWorkers
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><a href=
"AbstractPool.html" class=
"tsd-signature-type tsd-kind-class">AbstractPool
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">></span><a href=
"#constructor.new_AbstractPool" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Constructs a new poolifier pool.
</p>
109 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"constructor.new_AbstractPool.Worker-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">Worker
</span><span class=
"tsd-signature-keyword"> extends
</span><a href=
"../interfaces/IWorker.html" class=
"tsd-signature-type tsd-kind-interface">IWorker
</a></span></li><li><span><a id=
"constructor.new_AbstractPool.Data-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">Data
</span> =
<span class=
"tsd-signature-type">unknown
</span></span></li><li><span><a id=
"constructor.new_AbstractPool.Response-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">Response
</span> =
<span class=
"tsd-signature-type">unknown
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">minimumNumberOfWorkers
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>Minimum number of workers that this pool manages.
</p>
110 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><span class=
"tsd-kind-parameter">filePath
</span>:
<span class=
"tsd-signature-type">string
</span></span><div class=
"tsd-comment tsd-typography"><p>Path to the worker file.
</p>
111 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><span class=
"tsd-kind-parameter">opts
</span>:
<a href=
"../interfaces/PoolOptions.html" class=
"tsd-signature-type tsd-kind-interface">PoolOptions
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>Options for the pool.
</p>
112 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">maximumNumberOfWorkers
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>Maximum number of workers that this pool manages.
</p>
113 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a href=
"AbstractPool.html" class=
"tsd-signature-type tsd-kind-class">AbstractPool
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L136">src/pools/abstract-pool.ts:
136</a></li></ul></aside></li></ul></section></section><section class=
"tsd-panel-group tsd-member-group"><h2>Properties
</h2><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"destroying" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>destroying
</span><a href=
"#destroying" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">destroying
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">boolean
</span></div><div class=
"tsd-comment tsd-typography"><p>Whether the pool is destroying or not.
</p>
114 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L118">src/pools/abstract-pool.ts:
118</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"emitter" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span>emitter
</span><a href=
"#emitter" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">emitter
</span><span class=
"tsd-signature-symbol">?:
</span> <span class=
"tsd-signature-type">EventEmitterAsyncResource
</span></div><div class=
"tsd-comment tsd-typography"><p>Event emitter integrated with async resource on which events can be listened to.
115 The async tracking tooling identifier is
<code>poolifier:
<PoolType
>-
<WorkerType
>-pool
</code>.
</p>
116 <p>Events that can currently be listened to:
</p>
118 <li><code>'ready
'</code>: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers is set to zero, this event is emitted when at least one dynamic worker is ready.
</li>
119 <li><code>'busy
'</code>: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
</li>
120 <li><code>'full
'</code>: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
</li>
121 <li><code>'empty
'</code>: Emitted when the pool is dynamic with a minimum number of workers set to zero and the number of workers has reached the minimum size expected.
</li>
122 <li><code>'destroy
'</code>: Emitted when the pool is destroyed.
</li>
123 <li><code>'error
'</code>: Emitted when an uncaught error occurs.
</li>
124 <li><code>'taskError
'</code>: Emitted when an error occurs while executing a task.
</li>
125 <li><code>'backPressure
'</code>: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size
>= maximum queue size).
</li>
127 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#emitter">emitter
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L79">src/pools/abstract-pool.ts:
79</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"filePath" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>file
<wbr/>Path
</span><a href=
"#filePath" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">file
<wbr/>Path
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">string
</span></div><div class=
"tsd-comment tsd-typography"><p>Path to the worker file.
</p>
128 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L138">src/pools/abstract-pool.ts:
138</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"maximumNumberOfWorkers" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagOptional">Optional
</code> <code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>maximum
<wbr/>Number
<wbr/>Of
<wbr/>Workers
</span><a href=
"#maximumNumberOfWorkers" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">maximum
<wbr/>Number
<wbr/>Of
<wbr/>Workers
</span><span class=
"tsd-signature-symbol">?:
</span> <span class=
"tsd-signature-type">number
</span></div><div class=
"tsd-comment tsd-typography"><p>Maximum number of workers that this pool manages.
</p>
129 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L140">src/pools/abstract-pool.ts:
140</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"minimumNumberOfWorkers" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>minimum
<wbr/>Number
<wbr/>Of
<wbr/>Workers
</span><a href=
"#minimumNumberOfWorkers" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">minimum
<wbr/>Number
<wbr/>Of
<wbr/>Workers
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">number
</span></div><div class=
"tsd-comment tsd-typography"><p>Minimum number of workers that this pool manages.
</p>
130 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L137">src/pools/abstract-pool.ts:
137</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"opts" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>opts
</span><a href=
"#opts" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">opts
</span><span class=
"tsd-signature-symbol">:
</span> <a href=
"../interfaces/PoolOptions.html" class=
"tsd-signature-type tsd-kind-interface">PoolOptions
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">></span></div><div class=
"tsd-comment tsd-typography"><p>Options for the pool.
</p>
131 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L139">src/pools/abstract-pool.ts:
139</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"promiseResponseMap" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>promise
<wbr/>Response
<wbr/>Map
</span><a href=
"#promiseResponseMap" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">promise
<wbr/>Response
<wbr/>Map
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">Map
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">string
</span><span class=
"tsd-signature-symbol">,
</span><a href=
"../interfaces/PromiseResponseWrapper.html" class=
"tsd-signature-type tsd-kind-interface">PromiseResponseWrapper
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol"> = ...
</span></div><div class=
"tsd-comment tsd-typography"><p>The task execution response promise map:
</p>
133 <li><code>key
</code>: The message id of each submitted task.
</li>
134 <li><code>value
</code>: An object that contains the worker, the execution response promise resolve and reject callbacks.
</li>
136 <p>When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
</p>
137 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L88">src/pools/abstract-pool.ts:
88</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"readyEventEmitted" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>ready
<wbr/>Event
<wbr/>Emitted
</span><a href=
"#readyEventEmitted" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">ready
<wbr/>Event
<wbr/>Emitted
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">boolean
</span></div><div class=
"tsd-comment tsd-typography"><p>Whether the pool ready event has been emitted or not.
</p>
138 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L122">src/pools/abstract-pool.ts:
122</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"startTimestamp" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>start
<wbr/>Timestamp
</span><a href=
"#startTimestamp" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">start
<wbr/>Timestamp
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">number
</span></div><div class=
"tsd-comment tsd-typography"><p>The start timestamp of the pool.
</p>
139 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L126">src/pools/abstract-pool.ts:
126</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"started" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>started
</span><a href=
"#started" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">started
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">boolean
</span></div><div class=
"tsd-comment tsd-typography"><p>Whether the pool is started or not.
</p>
140 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L110">src/pools/abstract-pool.ts:
110</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"starting" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>starting
</span><a href=
"#starting" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">starting
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">boolean
</span></div><div class=
"tsd-comment tsd-typography"><p>Whether the pool is starting or not.
</p>
141 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L114">src/pools/abstract-pool.ts:
114</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"taskFunctions" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>task
<wbr/>Functions
</span><a href=
"#taskFunctions" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">task
<wbr/>Functions
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">Map
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">string
</span><span class=
"tsd-signature-symbol">,
</span><a href=
"../types/TaskFunction.html" class=
"tsd-signature-type tsd-kind-type-alias">TaskFunction
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">></span></div><div class=
"tsd-comment tsd-typography"><p>The task functions added at runtime map:
</p>
143 <li><code>key
</code>: The task function name.
</li>
144 <li><code>value
</code>: The task function itself.
</li>
146 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L105">src/pools/abstract-pool.ts:
105</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"workerChoiceStrategyContext" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagOptional">Optional
</code> <span>worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Context
</span><a href=
"#workerChoiceStrategyContext" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Context
</span><span class=
"tsd-signature-symbol">?:
</span> <a href=
"WorkerChoiceStrategyContext.html" class=
"tsd-signature-type tsd-kind-class">WorkerChoiceStrategyContext
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">></span></div><div class=
"tsd-comment tsd-typography"><p>Worker choice strategy context referencing a worker choice algorithm implementation.
</p>
147 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L94">src/pools/abstract-pool.ts:
94</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"workerNodes" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <code class=
"tsd-tag ts-flagInternal">Internal
</code> <span>worker
<wbr/>Nodes
</span><a href=
"#workerNodes" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">worker
<wbr/>Nodes
</span><span class=
"tsd-signature-symbol">:
</span> <a href=
"../interfaces/IWorkerNode.html" class=
"tsd-signature-type tsd-kind-interface">IWorkerNode
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">[]
</span><span class=
"tsd-signature-symbol"> = []
</span></div><div class=
"tsd-comment tsd-typography"><p>Pool worker nodes.
</p>
148 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#workerNodes">workerNodes
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L76">src/pools/abstract-pool.ts:
76</a></li></ul></aside></section></section><section class=
"tsd-panel-group tsd-member-group"><h2>Accessors
</h2><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"busy" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagAbstract">Abstract
</code> <span>busy
</span><a href=
"#busy" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature" id=
"busy.busy-1"><span class=
"tsd-signature-keyword">get
</span> busy
<span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Whether the pool is busy or not.
</p>
149 <p>The pool busyness boolean status.
</p>
150 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L670">src/pools/abstract-pool.ts:
670</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"empty" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>empty
</span><a href=
"#empty" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature" id=
"empty.empty-1"><span class=
"tsd-signature-keyword">get
</span> empty
<span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>The pool emptiness boolean status.
</p>
151 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L464">src/pools/abstract-pool.ts:
464</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"full" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>full
</span><a href=
"#full" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature" id=
"full.full-1"><span class=
"tsd-signature-keyword">get
</span> full
<span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Whether the pool is full or not.
</p>
152 <p>The pool filling boolean status.
</p>
153 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L658">src/pools/abstract-pool.ts:
658</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"info" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>info
</span><a href=
"#info" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature" id=
"info.info-1"><span class=
"tsd-signature-keyword">get
</span> info
<span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><a href=
"../interfaces/PoolInfo.html" class=
"tsd-signature-type tsd-kind-interface">PoolInfo
</a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Pool information.
</p>
154 </div><h4 class=
"tsd-returns-title">Returns
<a href=
"../interfaces/PoolInfo.html" class=
"tsd-signature-type tsd-kind-interface">PoolInfo
</a></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#info">info
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L277">src/pools/abstract-pool.ts:
277</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"ready" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>ready
</span><a href=
"#ready" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature" id=
"ready.ready-1"><span class=
"tsd-signature-keyword">get
</span> ready
<span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>The pool readiness boolean status.
</p>
155 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L446">src/pools/abstract-pool.ts:
446</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"type" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagAbstract">Abstract
</code> <span>type
</span><a href=
"#type" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature" id=
"type.type-1"><span class=
"tsd-signature-keyword">get
</span> type
<span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">"fixed
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"dynamic
"</span></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>The pool type.
</p>
156 <p>If it is
<code>'dynamic
'</code>, it provides the
<code>max
</code> property.
</p>
157 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">"fixed
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"dynamic
"</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L495">src/pools/abstract-pool.ts:
495</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"utilization" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>utilization
</span><a href=
"#utilization" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature" id=
"utilization.utilization-1"><span class=
"tsd-signature-keyword">get
</span> utilization
<span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">number
</span></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>The approximate pool utilization.
</p>
158 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><p>The pool utilization.
</p>
159 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L473">src/pools/abstract-pool.ts:
473</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"worker-2" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagAbstract">Abstract
</code> <span>worker
</span><a href=
"#worker-2" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature" id=
"worker-2.worker-3"><span class=
"tsd-signature-keyword">get
</span> worker
<span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">"thread
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"cluster
"</span></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>The worker type.
</p>
160 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">"thread
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"cluster
"</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L500">src/pools/abstract-pool.ts:
500</a></li></ul></aside></li></ul></section></section><section class=
"tsd-panel-group tsd-member-group"><h2>Methods
</h2><section class=
"tsd-panel tsd-member"><a id=
"addTaskFunction" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>add
<wbr/>Task
<wbr/>Function
</span><a href=
"#addTaskFunction" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"addTaskFunction.addTaskFunction-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">add
<wbr/>Task
<wbr/>Function
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span>,
<span class=
"tsd-kind-parameter">fn
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span><a href=
"#addTaskFunction.addTaskFunction-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></span></li><li><span><span class=
"tsd-kind-parameter">fn
</span>:
<a href=
"../types/TaskFunction.html" class=
"tsd-signature-type tsd-kind-type-alias">TaskFunction
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#addTaskFunction">addTaskFunction
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L812">src/pools/abstract-pool.ts:
812</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"addWorkerNode" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>add
<wbr/>Worker
<wbr/>Node
</span><a href=
"#addWorkerNode" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"addWorkerNode.addWorkerNode-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">add
<wbr/>Worker
<wbr/>Node
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNode
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">number
</span><a href=
"#addWorkerNode.addWorkerNode-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Adds the given worker node in the pool worker nodes.
</p>
161 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNode
</span>:
<a href=
"../interfaces/IWorkerNode.html" class=
"tsd-signature-type tsd-kind-interface">IWorkerNode
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>The worker node.
</p>
162 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><p>The added worker node key.
</p>
163 <div class=
"tsd-comment tsd-typography"><h4>Throws
</h4><p><a href=
"https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error
</a> If the added worker node is not found.
</p>
164 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1860">src/pools/abstract-pool.ts:
1860</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"afterTaskExecutionHook" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>after
<wbr/>Task
<wbr/>Execution
<wbr/>Hook
</span><a href=
"#afterTaskExecutionHook" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"afterTaskExecutionHook.afterTaskExecutionHook-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">after
<wbr/>Task
<wbr/>Execution
<wbr/>Hook
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#afterTaskExecutionHook.afterTaskExecutionHook-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Hook executed after the worker task execution.
165 Can be overridden.
</p>
166 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
167 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><span class=
"tsd-kind-parameter">message
</span>:
<a href=
"../interfaces/MessageValue.html" class=
"tsd-signature-type tsd-kind-interface">MessageValue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>The received message.
</p>
168 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1111">src/pools/abstract-pool.ts:
1111</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"afterWorkerNodeSetup" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>after
<wbr/>Worker
<wbr/>Node
<wbr/>Setup
</span><a href=
"#afterWorkerNodeSetup" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"afterWorkerNodeSetup.afterWorkerNodeSetup-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">after
<wbr/>Worker
<wbr/>Node
<wbr/>Setup
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#afterWorkerNodeSetup.afterWorkerNodeSetup-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Method hooked up after a worker node has been newly created.
169 Can be overridden.
</p>
170 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The newly created worker node key.
</p>
171 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1378">src/pools/abstract-pool.ts:
1378</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"beforeTaskExecutionHook" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>before
<wbr/>Task
<wbr/>Execution
<wbr/>Hook
</span><a href=
"#beforeTaskExecutionHook" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"beforeTaskExecutionHook.beforeTaskExecutionHook-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">before
<wbr/>Task
<wbr/>Execution
<wbr/>Hook
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">task
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#beforeTaskExecutionHook.beforeTaskExecutionHook-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Hook executed before the worker task execution.
172 Can be overridden.
</p>
173 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
174 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><span class=
"tsd-kind-parameter">task
</span>:
<a href=
"../interfaces/Task.html" class=
"tsd-signature-type tsd-kind-interface">Task
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>The task to execute.
</p>
175 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1070">src/pools/abstract-pool.ts:
1070</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"buildTasksQueueOptions" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>build
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span><a href=
"#buildTasksQueueOptions" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"buildTasksQueueOptions.buildTasksQueueOptions-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">build
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">tasksQueueOptions
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><a href=
"../interfaces/TasksQueueOptions.html" class=
"tsd-signature-type tsd-kind-interface">TasksQueueOptions
</a><a href=
"#buildTasksQueueOptions.buildTasksQueueOptions-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">tasksQueueOptions
</span>:
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a href=
"../interfaces/TasksQueueOptions.html" class=
"tsd-signature-type tsd-kind-interface">TasksQueueOptions
</a></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a href=
"../interfaces/TasksQueueOptions.html" class=
"tsd-signature-type tsd-kind-interface">TasksQueueOptions
</a></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L603">src/pools/abstract-pool.ts:
603</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"cannotStealTask" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>cannot
<wbr/>Steal
<wbr/>Task
</span><a href=
"#cannotStealTask" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"cannotStealTask.cannotStealTask-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">cannot
<wbr/>Steal
<wbr/>Task
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span><a href=
"#cannotStealTask.cannotStealTask-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1429">src/pools/abstract-pool.ts:
1429</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"checkAndEmitDynamicWorkerCreationEvents" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagAbstract">Abstract
</code> <span>check
<wbr/>And
<wbr/>Emit
<wbr/>Dynamic
<wbr/>Worker
<wbr/>Creation
<wbr/>Events
</span><a href=
"#checkAndEmitDynamicWorkerCreationEvents" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"checkAndEmitDynamicWorkerCreationEvents.checkAndEmitDynamicWorkerCreationEvents-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">check
<wbr/>And
<wbr/>Emit
<wbr/>Dynamic
<wbr/>Worker
<wbr/>Creation
<wbr/>Events
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#checkAndEmitDynamicWorkerCreationEvents.checkAndEmitDynamicWorkerCreationEvents-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Emits dynamic worker creation events.
</p>
176 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1815">src/pools/abstract-pool.ts:
1815</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"checkAndEmitEmptyEvent" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>check
<wbr/>And
<wbr/>Emit
<wbr/>Empty
<wbr/>Event
</span><a href=
"#checkAndEmitEmptyEvent" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"checkAndEmitEmptyEvent.checkAndEmitEmptyEvent-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">check
<wbr/>And
<wbr/>Emit
<wbr/>Empty
<wbr/>Event
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#checkAndEmitEmptyEvent.checkAndEmitEmptyEvent-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1869">src/pools/abstract-pool.ts:
1869</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"checkAndEmitReadyEvent" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>check
<wbr/>And
<wbr/>Emit
<wbr/>Ready
<wbr/>Event
</span><a href=
"#checkAndEmitReadyEvent" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"checkAndEmitReadyEvent.checkAndEmitReadyEvent-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">check
<wbr/>And
<wbr/>Emit
<wbr/>Ready
<wbr/>Event
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#checkAndEmitReadyEvent.checkAndEmitReadyEvent-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1724">src/pools/abstract-pool.ts:
1724</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"checkAndEmitTaskExecutionEvents" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>check
<wbr/>And
<wbr/>Emit
<wbr/>Task
<wbr/>Execution
<wbr/>Events
</span><a href=
"#checkAndEmitTaskExecutionEvents" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"checkAndEmitTaskExecutionEvents.checkAndEmitTaskExecutionEvents-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">check
<wbr/>And
<wbr/>Emit
<wbr/>Task
<wbr/>Execution
<wbr/>Events
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#checkAndEmitTaskExecutionEvents.checkAndEmitTaskExecutionEvents-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1800">src/pools/abstract-pool.ts:
1800</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"checkAndEmitTaskQueuingEvents" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>check
<wbr/>And
<wbr/>Emit
<wbr/>Task
<wbr/>Queuing
<wbr/>Events
</span><a href=
"#checkAndEmitTaskQueuingEvents" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"checkAndEmitTaskQueuingEvents.checkAndEmitTaskQueuingEvents-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">check
<wbr/>And
<wbr/>Emit
<wbr/>Task
<wbr/>Queuing
<wbr/>Events
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#checkAndEmitTaskQueuingEvents.checkAndEmitTaskQueuingEvents-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1806">src/pools/abstract-pool.ts:
1806</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"checkMessageWorkerId" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>check
<wbr/>Message
<wbr/>Worker
<wbr/>Id
</span><a href=
"#checkMessageWorkerId" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"checkMessageWorkerId.checkMessageWorkerId-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">check
<wbr/>Message
<wbr/>Worker
<wbr/>Id
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#checkMessageWorkerId.checkMessageWorkerId-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Checks if the worker id sent in the received message from a worker is valid.
</p>
177 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">message
</span>:
<a href=
"../interfaces/MessageValue.html" class=
"tsd-signature-type tsd-kind-interface">MessageValue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol"> |
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>The received message.
</p>
178 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"><h4>Throws
</h4><p><a href=
"https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error
</a> If the worker id is invalid.
</p>
179 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L508">src/pools/abstract-pool.ts:
508</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"checkMinimumNumberOfWorkers" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>check
<wbr/>Minimum
<wbr/>Number
<wbr/>Of
<wbr/>Workers
</span><a href=
"#checkMinimumNumberOfWorkers" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"checkMinimumNumberOfWorkers.checkMinimumNumberOfWorkers-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">check
<wbr/>Minimum
<wbr/>Number
<wbr/>Of
<wbr/>Workers
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">minimumNumberOfWorkers
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#checkMinimumNumberOfWorkers.checkMinimumNumberOfWorkers-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">minimumNumberOfWorkers
</span>:
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L192">src/pools/abstract-pool.ts:
192</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"checkPoolOptions" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>check
<wbr/>Pool
<wbr/>Options
</span><a href=
"#checkPoolOptions" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"checkPoolOptions.checkPoolOptions-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">check
<wbr/>Pool
<wbr/>Options
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">opts
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#checkPoolOptions.checkPoolOptions-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">opts
</span>:
<a href=
"../interfaces/PoolOptions.html" class=
"tsd-signature-type tsd-kind-interface">PoolOptions
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L212">src/pools/abstract-pool.ts:
212</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"checkPoolType" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>check
<wbr/>Pool
<wbr/>Type
</span><a href=
"#checkPoolType" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"checkPoolType.checkPoolType-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">check
<wbr/>Pool
<wbr/>Type
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#checkPoolType.checkPoolType-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L184">src/pools/abstract-pool.ts:
184</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"checkValidWorkerChoiceStrategyOptions" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>check
<wbr/>Valid
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span><a href=
"#checkValidWorkerChoiceStrategyOptions" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"checkValidWorkerChoiceStrategyOptions.checkValidWorkerChoiceStrategyOptions-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">check
<wbr/>Valid
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#checkValidWorkerChoiceStrategyOptions.checkValidWorkerChoiceStrategyOptions-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span>:
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a href=
"../interfaces/WorkerChoiceStrategyOptions.html" class=
"tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions
</a></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L238">src/pools/abstract-pool.ts:
238</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"chooseWorkerNode" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>choose
<wbr/>Worker
<wbr/>Node
</span><a href=
"#chooseWorkerNode" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"chooseWorkerNode.chooseWorkerNode-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">choose
<wbr/>Worker
<wbr/>Node
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">number
</span><a href=
"#chooseWorkerNode.chooseWorkerNode-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Chooses a worker node for the next task.
</p>
180 <p>The default worker choice strategy uses a round robin algorithm to distribute the tasks.
</p>
181 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><p>The chosen worker node key
</p>
182 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1184">src/pools/abstract-pool.ts:
1184</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"createAndSetupDynamicWorkerNode" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>create
<wbr/>And
<wbr/>Setup
<wbr/>Dynamic
<wbr/>Worker
<wbr/>Node
</span><a href=
"#createAndSetupDynamicWorkerNode" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"createAndSetupDynamicWorkerNode.createAndSetupDynamicWorkerNode-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">create
<wbr/>And
<wbr/>Setup
<wbr/>Dynamic
<wbr/>Worker
<wbr/>Node
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">number
</span><a href=
"#createAndSetupDynamicWorkerNode.createAndSetupDynamicWorkerNode-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Creates a new, completely set up dynamic worker node.
</p>
183 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><p>New, completely set up dynamic worker node key.
</p>
184 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1280">src/pools/abstract-pool.ts:
1280</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"createAndSetupWorkerNode" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>create
<wbr/>And
<wbr/>Setup
<wbr/>Worker
<wbr/>Node
</span><a href=
"#createAndSetupWorkerNode" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"createAndSetupWorkerNode.createAndSetupWorkerNode-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">create
<wbr/>And
<wbr/>Setup
<wbr/>Worker
<wbr/>Node
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">number
</span><a href=
"#createAndSetupWorkerNode.createAndSetupWorkerNode-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Creates a new, completely set up worker node.
</p>
185 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><p>New, completely set up worker node key.
</p>
186 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1223">src/pools/abstract-pool.ts:
1223</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"createWorkerNode" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>create
<wbr/>Worker
<wbr/>Node
</span><a href=
"#createWorkerNode" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"createWorkerNode.createWorkerNode-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">create
<wbr/>Worker
<wbr/>Node
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><a href=
"../interfaces/IWorkerNode.html" class=
"tsd-signature-type tsd-kind-interface">IWorkerNode
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span><a href=
"#createWorkerNode.createWorkerNode-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Creates a worker node.
</p>
187 </div><h4 class=
"tsd-returns-title">Returns
<a href=
"../interfaces/IWorkerNode.html" class=
"tsd-signature-type tsd-kind-interface">IWorkerNode
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span></h4><p>The created worker node.
</p>
188 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1832">src/pools/abstract-pool.ts:
1832</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"deleteTaskFunctionWorkerUsages" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>delete
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usages
</span><a href=
"#deleteTaskFunctionWorkerUsages" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"deleteTaskFunctionWorkerUsages.deleteTaskFunctionWorkerUsages-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">delete
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usages
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#deleteTaskFunctionWorkerUsages.deleteTaskFunctionWorkerUsages-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L871">src/pools/abstract-pool.ts:
871</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"dequeueTask" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>dequeue
<wbr/>Task
</span><a href=
"#dequeueTask" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"dequeueTask.dequeueTask-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">dequeue
<wbr/>Task
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a href=
"../interfaces/Task.html" class=
"tsd-signature-type tsd-kind-interface">Task
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span><a href=
"#dequeueTask.dequeueTask-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a href=
"../interfaces/Task.html" class=
"tsd-signature-type tsd-kind-interface">Task
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1924">src/pools/abstract-pool.ts:
1924</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"deregisterWorkerMessageListener" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagAbstract">Abstract
</code> <span>deregister
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span><a href=
"#deregisterWorkerMessageListener" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"deregisterWorkerMessageListener.deregisterWorkerMessageListener-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">deregister
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#deregisterWorkerMessageListener.deregisterWorkerMessageListener-1.Message">Message
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">listener
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#deregisterWorkerMessageListener.deregisterWorkerMessageListener-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Deregisters a listener callback on the worker given its worker node key.
</p>
189 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"deregisterWorkerMessageListener.deregisterWorkerMessageListener-1.Message" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">Message
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
190 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><span class=
"tsd-kind-parameter">listener
</span>:
<span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span></span><div class=
"tsd-comment tsd-typography"><p>The message listener callback.
</p>
191 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">message
</span>:
<a href=
"../interfaces/MessageValue.html" class=
"tsd-signature-type tsd-kind-interface">MessageValue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#deregisterWorkerMessageListener.deregisterWorkerMessageListener-1.Message">Message
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4></li></ul></li></ul></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1365">src/pools/abstract-pool.ts:
1365</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"destroy" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>destroy
</span><a href=
"#destroy" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"destroy.destroy-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">destroy
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">></span><a href=
"#destroy.destroy-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#destroy">destroy
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L977">src/pools/abstract-pool.ts:
977</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"destroyWorkerNode" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>destroy
<wbr/>Worker
<wbr/>Node
</span><a href=
"#destroyWorkerNode" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"destroyWorkerNode.destroyWorkerNode-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">destroy
<wbr/>Worker
<wbr/>Node
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">></span><a href=
"#destroyWorkerNode.destroyWorkerNode-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Terminates the worker node given its worker node key.
</p>
192 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
193 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1031">src/pools/abstract-pool.ts:
1031</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"enableTasksQueue" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>enable
<wbr/>Tasks
<wbr/>Queue
</span><a href=
"#enableTasksQueue" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"enableTasksQueue.enableTasksQueue-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">enable
<wbr/>Tasks
<wbr/>Queue
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">enable
</span>,
<span class=
"tsd-kind-parameter">tasksQueueOptions
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#enableTasksQueue.enableTasksQueue-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">enable
</span>:
<span class=
"tsd-signature-type">boolean
</span></span></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">tasksQueueOptions
</span>:
<a href=
"../interfaces/TasksQueueOptions.html" class=
"tsd-signature-type tsd-kind-interface">TasksQueueOptions
</a></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#enableTasksQueue">enableTasksQueue
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L563">src/pools/abstract-pool.ts:
563</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"enqueueTask" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>enqueue
<wbr/>Task
</span><a href=
"#enqueueTask" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"enqueueTask.enqueueTask-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">enqueue
<wbr/>Task
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">task
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">number
</span><a href=
"#enqueueTask.enqueueTask-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">task
</span>:
<a href=
"../interfaces/Task.html" class=
"tsd-signature-type tsd-kind-interface">Task
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1918">src/pools/abstract-pool.ts:
1918</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"execute" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>execute
</span><a href=
"#execute" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"execute.execute-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">execute
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">data
</span><span class=
"tsd-signature-symbol">?
</span>,
<span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">?
</span>,
<span class=
"tsd-kind-parameter">transferList
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">></span><a href=
"#execute.execute-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">data
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a></span></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></span></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">transferList
</span>:
<span class=
"tsd-signature-type">TransferListItem
</span><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#execute">execute
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L887">src/pools/abstract-pool.ts:
887</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"executeTask" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>execute
<wbr/>Task
</span><a href=
"#executeTask" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"executeTask.executeTask-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">execute
<wbr/>Task
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">task
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#executeTask.executeTask-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Executes the given task on the worker given its worker node key.
</p>
194 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
195 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><span class=
"tsd-kind-parameter">task
</span>:
<a href=
"../interfaces/Task.html" class=
"tsd-signature-type tsd-kind-interface">Task
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>The task to execute.
</p>
196 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1912">src/pools/abstract-pool.ts:
1912</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"flagWorkerNodeAsNotReady" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>flag
<wbr/>Worker
<wbr/>Node
<wbr/>As
<wbr/>Not
<wbr/>Ready
</span><a href=
"#flagWorkerNodeAsNotReady" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"flagWorkerNodeAsNotReady.flagWorkerNodeAsNotReady-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">flag
<wbr/>Worker
<wbr/>Node
<wbr/>As
<wbr/>Not
<wbr/>Ready
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#flagWorkerNodeAsNotReady.flagWorkerNodeAsNotReady-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1890">src/pools/abstract-pool.ts:
1890</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"flushTasksQueue" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>flush
<wbr/>Tasks
<wbr/>Queue
</span><a href=
"#flushTasksQueue" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"flushTasksQueue.flushTasksQueue-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">flush
<wbr/>Tasks
<wbr/>Queue
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">number
</span><a href=
"#flushTasksQueue.flushTasksQueue-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1932">src/pools/abstract-pool.ts:
1932</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"flushTasksQueues" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>flush
<wbr/>Tasks
<wbr/>Queues
</span><a href=
"#flushTasksQueues" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"flushTasksQueues.flushTasksQueues-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">flush
<wbr/>Tasks
<wbr/>Queues
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#flushTasksQueues.flushTasksQueues-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1943">src/pools/abstract-pool.ts:
1943</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"getWorkerInfo" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>get
<wbr/>Worker
<wbr/>Info
</span><a href=
"#getWorkerInfo" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"getWorkerInfo.getWorkerInfo-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">get
<wbr/>Worker
<wbr/>Info
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a href=
"../interfaces/WorkerInfo.html" class=
"tsd-signature-type tsd-kind-interface">WorkerInfo
</a><a href=
"#getWorkerInfo.getWorkerInfo-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Gets the worker information given its worker node key.
</p>
197 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
198 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a href=
"../interfaces/WorkerInfo.html" class=
"tsd-signature-type tsd-kind-interface">WorkerInfo
</a></h4><p>The worker information.
</p>
199 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1823">src/pools/abstract-pool.ts:
1823</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"getWorkerNodeKeyByWorkerId" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>get
<wbr/>Worker
<wbr/>Node
<wbr/>Key
<wbr/>By
<wbr/>Worker
<wbr/>Id
</span><a href=
"#getWorkerNodeKeyByWorkerId" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"getWorkerNodeKeyByWorkerId.getWorkerNodeKeyByWorkerId-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">get
<wbr/>Worker
<wbr/>Node
<wbr/>Key
<wbr/>By
<wbr/>Worker
<wbr/>Id
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerId
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">number
</span><a href=
"#getWorkerNodeKeyByWorkerId.getWorkerNodeKeyByWorkerId-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Gets the worker node key given its worker id.
</p>
200 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerId
</span>:
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker id.
</p>
201 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><p>The worker node key if the worker id is found in the pool worker nodes,
<code>-
1</code> otherwise.
</p>
202 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L524">src/pools/abstract-pool.ts:
524</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"handleTask" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>handle
<wbr/>Task
</span><a href=
"#handleTask" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"handleTask.handleTask-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">handle
<wbr/>Task
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">task
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#handleTask.handleTask-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">task
</span>:
<a href=
"../interfaces/Task.html" class=
"tsd-signature-type tsd-kind-interface">Task
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1433">src/pools/abstract-pool.ts:
1433</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"handleTaskExecutionResponse" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>handle
<wbr/>Task
<wbr/>Execution
<wbr/>Response
</span><a href=
"#handleTaskExecutionResponse" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"handleTaskExecutionResponse.handleTaskExecutionResponse-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">handle
<wbr/>Task
<wbr/>Execution
<wbr/>Response
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#handleTaskExecutionResponse.handleTaskExecutionResponse-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">message
</span>:
<a href=
"../interfaces/MessageValue.html" class=
"tsd-signature-type tsd-kind-interface">MessageValue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1743">src/pools/abstract-pool.ts:
1743</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"handleWorkerNodeBackPressureEvent" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>handle
<wbr/>Worker
<wbr/>Node
<wbr/>Back
<wbr/>Pressure
<wbr/>Event
</span><a href=
"#handleWorkerNodeBackPressureEvent" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"handleWorkerNodeBackPressureEvent.handleWorkerNodeBackPressureEvent-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">handle
<wbr/>Worker
<wbr/>Node
<wbr/>Back
<wbr/>Pressure
<wbr/>Event
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">eventDetail
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#handleWorkerNodeBackPressureEvent.handleWorkerNodeBackPressureEvent-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">eventDetail
</span>:
<a href=
"../interfaces/WorkerNodeEventDetail.html" class=
"tsd-signature-type tsd-kind-interface">WorkerNodeEventDetail
</a></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1648">src/pools/abstract-pool.ts:
1648</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"handleWorkerNodeIdleEvent" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>handle
<wbr/>Worker
<wbr/>Node
<wbr/>Idle
<wbr/>Event
</span><a href=
"#handleWorkerNodeIdleEvent" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"handleWorkerNodeIdleEvent.handleWorkerNodeIdleEvent-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">handle
<wbr/>Worker
<wbr/>Node
<wbr/>Idle
<wbr/>Event
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">eventDetail
</span>,
<span class=
"tsd-kind-parameter">previousStolenTask
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#handleWorkerNodeIdleEvent.handleWorkerNodeIdleEvent-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">eventDetail
</span>:
<a href=
"../interfaces/WorkerNodeEventDetail.html" class=
"tsd-signature-type tsd-kind-interface">WorkerNodeEventDetail
</a></span></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">previousStolenTask
</span>:
<a href=
"../interfaces/Task.html" class=
"tsd-signature-type tsd-kind-interface">Task
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1536">src/pools/abstract-pool.ts:
1536</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"handleWorkerReadyResponse" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>handle
<wbr/>Worker
<wbr/>Ready
<wbr/>Response
</span><a href=
"#handleWorkerReadyResponse" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"handleWorkerReadyResponse.handleWorkerReadyResponse-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">handle
<wbr/>Worker
<wbr/>Ready
<wbr/>Response
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#handleWorkerReadyResponse.handleWorkerReadyResponse-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">message
</span>:
<a href=
"../interfaces/MessageValue.html" class=
"tsd-signature-type tsd-kind-interface">MessageValue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1731">src/pools/abstract-pool.ts:
1731</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"hasBackPressure" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>has
<wbr/>Back
<wbr/>Pressure
</span><a href=
"#hasBackPressure" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"hasBackPressure.hasBackPressure-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">has
<wbr/>Back
<wbr/>Pressure
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span><a href=
"#hasBackPressure.hasBackPressure-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1897">src/pools/abstract-pool.ts:
1897</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"hasTaskFunction" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>has
<wbr/>Task
<wbr/>Function
</span><a href=
"#hasTaskFunction" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"hasTaskFunction.hasTaskFunction-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">has
<wbr/>Task
<wbr/>Function
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span><a href=
"#hasTaskFunction.hasTaskFunction-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#hasTaskFunction">hasTaskFunction
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L799">src/pools/abstract-pool.ts:
799</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"initializeEventEmitter" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>initialize
<wbr/>Event
<wbr/>Emitter
</span><a href=
"#initializeEventEmitter" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"initializeEventEmitter.initializeEventEmitter-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">initialize
<wbr/>Event
<wbr/>Emitter
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#initializeEventEmitter.initializeEventEmitter-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L270">src/pools/abstract-pool.ts:
270</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"internalBusy" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>internal
<wbr/>Busy
</span><a href=
"#internalBusy" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"internalBusy.internalBusy-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">internal
<wbr/>Busy
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span><a href=
"#internalBusy.internalBusy-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Whether worker nodes are executing concurrently their tasks quota or not.
</p>
203 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><p>Worker nodes busyness boolean status.
</p>
204 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L677">src/pools/abstract-pool.ts:
677</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"isMain" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagAbstract">Abstract
</code> <span>is
<wbr/>Main
</span><a href=
"#isMain" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"isMain.isMain-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">is
<wbr/>Main
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span><a href=
"#isMain.isMain-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Should return whether the worker is the main worker or not.
</p>
205 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1061">src/pools/abstract-pool.ts:
1061</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"isWorkerNodeBusy" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>is
<wbr/>Worker
<wbr/>Node
<wbr/>Busy
</span><a href=
"#isWorkerNodeBusy" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"isWorkerNodeBusy.isWorkerNodeBusy-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">is
<wbr/>Worker
<wbr/>Node
<wbr/>Busy
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span><a href=
"#isWorkerNodeBusy.isWorkerNodeBusy-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L697">src/pools/abstract-pool.ts:
697</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"listTaskFunctionNames" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>list
<wbr/>Task
<wbr/>Function
<wbr/>Names
</span><a href=
"#listTaskFunctionNames" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"listTaskFunctionNames.listTaskFunctionNames-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">list
<wbr/>Task
<wbr/>Function
<wbr/>Names
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">string
</span><span class=
"tsd-signature-symbol">[]
</span><a href=
"#listTaskFunctionNames.listTaskFunctionNames-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">string
</span><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#listTaskFunctionNames">listTaskFunctionNames
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L851">src/pools/abstract-pool.ts:
851</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"redistributeQueuedTasks" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>redistribute
<wbr/>Queued
<wbr/>Tasks
</span><a href=
"#redistributeQueuedTasks" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"redistributeQueuedTasks.redistributeQueuedTasks-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">redistribute
<wbr/>Queued
<wbr/>Tasks
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#redistributeQueuedTasks.redistributeQueuedTasks-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1441">src/pools/abstract-pool.ts:
1441</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"registerOnceWorkerMessageListener" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagAbstract">Abstract
</code> <span>register
<wbr/>Once
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span><a href=
"#registerOnceWorkerMessageListener" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"registerOnceWorkerMessageListener.registerOnceWorkerMessageListener-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">register
<wbr/>Once
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#registerOnceWorkerMessageListener.registerOnceWorkerMessageListener-1.Message-1">Message
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">listener
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#registerOnceWorkerMessageListener.registerOnceWorkerMessageListener-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Registers once a listener callback on the worker given its worker node key.
</p>
206 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"registerOnceWorkerMessageListener.registerOnceWorkerMessageListener-1.Message-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">Message
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
207 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><span class=
"tsd-kind-parameter">listener
</span>:
<span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span></span><div class=
"tsd-comment tsd-typography"><p>The message listener callback.
</p>
208 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">message
</span>:
<a href=
"../interfaces/MessageValue.html" class=
"tsd-signature-type tsd-kind-interface">MessageValue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#registerOnceWorkerMessageListener.registerOnceWorkerMessageListener-1.Message-1">Message
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4></li></ul></li></ul></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1352">src/pools/abstract-pool.ts:
1352</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"registerWorkerMessageListener" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagAbstract">Abstract
</code> <span>register
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span><a href=
"#registerWorkerMessageListener" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"registerWorkerMessageListener.registerWorkerMessageListener-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">register
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#registerWorkerMessageListener.registerWorkerMessageListener-1.Message-2">Message
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">listener
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#registerWorkerMessageListener.registerWorkerMessageListener-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Registers a listener callback on the worker given its worker node key.
</p>
209 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"registerWorkerMessageListener.registerWorkerMessageListener-1.Message-2" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">Message
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
210 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><span class=
"tsd-kind-parameter">listener
</span>:
<span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol"> =
> </span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">)
</span></span><div class=
"tsd-comment tsd-typography"><p>The message listener callback.
</p>
211 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures"><li class=
"tsd-signature"><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">message
</span>:
<a href=
"../interfaces/MessageValue.html" class=
"tsd-signature-type tsd-kind-interface">MessageValue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#registerWorkerMessageListener.registerWorkerMessageListener-1.Message-2">Message
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4></li></ul></li></ul></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1339">src/pools/abstract-pool.ts:
1339</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"removeTaskFunction" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>remove
<wbr/>Task
<wbr/>Function
</span><a href=
"#removeTaskFunction" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"removeTaskFunction.removeTaskFunction-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">remove
<wbr/>Task
<wbr/>Function
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span><a href=
"#removeTaskFunction.removeTaskFunction-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#removeTaskFunction">removeTaskFunction
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L835">src/pools/abstract-pool.ts:
835</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"removeWorkerNode" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>remove
<wbr/>Worker
<wbr/>Node
</span><a href=
"#removeWorkerNode" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"removeWorkerNode.removeWorkerNode-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">remove
<wbr/>Worker
<wbr/>Node
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNode
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#removeWorkerNode.removeWorkerNode-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Removes the worker node from the pool worker nodes.
</p>
212 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNode
</span>:
<a href=
"../interfaces/IWorkerNode.html" class=
"tsd-signature-type tsd-kind-interface">IWorkerNode
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Worker-1">Worker
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>The worker node.
</p>
213 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1881">src/pools/abstract-pool.ts:
1881</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>reset
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usage
</span><a href=
"#resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage.resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">reset
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usage
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">taskName
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage.resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">taskName
</span>:
<span class=
"tsd-signature-type">string
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1520">src/pools/abstract-pool.ts:
1520</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"resetTaskSequentiallyStolenStatisticsWorkerUsage" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>reset
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Worker
<wbr/>Usage
</span><a href=
"#resetTaskSequentiallyStolenStatisticsWorkerUsage" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"resetTaskSequentiallyStolenStatisticsWorkerUsage.resetTaskSequentiallyStolenStatisticsWorkerUsage-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">reset
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Worker
<wbr/>Usage
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#resetTaskSequentiallyStolenStatisticsWorkerUsage.resetTaskSequentiallyStolenStatisticsWorkerUsage-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1510">src/pools/abstract-pool.ts:
1510</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"sendKillMessageToWorker" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>send
<wbr/>Kill
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span><a href=
"#sendKillMessageToWorker" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"sendKillMessageToWorker.sendKillMessageToWorker-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">send
<wbr/>Kill
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">></span><a href=
"#sendKillMessageToWorker.sendKillMessageToWorker-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">void
</span><span class=
"tsd-signature-symbol">></span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1001">src/pools/abstract-pool.ts:
1001</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"sendStartupMessageToWorker" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagAbstract">Abstract
</code> <span>send
<wbr/>Startup
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span><a href=
"#sendStartupMessageToWorker" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"sendStartupMessageToWorker.sendStartupMessageToWorker-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">send
<wbr/>Startup
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#sendStartupMessageToWorker.sendStartupMessageToWorker-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Sends the startup message to worker given its worker node key.
</p>
214 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
215 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1409">src/pools/abstract-pool.ts:
1409</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"sendStatisticsMessageToWorker" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>send
<wbr/>Statistics
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span><a href=
"#sendStatisticsMessageToWorker" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"sendStatisticsMessageToWorker.sendStatisticsMessageToWorker-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">send
<wbr/>Statistics
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#sendStatisticsMessageToWorker.sendStatisticsMessageToWorker-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Sends the statistics message to worker given its worker node key.
</p>
216 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
217 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1416">src/pools/abstract-pool.ts:
1416</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"sendTaskFunctionOperationToWorker" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>send
<wbr/>Task
<wbr/>Function
<wbr/>Operation
<wbr/>To
<wbr/>Worker
</span><a href=
"#sendTaskFunctionOperationToWorker" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"sendTaskFunctionOperationToWorker.sendTaskFunctionOperationToWorker-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">send
<wbr/>Task
<wbr/>Function
<wbr/>Operation
<wbr/>To
<wbr/>Worker
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span><a href=
"#sendTaskFunctionOperationToWorker.sendTaskFunctionOperationToWorker-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">message
</span>:
<a href=
"../interfaces/MessageValue.html" class=
"tsd-signature-type tsd-kind-interface">MessageValue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L708">src/pools/abstract-pool.ts:
708</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"sendTaskFunctionOperationToWorkers" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>send
<wbr/>Task
<wbr/>Function
<wbr/>Operation
<wbr/>To
<wbr/>Workers
</span><a href=
"#sendTaskFunctionOperationToWorkers" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"sendTaskFunctionOperationToWorkers.sendTaskFunctionOperationToWorkers-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">send
<wbr/>Task
<wbr/>Function
<wbr/>Operation
<wbr/>To
<wbr/>Workers
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span><a href=
"#sendTaskFunctionOperationToWorkers.sendTaskFunctionOperationToWorkers-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">message
</span>:
<a href=
"../interfaces/MessageValue.html" class=
"tsd-signature-type tsd-kind-interface">MessageValue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L745">src/pools/abstract-pool.ts:
745</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"sendToWorker" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagAbstract">Abstract
</code> <span>send
<wbr/>To
<wbr/>Worker
</span><a href=
"#sendToWorker" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"sendToWorker.sendToWorker-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">send
<wbr/>To
<wbr/>Worker
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">message
</span>,
<span class=
"tsd-kind-parameter">transferList
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#sendToWorker.sendToWorker-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Sends a message to worker given its worker node key.
</p>
218 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
219 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><span class=
"tsd-kind-parameter">message
</span>:
<a href=
"../interfaces/MessageValue.html" class=
"tsd-signature-type tsd-kind-interface">MessageValue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>The message.
</p>
220 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">transferList
</span>:
<span class=
"tsd-signature-type">TransferListItem
</span><span class=
"tsd-signature-symbol">[]
</span></span><div class=
"tsd-comment tsd-typography"><p>The optional array of transferable objects.
</p>
221 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1212">src/pools/abstract-pool.ts:
1212</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"setDefaultTaskFunction" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>set
<wbr/>Default
<wbr/>Task
<wbr/>Function
</span><a href=
"#setDefaultTaskFunction" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"setDefaultTaskFunction.setDefaultTaskFunction-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">set
<wbr/>Default
<wbr/>Task
<wbr/>Function
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">name
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span><a href=
"#setDefaultTaskFunction.setDefaultTaskFunction-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Promise
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#setDefaultTaskFunction">setDefaultTaskFunction
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L864">src/pools/abstract-pool.ts:
864</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"setTaskStealing" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>set
<wbr/>Task
<wbr/>Stealing
</span><a href=
"#setTaskStealing" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"setTaskStealing.setTaskStealing-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">set
<wbr/>Task
<wbr/>Stealing
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#setTaskStealing.setTaskStealing-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L620">src/pools/abstract-pool.ts:
620</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"setTasksQueueOptions" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span><a href=
"#setTasksQueueOptions" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"setTasksQueueOptions.setTasksQueueOptions-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">tasksQueueOptions
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#setTasksQueueOptions.setTasksQueueOptions-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">tasksQueueOptions
</span>:
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a href=
"../interfaces/TasksQueueOptions.html" class=
"tsd-signature-type tsd-kind-interface">TasksQueueOptions
</a></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#setTasksQueueOptions">setTasksQueueOptions
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L577">src/pools/abstract-pool.ts:
577</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"setTasksQueueSize" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Size
</span><a href=
"#setTasksQueueSize" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"setTasksQueueSize.setTasksQueueSize-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Size
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">size
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#setTasksQueueSize.setTasksQueueSize-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">size
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L614">src/pools/abstract-pool.ts:
614</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"setTasksStealingOnBackPressure" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>set
<wbr/>Tasks
<wbr/>Stealing
<wbr/>On
<wbr/>Back
<wbr/>Pressure
</span><a href=
"#setTasksStealingOnBackPressure" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"setTasksStealingOnBackPressure.setTasksStealingOnBackPressure-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">set
<wbr/>Tasks
<wbr/>Stealing
<wbr/>On
<wbr/>Back
<wbr/>Pressure
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#setTasksStealingOnBackPressure.setTasksStealingOnBackPressure-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L635">src/pools/abstract-pool.ts:
635</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"setWorkerChoiceStrategy" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
</span><a href=
"#setWorkerChoiceStrategy" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"setWorkerChoiceStrategy.setWorkerChoiceStrategy-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerChoiceStrategy
</span>,
<span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#setWorkerChoiceStrategy.setWorkerChoiceStrategy-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerChoiceStrategy
</span>:
<span class=
"tsd-signature-type">"ROUND_ROBIN
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"LEAST_USED
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"LEAST_BUSY
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"LEAST_ELU
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"FAIR_SHARE
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"WEIGHTED_ROUND_ROBIN
"</span><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">"INTERLEAVED_WEIGHTED_ROUND_ROBIN
"</span></span></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span>:
<a href=
"../interfaces/WorkerChoiceStrategyOptions.html" class=
"tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions
</a></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#setWorkerChoiceStrategy">setWorkerChoiceStrategy
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L531">src/pools/abstract-pool.ts:
531</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"setWorkerChoiceStrategyOptions" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span><a href=
"#setWorkerChoiceStrategyOptions" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"setWorkerChoiceStrategyOptions.setWorkerChoiceStrategyOptions-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#setWorkerChoiceStrategyOptions.setWorkerChoiceStrategyOptions-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span>:
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a href=
"../interfaces/WorkerChoiceStrategyOptions.html" class=
"tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions
</a></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#setWorkerChoiceStrategyOptions">setWorkerChoiceStrategyOptions
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L550">src/pools/abstract-pool.ts:
550</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"setupHook" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>setup
<wbr/>Hook
</span><a href=
"#setupHook" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"setupHook.setupHook-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">setup
<wbr/>Hook
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#setupHook.setupHook-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Setup hook to execute code before worker nodes are created in the abstract constructor.
222 Can be overridden.
</p>
223 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1054">src/pools/abstract-pool.ts:
1054</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"shallCreateDynamicWorker" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagAbstract">Abstract
</code> <span>shall
<wbr/>Create
<wbr/>Dynamic
<wbr/>Worker
</span><a href=
"#shallCreateDynamicWorker" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"shallCreateDynamicWorker.shallCreateDynamicWorker-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">shall
<wbr/>Create
<wbr/>Dynamic
<wbr/>Worker
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span><a href=
"#shallCreateDynamicWorker.shallCreateDynamicWorker-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Conditions for dynamic worker creation.
</p>
224 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><p>Whether to create a dynamic worker or not.
</p>
225 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1203">src/pools/abstract-pool.ts:
1203</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"shallExecuteTask" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>shall
<wbr/>Execute
<wbr/>Task
</span><a href=
"#shallExecuteTask" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"shallExecuteTask.shallExecuteTask-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">shall
<wbr/>Execute
<wbr/>Task
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span><a href=
"#shallExecuteTask.shallExecuteTask-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L877">src/pools/abstract-pool.ts:
877</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"shallUpdateTaskFunctionWorkerUsage" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>shall
<wbr/>Update
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usage
</span><a href=
"#shallUpdateTaskFunctionWorkerUsage" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"shallUpdateTaskFunctionWorkerUsage.shallUpdateTaskFunctionWorkerUsage-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">shall
<wbr/>Update
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usage
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span><a href=
"#shallUpdateTaskFunctionWorkerUsage.shallUpdateTaskFunctionWorkerUsage-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Whether the worker node shall update its task function worker usage or not.
</p>
226 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
227 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><p><code>true
</code> if the worker node shall update its task function worker usage,
<code>false
</code> otherwise.
</p>
228 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1168">src/pools/abstract-pool.ts:
1168</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"start" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>start
</span><a href=
"#start" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"start.start-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">start
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#start.start-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Implementation of
<a href=
"../interfaces/IPool.html">IPool
</a>.
<a href=
"../interfaces/IPool.html#start">start
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L952">src/pools/abstract-pool.ts:
952</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"tasksQueueSize" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>tasks
<wbr/>Queue
<wbr/>Size
</span><a href=
"#tasksQueueSize" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"tasksQueueSize.tasksQueueSize-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">tasks
<wbr/>Queue
<wbr/>Size
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">number
</span><a href=
"#tasksQueueSize.tasksQueueSize-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1928">src/pools/abstract-pool.ts:
1928</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"unsetTaskStealing" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>unset
<wbr/>Task
<wbr/>Stealing
</span><a href=
"#unsetTaskStealing" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"unsetTaskStealing.unsetTaskStealing-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">unset
<wbr/>Task
<wbr/>Stealing
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#unsetTaskStealing.unsetTaskStealing-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L626">src/pools/abstract-pool.ts:
626</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"unsetTasksStealingOnBackPressure" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>unset
<wbr/>Tasks
<wbr/>Stealing
<wbr/>On
<wbr/>Back
<wbr/>Pressure
</span><a href=
"#unsetTasksStealingOnBackPressure" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"unsetTasksStealingOnBackPressure.unsetTasksStealingOnBackPressure-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">unset
<wbr/>Tasks
<wbr/>Stealing
<wbr/>On
<wbr/>Back
<wbr/>Pressure
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#unsetTasksStealingOnBackPressure.unsetTasksStealingOnBackPressure-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L644">src/pools/abstract-pool.ts:
644</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>update
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usage
</span><a href=
"#updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage.updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">update
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usage
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">taskName
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage.updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">taskName
</span>:
<span class=
"tsd-signature-type">string
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1494">src/pools/abstract-pool.ts:
1494</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"updateTaskSequentiallyStolenStatisticsWorkerUsage" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>update
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Worker
<wbr/>Usage
</span><a href=
"#updateTaskSequentiallyStolenStatisticsWorkerUsage" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"updateTaskSequentiallyStolenStatisticsWorkerUsage.updateTaskSequentiallyStolenStatisticsWorkerUsage-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">update
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Worker
<wbr/>Usage
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#updateTaskSequentiallyStolenStatisticsWorkerUsage.updateTaskSequentiallyStolenStatisticsWorkerUsage-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1484">src/pools/abstract-pool.ts:
1484</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"updateTaskStolenStatisticsWorkerUsage" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>update
<wbr/>Task
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Worker
<wbr/>Usage
</span><a href=
"#updateTaskStolenStatisticsWorkerUsage" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"updateTaskStolenStatisticsWorkerUsage.updateTaskStolenStatisticsWorkerUsage-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">update
<wbr/>Task
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Worker
<wbr/>Usage
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span>,
<span class=
"tsd-kind-parameter">taskName
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#updateTaskStolenStatisticsWorkerUsage.updateTaskStolenStatisticsWorkerUsage-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">taskName
</span>:
<span class=
"tsd-signature-type">string
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1464">src/pools/abstract-pool.ts:
1464</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected"><a id=
"workerMessageListener" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>worker
<wbr/>Message
<wbr/>Listener
</span><a href=
"#workerMessageListener" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected"><li class=
"tsd-signature tsd-anchor-link"><a id=
"workerMessageListener.workerMessageListener-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">worker
<wbr/>Message
<wbr/>Listener
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">message
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#workerMessageListener.workerMessageListener-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>This method is the message listener registered on each worker.
</p>
229 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">message
</span>:
<a href=
"../interfaces/MessageValue.html" class=
"tsd-signature-type tsd-kind-interface">MessageValue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Response-1">Response
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1702">src/pools/abstract-pool.ts:
1702</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"workerNodeStealTask" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>worker
<wbr/>Node
<wbr/>Steal
<wbr/>Task
</span><a href=
"#workerNodeStealTask" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"workerNodeStealTask.workerNodeStealTask-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">worker
<wbr/>Node
<wbr/>Steal
<wbr/>Task
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">workerNodeKey
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a href=
"../interfaces/Task.html" class=
"tsd-signature-type tsd-kind-interface">Task
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span><a href=
"#workerNodeStealTask.workerNodeStealTask-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a href=
"../interfaces/Task.html" class=
"tsd-signature-type tsd-kind-interface">Task
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"AbstractPool.html#constructor.new_AbstractPool.Data-1">Data
</a><span class=
"tsd-signature-symbol">></span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/4a3ee52/src/pools/abstract-pool.ts#L1621">src/pools/abstract-pool.ts:
1621</a></li></ul></aside></li></ul></section></section></div><div class=
"col-sidebar"><div class=
"page-menu"><div class=
"tsd-navigation settings"><details class=
"tsd-index-accordion"><summary class=
"tsd-accordion-summary"><h3><svg width=
"20" height=
"20" viewBox=
"0 0 24 24" fill=
"none"><use href=
"../assets/icons.svg#icon-chevronDown"></use></svg>Settings
</h3></summary><div class=
"tsd-accordion-details"><div class=
"tsd-filter-visibility"><h4 class=
"uppercase">Member Visibility
</h4><form><ul id=
"tsd-filter-options"><li class=
"tsd-filter-item"><label class=
"tsd-filter-input"><input type=
"checkbox" id=
"tsd-filter-protected" name=
"protected"/><svg width=
"32" height=
"32" viewBox=
"0 0 32 32" aria-hidden=
"true"><rect class=
"tsd-checkbox-background" width=
"30" height=
"30" x=
"1" y=
"1" rx=
"6" fill=
"none"></rect><path class=
"tsd-checkbox-checkmark" d=
"M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=
"none" stroke-width=
"3.5" stroke-linejoin=
"round" fill=
"none"></path></svg><span>Protected
</span></label></li><li class=
"tsd-filter-item"><label class=
"tsd-filter-input"><input type=
"checkbox" id=
"tsd-filter-private" name=
"private"/><svg width=
"32" height=
"32" viewBox=
"0 0 32 32" aria-hidden=
"true"><rect class=
"tsd-checkbox-background" width=
"30" height=
"30" x=
"1" y=
"1" rx=
"6" fill=
"none"></rect><path class=
"tsd-checkbox-checkmark" d=
"M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=
"none" stroke-width=
"3.5" stroke-linejoin=
"round" fill=
"none"></path></svg><span>Private
</span></label></li><li class=
"tsd-filter-item"><label class=
"tsd-filter-input"><input type=
"checkbox" id=
"tsd-filter-inherited" name=
"inherited" checked
/><svg width=
"32" height=
"32" viewBox=
"0 0 32 32" aria-hidden=
"true"><rect class=
"tsd-checkbox-background" width=
"30" height=
"30" x=
"1" y=
"1" rx=
"6" fill=
"none"></rect><path class=
"tsd-checkbox-checkmark" d=
"M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=
"none" stroke-width=
"3.5" stroke-linejoin=
"round" fill=
"none"></path></svg><span>Inherited
</span></label></li><li class=
"tsd-filter-item"><label class=
"tsd-filter-input"><input type=
"checkbox" id=
"tsd-filter-external" name=
"external"/><svg width=
"32" height=
"32" viewBox=
"0 0 32 32" aria-hidden=
"true"><rect class=
"tsd-checkbox-background" width=
"30" height=
"30" x=
"1" y=
"1" rx=
"6" fill=
"none"></rect><path class=
"tsd-checkbox-checkmark" d=
"M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=
"none" stroke-width=
"3.5" stroke-linejoin=
"round" fill=
"none"></path></svg><span>External
</span></label></li></ul></form></div><div class=
"tsd-theme-toggle"><h4 class=
"uppercase">Theme
</h4><select id=
"tsd-theme"><option value=
"os">OS
</option><option value=
"light">Light
</option><option value=
"dark">Dark
</option></select></div></div></details></div><details open
class=
"tsd-index-accordion tsd-page-navigation"><summary class=
"tsd-accordion-summary"><h3><svg width=
"20" height=
"20" viewBox=
"0 0 24 24" fill=
"none"><use href=
"../assets/icons.svg#icon-chevronDown"></use></svg>On This Page
</h3></summary><div class=
"tsd-accordion-details"><ul><li><a href=
"#constructor" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-512"></use></svg><span>constructor
</span></a></li><li><a href=
"#destroying" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>destroying
</span></a></li><li><a href=
"#emitter" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>emitter
</span></a></li><li><a href=
"#filePath" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>file
<wbr/>Path
</span></a></li><li><a href=
"#maximumNumberOfWorkers" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>maximum
<wbr/>Number
<wbr/>Of
<wbr/>Workers
</span></a></li><li><a href=
"#minimumNumberOfWorkers" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>minimum
<wbr/>Number
<wbr/>Of
<wbr/>Workers
</span></a></li><li><a href=
"#opts" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>opts
</span></a></li><li><a href=
"#promiseResponseMap" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>promise
<wbr/>Response
<wbr/>Map
</span></a></li><li><a href=
"#readyEventEmitted" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>ready
<wbr/>Event
<wbr/>Emitted
</span></a></li><li><a href=
"#startTimestamp" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>start
<wbr/>Timestamp
</span></a></li><li><a href=
"#started" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>started
</span></a></li><li><a href=
"#starting" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>starting
</span></a></li><li><a href=
"#taskFunctions" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>task
<wbr/>Functions
</span></a></li><li><a href=
"#workerChoiceStrategyContext" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Context
</span></a></li><li><a href=
"#workerNodes" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>worker
<wbr/>Nodes
</span></a></li><li><a href=
"#busy" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>busy
</span></a></li><li><a href=
"#empty" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>empty
</span></a></li><li><a href=
"#full" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>full
</span></a></li><li><a href=
"#info" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>info
</span></a></li><li><a href=
"#ready" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>ready
</span></a></li><li><a href=
"#type" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>type
</span></a></li><li><a href=
"#utilization" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>utilization
</span></a></li><li><a href=
"#worker-2" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-262144"></use></svg><span>worker
</span></a></li><li><a href=
"#addTaskFunction" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>add
<wbr/>Task
<wbr/>Function
</span></a></li><li><a href=
"#addWorkerNode" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>add
<wbr/>Worker
<wbr/>Node
</span></a></li><li><a href=
"#afterTaskExecutionHook" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>after
<wbr/>Task
<wbr/>Execution
<wbr/>Hook
</span></a></li><li><a href=
"#afterWorkerNodeSetup" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>after
<wbr/>Worker
<wbr/>Node
<wbr/>Setup
</span></a></li><li><a href=
"#beforeTaskExecutionHook" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>before
<wbr/>Task
<wbr/>Execution
<wbr/>Hook
</span></a></li><li><a href=
"#buildTasksQueueOptions" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>build
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span></a></li><li><a href=
"#cannotStealTask" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>cannot
<wbr/>Steal
<wbr/>Task
</span></a></li><li><a href=
"#checkAndEmitDynamicWorkerCreationEvents" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>And
<wbr/>Emit
<wbr/>Dynamic
<wbr/>Worker
<wbr/>Creation
<wbr/>Events
</span></a></li><li><a href=
"#checkAndEmitEmptyEvent" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>And
<wbr/>Emit
<wbr/>Empty
<wbr/>Event
</span></a></li><li><a href=
"#checkAndEmitReadyEvent" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>And
<wbr/>Emit
<wbr/>Ready
<wbr/>Event
</span></a></li><li><a href=
"#checkAndEmitTaskExecutionEvents" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>And
<wbr/>Emit
<wbr/>Task
<wbr/>Execution
<wbr/>Events
</span></a></li><li><a href=
"#checkAndEmitTaskQueuingEvents" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>And
<wbr/>Emit
<wbr/>Task
<wbr/>Queuing
<wbr/>Events
</span></a></li><li><a href=
"#checkMessageWorkerId" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Message
<wbr/>Worker
<wbr/>Id
</span></a></li><li><a href=
"#checkMinimumNumberOfWorkers" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Minimum
<wbr/>Number
<wbr/>Of
<wbr/>Workers
</span></a></li><li><a href=
"#checkPoolOptions" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Pool
<wbr/>Options
</span></a></li><li><a href=
"#checkPoolType" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Pool
<wbr/>Type
</span></a></li><li><a href=
"#checkValidWorkerChoiceStrategyOptions" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Valid
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span></a></li><li><a href=
"#chooseWorkerNode" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>choose
<wbr/>Worker
<wbr/>Node
</span></a></li><li><a href=
"#createAndSetupDynamicWorkerNode" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>create
<wbr/>And
<wbr/>Setup
<wbr/>Dynamic
<wbr/>Worker
<wbr/>Node
</span></a></li><li><a href=
"#createAndSetupWorkerNode" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>create
<wbr/>And
<wbr/>Setup
<wbr/>Worker
<wbr/>Node
</span></a></li><li><a href=
"#createWorkerNode" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>create
<wbr/>Worker
<wbr/>Node
</span></a></li><li><a href=
"#deleteTaskFunctionWorkerUsages" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>delete
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usages
</span></a></li><li><a href=
"#dequeueTask" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>dequeue
<wbr/>Task
</span></a></li><li><a href=
"#deregisterWorkerMessageListener" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>deregister
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span></a></li><li><a href=
"#destroy" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>destroy
</span></a></li><li><a href=
"#destroyWorkerNode" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>destroy
<wbr/>Worker
<wbr/>Node
</span></a></li><li><a href=
"#enableTasksQueue" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>enable
<wbr/>Tasks
<wbr/>Queue
</span></a></li><li><a href=
"#enqueueTask" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>enqueue
<wbr/>Task
</span></a></li><li><a href=
"#execute" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>execute
</span></a></li><li><a href=
"#executeTask" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>execute
<wbr/>Task
</span></a></li><li><a href=
"#flagWorkerNodeAsNotReady" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>flag
<wbr/>Worker
<wbr/>Node
<wbr/>As
<wbr/>Not
<wbr/>Ready
</span></a></li><li><a href=
"#flushTasksQueue" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>flush
<wbr/>Tasks
<wbr/>Queue
</span></a></li><li><a href=
"#flushTasksQueues" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>flush
<wbr/>Tasks
<wbr/>Queues
</span></a></li><li><a href=
"#getWorkerInfo" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>get
<wbr/>Worker
<wbr/>Info
</span></a></li><li><a href=
"#getWorkerNodeKeyByWorkerId" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>get
<wbr/>Worker
<wbr/>Node
<wbr/>Key
<wbr/>By
<wbr/>Worker
<wbr/>Id
</span></a></li><li><a href=
"#handleTask" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>handle
<wbr/>Task
</span></a></li><li><a href=
"#handleTaskExecutionResponse" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>handle
<wbr/>Task
<wbr/>Execution
<wbr/>Response
</span></a></li><li><a href=
"#handleWorkerNodeBackPressureEvent" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>handle
<wbr/>Worker
<wbr/>Node
<wbr/>Back
<wbr/>Pressure
<wbr/>Event
</span></a></li><li><a href=
"#handleWorkerNodeIdleEvent" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>handle
<wbr/>Worker
<wbr/>Node
<wbr/>Idle
<wbr/>Event
</span></a></li><li><a href=
"#handleWorkerReadyResponse" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>handle
<wbr/>Worker
<wbr/>Ready
<wbr/>Response
</span></a></li><li><a href=
"#hasBackPressure" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>has
<wbr/>Back
<wbr/>Pressure
</span></a></li><li><a href=
"#hasTaskFunction" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>has
<wbr/>Task
<wbr/>Function
</span></a></li><li><a href=
"#initializeEventEmitter" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>initialize
<wbr/>Event
<wbr/>Emitter
</span></a></li><li><a href=
"#internalBusy" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>internal
<wbr/>Busy
</span></a></li><li><a href=
"#isMain" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>is
<wbr/>Main
</span></a></li><li><a href=
"#isWorkerNodeBusy" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>is
<wbr/>Worker
<wbr/>Node
<wbr/>Busy
</span></a></li><li><a href=
"#listTaskFunctionNames" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>list
<wbr/>Task
<wbr/>Function
<wbr/>Names
</span></a></li><li><a href=
"#redistributeQueuedTasks" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>redistribute
<wbr/>Queued
<wbr/>Tasks
</span></a></li><li><a href=
"#registerOnceWorkerMessageListener" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>register
<wbr/>Once
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span></a></li><li><a href=
"#registerWorkerMessageListener" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>register
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span></a></li><li><a href=
"#removeTaskFunction" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>remove
<wbr/>Task
<wbr/>Function
</span></a></li><li><a href=
"#removeWorkerNode" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>remove
<wbr/>Worker
<wbr/>Node
</span></a></li><li><a href=
"#resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>reset
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usage
</span></a></li><li><a href=
"#resetTaskSequentiallyStolenStatisticsWorkerUsage" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>reset
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Worker
<wbr/>Usage
</span></a></li><li><a href=
"#sendKillMessageToWorker" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>send
<wbr/>Kill
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span></a></li><li><a href=
"#sendStartupMessageToWorker" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>send
<wbr/>Startup
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span></a></li><li><a href=
"#sendStatisticsMessageToWorker" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>send
<wbr/>Statistics
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span></a></li><li><a href=
"#sendTaskFunctionOperationToWorker" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>send
<wbr/>Task
<wbr/>Function
<wbr/>Operation
<wbr/>To
<wbr/>Worker
</span></a></li><li><a href=
"#sendTaskFunctionOperationToWorkers" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>send
<wbr/>Task
<wbr/>Function
<wbr/>Operation
<wbr/>To
<wbr/>Workers
</span></a></li><li><a href=
"#sendToWorker" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>send
<wbr/>To
<wbr/>Worker
</span></a></li><li><a href=
"#setDefaultTaskFunction" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Default
<wbr/>Task
<wbr/>Function
</span></a></li><li><a href=
"#setTaskStealing" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Task
<wbr/>Stealing
</span></a></li><li><a href=
"#setTasksQueueOptions" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span></a></li><li><a href=
"#setTasksQueueSize" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Size
</span></a></li><li><a href=
"#setTasksStealingOnBackPressure" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Tasks
<wbr/>Stealing
<wbr/>On
<wbr/>Back
<wbr/>Pressure
</span></a></li><li><a href=
"#setWorkerChoiceStrategy" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
</span></a></li><li><a href=
"#setWorkerChoiceStrategyOptions" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span></a></li><li><a href=
"#setupHook" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>setup
<wbr/>Hook
</span></a></li><li><a href=
"#shallCreateDynamicWorker" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>shall
<wbr/>Create
<wbr/>Dynamic
<wbr/>Worker
</span></a></li><li><a href=
"#shallExecuteTask" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>shall
<wbr/>Execute
<wbr/>Task
</span></a></li><li><a href=
"#shallUpdateTaskFunctionWorkerUsage" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>shall
<wbr/>Update
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usage
</span></a></li><li><a href=
"#start" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>start
</span></a></li><li><a href=
"#tasksQueueSize" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>tasks
<wbr/>Queue
<wbr/>Size
</span></a></li><li><a href=
"#unsetTaskStealing" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>unset
<wbr/>Task
<wbr/>Stealing
</span></a></li><li><a href=
"#unsetTasksStealingOnBackPressure" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>unset
<wbr/>Tasks
<wbr/>Stealing
<wbr/>On
<wbr/>Back
<wbr/>Pressure
</span></a></li><li><a href=
"#updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>update
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Task
<wbr/>Function
<wbr/>Worker
<wbr/>Usage
</span></a></li><li><a href=
"#updateTaskSequentiallyStolenStatisticsWorkerUsage" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>update
<wbr/>Task
<wbr/>Sequentially
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Worker
<wbr/>Usage
</span></a></li><li><a href=
"#updateTaskStolenStatisticsWorkerUsage" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>update
<wbr/>Task
<wbr/>Stolen
<wbr/>Statistics
<wbr/>Worker
<wbr/>Usage
</span></a></li><li><a href=
"#workerMessageListener" class=
"tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>worker
<wbr/>Message
<wbr/>Listener
</span></a></li><li><a href=
"#workerNodeStealTask" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>worker
<wbr/>Node
<wbr/>Steal
<wbr/>Task
</span></a></li></ul></div></details></div><div class=
"site-menu"><nav class=
"tsd-navigation"><a href=
"../index.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1"></use></svg><span>poolifier - v3.1
.21</span></a><ul class=
"tsd-small-nested-navigation" id=
"tsd-nav-container" data-base=
".."><li>Loading...
</li></ul></nav></div></div></div><div class=
"tsd-generator"><p>Generated using
<a href=
"https://typedoc.org/" target=
"_blank">TypeDoc
</a></p></div><div class=
"overlay"></div></body></html>