1 <!DOCTYPE html
><html class=
"default" lang=
"en"><head><meta charSet=
"utf-8"/><meta http-equiv=
"x-ua-compatible" content=
"IE=edge"/><title>DynamicThreadPool | poolifier - v3.0
.13</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/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"</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=
"#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.0
.13</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=
"#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=
"DynamicThreadPool.html">DynamicThreadPool
</a></li></ul><h1>Class DynamicThreadPool
<Data, Response
></h1></div><section class=
"tsd-panel tsd-comment"><div class=
"tsd-comment tsd-typography"><p>A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
</p>
2 <p>This thread pool creates new threads when the others are busy, up to the maximum number of threads.
3 When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool
's
<code>emitter
</code>.
</p>
4 </div><div class=
"tsd-comment tsd-typography"><h4>Author
</h4><p><a href=
"https://github.com/pioardi">Alessandro Pio Ardizio
</a></p>
5 <h4>Since
</h4><p>0.0.1</p>
6 </div></section> <section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><h4><span class=
"tsd-kind-type-parameter">Data
</span> =
<span class=
"tsd-signature-type">unknown
</span></h4><div class=
"tsd-comment tsd-typography"><p>Type of data sent to the worker. This can only be structured-cloneable data.
</p>
7 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h4><span class=
"tsd-kind-type-parameter">Response
</span> =
<span class=
"tsd-signature-type">unknown
</span></h4><div class=
"tsd-comment tsd-typography"><p>Type of execution response. This can only be structured-cloneable data.
</p>
8 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></section> <section class=
"tsd-panel tsd-hierarchy"><h4>Hierarchy
</h4><ul class=
"tsd-hierarchy"><li><a href=
"FixedThreadPool.html" class=
"tsd-signature-type tsd-kind-class">FixedThreadPool
</a><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type tsd-kind-type-parameter">Data
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type tsd-kind-type-parameter">Response
</span><span class=
"tsd-signature-symbol">></span><ul class=
"tsd-hierarchy"><li><span class=
"target">DynamicThreadPool
</span></li></ul></li></ul></section><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/dynamic.ts#L16">src/pools/thread/dynamic.ts:
16</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=
"#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=
"DynamicThreadPool.html#constructor" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-512"></use></svg><span>constructor
</span></a>
9 </div></section><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Properties
</h3><div class=
"tsd-index-list"><a href=
"DynamicThreadPool.html#emitter" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>emitter?
</span></a>
10 <a href=
"DynamicThreadPool.html#filePath" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>file
<wbr/>Path
</span></a>
11 <a href=
"DynamicThreadPool.html#max" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>max
</span></a>
12 <a href=
"DynamicThreadPool.html#numberOfWorkers" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>number
<wbr/>Of
<wbr/>Workers
</span></a>
13 <a href=
"DynamicThreadPool.html#opts" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>opts
</span></a>
14 <a href=
"DynamicThreadPool.html#promiseResponseMap" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>promise
<wbr/>Response
<wbr/>Map
</span></a>
15 <a href=
"DynamicThreadPool.html#workerChoiceStrategyContext" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Context
</span></a>
16 <a href=
"DynamicThreadPool.html#workerNodes" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>worker
<wbr/>Nodes
</span></a>
17 </div></section><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Accessors
</h3><div class=
"tsd-index-list"><a href=
"DynamicThreadPool.html#busy" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>busy
</span></a>
18 <a href=
"DynamicThreadPool.html#full" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>full
</span></a>
19 <a href=
"DynamicThreadPool.html#info" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>info
</span></a>
20 <a href=
"DynamicThreadPool.html#maxSize" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>max
<wbr/>Size
</span></a>
21 <a href=
"DynamicThreadPool.html#minSize" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>min
<wbr/>Size
</span></a>
22 <a href=
"DynamicThreadPool.html#ready" class=
"tsd-index-link tsd-is-private tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>ready
</span></a>
23 <a href=
"DynamicThreadPool.html#type" class=
"tsd-index-link tsd-is-protected"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>type
</span></a>
24 <a href=
"DynamicThreadPool.html#utilization" class=
"tsd-index-link tsd-is-private tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>utilization
</span></a>
25 <a href=
"DynamicThreadPool.html#worker" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>worker
</span></a>
26 </div></section><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Methods
</h3><div class=
"tsd-index-list"><a href=
"DynamicThreadPool.html#addTaskFunction" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>add
<wbr/>Task
<wbr/>Function
</span></a>
27 <a href=
"DynamicThreadPool.html#afterTaskExecutionHook" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>after
<wbr/>Task
<wbr/>Execution
<wbr/>Hook
</span></a>
28 <a href=
"DynamicThreadPool.html#afterWorkerNodeSetup" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>after
<wbr/>Worker
<wbr/>Node
<wbr/>Setup
</span></a>
29 <a href=
"DynamicThreadPool.html#beforeTaskExecutionHook" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>before
<wbr/>Task
<wbr/>Execution
<wbr/>Hook
</span></a>
30 <a href=
"DynamicThreadPool.html#createAndSetupDynamicWorkerNode" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>create
<wbr/>And
<wbr/>Setup
<wbr/>Dynamic
<wbr/>Worker
<wbr/>Node
</span></a>
31 <a href=
"DynamicThreadPool.html#createAndSetupWorkerNode" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>create
<wbr/>And
<wbr/>Setup
<wbr/>Worker
<wbr/>Node
</span></a>
32 <a href=
"DynamicThreadPool.html#createWorker" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>create
<wbr/>Worker
</span></a>
33 <a href=
"DynamicThreadPool.html#deregisterWorkerMessageListener" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>deregister
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span></a>
34 <a href=
"DynamicThreadPool.html#destroy" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>destroy
</span></a>
35 <a href=
"DynamicThreadPool.html#destroyWorkerNode" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>destroy
<wbr/>Worker
<wbr/>Node
</span></a>
36 <a href=
"DynamicThreadPool.html#enableTasksQueue" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>enable
<wbr/>Tasks
<wbr/>Queue
</span></a>
37 <a href=
"DynamicThreadPool.html#execute" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>execute
</span></a>
38 <a href=
"DynamicThreadPool.html#flagWorkerNodeAsNotReady" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>flag
<wbr/>Worker
<wbr/>Node
<wbr/>As
<wbr/>Not
<wbr/>Ready
</span></a>
39 <a href=
"DynamicThreadPool.html#flushTasksQueue" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>flush
<wbr/>Tasks
<wbr/>Queue
</span></a>
40 <a href=
"DynamicThreadPool.html#getWorkerInfo" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>get
<wbr/>Worker
<wbr/>Info
</span></a>
41 <a href=
"DynamicThreadPool.html#hasTaskFunction" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>has
<wbr/>Task
<wbr/>Function
</span></a>
42 <a href=
"DynamicThreadPool.html#hasWorkerNodeBackPressure" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>has
<wbr/>Worker
<wbr/>Node
<wbr/>Back
<wbr/>Pressure
</span></a>
43 <a href=
"DynamicThreadPool.html#internalBusy" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>internal
<wbr/>Busy
</span></a>
44 <a href=
"DynamicThreadPool.html#isMain" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>is
<wbr/>Main
</span></a>
45 <a href=
"DynamicThreadPool.html#listTaskFunctionNames" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>list
<wbr/>Task
<wbr/>Function
<wbr/>Names
</span></a>
46 <a href=
"DynamicThreadPool.html#registerOnceWorkerMessageListener" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>register
<wbr/>Once
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span></a>
47 <a href=
"DynamicThreadPool.html#registerWorkerMessageListener" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>register
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span></a>
48 <a href=
"DynamicThreadPool.html#removeTaskFunction" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>remove
<wbr/>Task
<wbr/>Function
</span></a>
49 <a href=
"DynamicThreadPool.html#sendKillMessageToWorker" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>send
<wbr/>Kill
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span></a>
50 <a href=
"DynamicThreadPool.html#sendStartupMessageToWorker" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>send
<wbr/>Startup
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span></a>
51 <a href=
"DynamicThreadPool.html#sendToWorker" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>send
<wbr/>To
<wbr/>Worker
</span></a>
52 <a href=
"DynamicThreadPool.html#setDefaultTaskFunction" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>set
<wbr/>Default
<wbr/>Task
<wbr/>Function
</span></a>
53 <a href=
"DynamicThreadPool.html#setTasksQueueOptions" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span></a>
54 <a href=
"DynamicThreadPool.html#setWorkerChoiceStrategy" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
</span></a>
55 <a href=
"DynamicThreadPool.html#setWorkerChoiceStrategyOptions" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Options
</span></a>
56 <a href=
"DynamicThreadPool.html#setupHook" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>setup
<wbr/>Hook
</span></a>
57 <a href=
"DynamicThreadPool.html#start" class=
"tsd-index-link tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>start
</span></a>
58 <a href=
"DynamicThreadPool.html#workerMessageListener" class=
"tsd-index-link tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>worker
<wbr/>Message
<wbr/>Listener
</span></a>
59 </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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"constructor.new_DynamicThreadPool" class=
"tsd-anchor"></a><span class=
"tsd-kind-constructor-signature">new
<wbr/>Dynamic
<wbr/>Thread
<wbr/>Pool
</span><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type tsd-kind-type-parameter">Data
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type tsd-kind-type-parameter">Response
</span><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">min
</span>,
<span class=
"tsd-kind-parameter">max
</span>,
<span class=
"tsd-kind-parameter">filePath
</span>,
<span class=
"tsd-kind-parameter">opts
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><a href=
"DynamicThreadPool.html" class=
"tsd-signature-type tsd-kind-class">DynamicThreadPool
</a><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type tsd-kind-type-parameter">Data
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type tsd-kind-type-parameter">Response
</span><span class=
"tsd-signature-symbol">></span><a href=
"#constructor.new_DynamicThreadPool" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Constructs a new poolifier dynamic thread pool.
</p>
60 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><h4><span class=
"tsd-kind-type-parameter">Data
</span> =
<span class=
"tsd-signature-type">unknown
</span></h4></li><li><h4><span class=
"tsd-kind-type-parameter">Response
</span> =
<span class=
"tsd-signature-type">unknown
</span></h4></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">min
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>Minimum number of threads which are always active.
</p>
61 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><span class=
"tsd-kind-parameter">max
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>Maximum number of threads that can be created by this pool.
</p>
62 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><span class=
"tsd-kind-parameter">filePath
</span>:
<span class=
"tsd-signature-type">string
</span></h5><div class=
"tsd-comment tsd-typography"><p>Path to an implementation of a
<code>ThreadWorker
</code> file, which can be relative or absolute.
</p>
63 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><span class=
"tsd-kind-parameter">opts
</span>:
<a href=
"../interfaces/ThreadPoolOptions.html" class=
"tsd-signature-type tsd-kind-interface">ThreadPoolOptions
</a><span class=
"tsd-signature-symbol"> = {}
</span></h5><div class=
"tsd-comment tsd-typography"><p>Options for this dynamic thread pool.
</p>
64 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a href=
"DynamicThreadPool.html" class=
"tsd-signature-type tsd-kind-class">DynamicThreadPool
</a><span class=
"tsd-signature-symbol"><</span><span class=
"tsd-signature-type tsd-kind-type-parameter">Data
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type tsd-kind-type-parameter">Response
</span><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Overrides
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#constructor">constructor
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/dynamic.ts#L28">src/pools/thread/dynamic.ts:
28</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-inherited"><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=
"#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.
65 The async tracking tooling identifier is
<code>poolifier:
<PoolType
>-
<WorkerType
>-pool
</code>.
</p>
66 <p>Events that can currently be listened to:
</p>
68 <li><code>'ready
'</code>: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
</li>
69 <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>
70 <li><code>'full
'</code>: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
</li>
71 <li><code>'destroy
'</code>: Emitted when the pool is destroyed.
</li>
72 <li><code>'error
'</code>: Emitted when an uncaught error occurs.
</li>
73 <li><code>'taskError
'</code>: Emitted when an error occurs while executing a task.
</li>
74 <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>
76 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#emitter">emitter
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L78">src/pools/abstract-pool.ts:
78</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#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>
77 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#filePath">filePath
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L141">src/pools/abstract-pool.ts:
141</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"max" 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>max
</span><a href=
"#max" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">max
</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 threads that can be created by this pool.
</p>
78 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#max">max
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/dynamic.ts#L30">src/pools/thread/dynamic.ts:
30</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"numberOfWorkers" 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>number
<wbr/>Of
<wbr/>Workers
</span><a href=
"#numberOfWorkers" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">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>Number of workers that this pool should manage.
</p>
79 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#numberOfWorkers">numberOfWorkers
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/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 tsd-is-inherited"><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=
"#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/ThreadPoolOptions.html" class=
"tsd-signature-type tsd-kind-interface">ThreadPoolOptions
</a><span class=
"tsd-signature-symbol"> = {}
</span></div><div class=
"tsd-comment tsd-typography"><p>Options for this fixed thread pool.
</p>
80 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#opts">opts
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/fixed.ts#L49">src/pools/thread/fixed.ts:
49</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#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><span class=
"tsd-signature-type tsd-kind-type-parameter">Response
</span><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>
82 <li><code>key
</code>: The message id of each submitted task.
</li>
83 <li><code>value
</code>: An object that contains the worker, the execution response promise resolve and reject callbacks.
</li>
85 <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>
86 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#promiseResponseMap">promiseResponseMap
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L92">src/pools/abstract-pool.ts:
92</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"workerChoiceStrategyContext" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</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=
"#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><span class=
"tsd-signature-type ">Worker
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type tsd-kind-type-parameter">Data
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type tsd-kind-type-parameter">Response
</span><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>
87 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#workerChoiceStrategyContext">workerChoiceStrategyContext
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L98">src/pools/abstract-pool.ts:
98</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><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=
"#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><span class=
"tsd-signature-type ">Worker
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type tsd-kind-type-parameter">Data
</span><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>
88 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#workerNodes">workerNodes
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L75">src/pools/abstract-pool.ts:
75</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> <span>busy
</span><a href=
"#busy" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#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-symbol">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>
89 <p>The pool busyness boolean status.
</p>
90 </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"><p>Overrides FixedThreadPool.busy
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/dynamic.ts#L44">src/pools/thread/dynamic.ts:
44</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><li class=
"tsd-signature" id=
"full.full-1"><span class=
"tsd-signature-symbol">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>
91 <p>The pool filling boolean status.
</p>
92 </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"><p>Inherited from FixedThreadPool.full
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L675">src/pools/abstract-pool.ts:
675</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><li class=
"tsd-signature" id=
"info.info-1"><span class=
"tsd-signature-symbol">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>
93 </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>Inherited from FixedThreadPool.info
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L286">src/pools/abstract-pool.ts:
286</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"maxSize" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>max
<wbr/>Size
</span><a href=
"#maxSize" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><li class=
"tsd-signature" id=
"maxSize.maxSize-1"><span class=
"tsd-signature-symbol">get
</span> maxSize
<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 pool maximum size.
</p>
94 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from FixedThreadPool.maxSize
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L499">src/pools/abstract-pool.ts:
499</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"minSize" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>min
<wbr/>Size
</span><a href=
"#minSize" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><li class=
"tsd-signature" id=
"minSize.minSize-1"><span class=
"tsd-signature-symbol">get
</span> minSize
<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 pool minimum size.
</p>
95 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from FixedThreadPool.minSize
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L492">src/pools/abstract-pool.ts:
492</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private tsd-is-inherited"><li class=
"tsd-signature" id=
"ready.ready-1"><span class=
"tsd-signature-symbol">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>
96 </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"><p>Inherited from FixedThreadPool.ready
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L444">src/pools/abstract-pool.ts:
444</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> <span>type
</span><a href=
"#type" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#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-symbol">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>
97 <p>If it is
<code>'dynamic
'</code>, it provides the
<code>max
</code> property.
</p>
98 </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"><p>Overrides FixedThreadPool.type
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/dynamic.ts#L39">src/pools/thread/dynamic.ts:
39</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private tsd-is-inherited"><li class=
"tsd-signature" id=
"utilization.utilization-1"><span class=
"tsd-signature-symbol">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>
99 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><p>The pool utilization.
</p>
100 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from FixedThreadPool.utilization
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L461">src/pools/abstract-pool.ts:
461</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"worker" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>worker
</span><a href=
"#worker" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><li class=
"tsd-signature" id=
"worker.worker-1"><span class=
"tsd-signature-symbol">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>
101 </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"><p>Inherited from FixedThreadPool.worker
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/fixed.ts#L151">src/pools/thread/fixed.ts:
151</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 tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Adds a task function to this pool.
102 If a task function with the same name already exists, it will be overwritten.
</p>
103 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></h5><div class=
"tsd-comment tsd-typography"><p>The name of the task function.
</p>
104 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><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><span class=
"tsd-signature-type tsd-kind-type-parameter">Data
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type tsd-kind-type-parameter">Response
</span><span class=
"tsd-signature-symbol">></span></h5><div class=
"tsd-comment tsd-typography"><p>The task function.
</p>
105 </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">boolean
</span><span class=
"tsd-signature-symbol">></span></h4><p><code>true
</code> if the task function was added,
<code>false
</code> otherwise.
</p>
106 <div class=
"tsd-comment tsd-typography"><h4>Throws
</h4><p><a href=
"https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror
</a> If the
<code>name
</code> parameter is not a string or an empty string.
</p>
107 <h4>Throws
</h4><p><a href=
"https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror
</a> If the
<code>fn
</code> parameter is not a function.
</p>
108 </div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#addTaskFunction">addTaskFunction
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L820">src/pools/abstract-pool.ts:
820</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Hook executed after the worker task execution.
109 Can be overridden.
</p>
110 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
111 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><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><span class=
"tsd-signature-type tsd-kind-type-parameter">Response
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></h5><div class=
"tsd-comment tsd-typography"><p>The received message.
</p>
112 </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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#afterTaskExecutionHook">afterTaskExecutionHook
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L1090">src/pools/abstract-pool.ts:
1090</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#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.
113 Can be overridden.
</p>
114 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>The newly created worker node key.
</p>
115 </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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#afterWorkerNodeSetup">afterWorkerNodeSetup
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L1404">src/pools/abstract-pool.ts:
1404</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Hook executed before the worker task execution.
116 Can be overridden.
</p>
117 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
118 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><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><span class=
"tsd-signature-type tsd-kind-type-parameter">Data
</span><span class=
"tsd-signature-symbol">></span></h5><div class=
"tsd-comment tsd-typography"><p>The task to execute.
</p>
119 </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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#beforeTaskExecutionHook">beforeTaskExecutionHook
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L1060">src/pools/abstract-pool.ts:
1060</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#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>
120 </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>
121 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#createAndSetupDynamicWorkerNode">createAndSetupDynamicWorkerNode
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L1308">src/pools/abstract-pool.ts:
1308</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#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>
122 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><p>New, completely set up worker node key.
</p>
123 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#createAndSetupWorkerNode">createAndSetupWorkerNode
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L1263">src/pools/abstract-pool.ts:
1263</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"createWorker" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>create
<wbr/>Worker
</span><a href=
"#createWorker" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><li class=
"tsd-signature tsd-anchor-link"><a id=
"createWorker.createWorker-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">create
<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 ">Worker
</span><a href=
"#createWorker.createWorker-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Creates a new worker.
</p>
124 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type ">Worker
</span></h4><p>Newly created worker.
</p>
125 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#createWorker">createWorker
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/fixed.ts#L138">src/pools/thread/fixed.ts:
138</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"deregisterWorkerMessageListener" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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><span class=
"tsd-signature-type tsd-kind-type-parameter">Message
</span><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=
"#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>
126 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><h4><span class=
"tsd-kind-type-parameter">Message
</span></h4></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
127 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><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></h5><div class=
"tsd-comment tsd-typography"><p>The message listener callback.
</p>
128 </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><h5><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><span class=
"tsd-signature-type tsd-kind-type-parameter">Message
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></h5></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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#deregisterWorkerMessageListener">deregisterWorkerMessageListener
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/fixed.ts#L128">src/pools/thread/fixed.ts:
128</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Terminates all workers in this pool.
</p>
129 </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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#destroy">destroy
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L983">src/pools/abstract-pool.ts:
983</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#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>
130 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
131 </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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#destroyWorkerNode">destroyWorkerNode
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/fixed.ts#L60">src/pools/thread/fixed.ts:
60</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Enables/disables the worker node tasks queue in this pool.
</p>
132 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">enable
</span>:
<span class=
"tsd-signature-type">boolean
</span></h5><div class=
"tsd-comment tsd-typography"><p>Whether to enable or disable the worker node tasks queue.
</p>
133 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><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></h5><div class=
"tsd-comment tsd-typography"><p>The worker node tasks queue options.
</p>
134 </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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#enableTasksQueue">enableTasksQueue
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/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-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><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><span class=
"tsd-signature-type tsd-kind-type-parameter">Response
</span><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Executes the specified function in the worker constructor with the task data input parameter.
</p>
135 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">data
</span>:
<span class=
"tsd-signature-type tsd-kind-type-parameter">Data
</span></h5><div class=
"tsd-comment tsd-typography"><p>The optional task input data for the specified task function. This can only be structured-cloneable data.
</p>
136 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></h5><div class=
"tsd-comment tsd-typography"><p>The optional name of the task function to execute. If not specified, the default task function will be executed.
</p>
137 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><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></h5><div class=
"tsd-comment tsd-typography"><p>An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool
's worker_threads worker and they should not be used in the main thread afterwards.
</p>
138 </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 tsd-kind-type-parameter">Response
</span><span class=
"tsd-signature-symbol">></span></h4><p>Promise that will be fulfilled when the task is completed.
</p>
139 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#execute">execute
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L894">src/pools/abstract-pool.ts:
894</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#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><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#flagWorkerNodeAsNotReady">flagWorkerNodeAsNotReady
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L1837">src/pools/abstract-pool.ts:
1837</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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">void
</span><a href=
"#flushTasksQueue.flushTasksQueue-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#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><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#flushTasksQueue">flushTasksQueue
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L1884">src/pools/abstract-pool.ts:
1884</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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><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=
"#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>
140 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
141 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a href=
"../interfaces/WorkerInfo.html" class=
"tsd-signature-type tsd-kind-interface">WorkerInfo
</a></h4><p>The worker information.
</p>
142 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#getWorkerInfo">getWorkerInfo
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L1796">src/pools/abstract-pool.ts:
1796</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Whether the specified task function exists in this pool.
</p>
143 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></h5><div class=
"tsd-comment tsd-typography"><p>The name of the task function.
</p>
144 </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 task function exists,
<code>false
</code> otherwise.
</p>
145 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#hasTaskFunction">hasTaskFunction
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L807">src/pools/abstract-pool.ts:
807</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><a id=
"hasWorkerNodeBackPressure" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>has
<wbr/>Worker
<wbr/>Node
<wbr/>Back
<wbr/>Pressure
</span><a href=
"#hasWorkerNodeBackPressure" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><li class=
"tsd-signature tsd-anchor-link"><a id=
"hasWorkerNodeBackPressure.hasWorkerNodeBackPressure-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">has
<wbr/>Worker
<wbr/>Node
<wbr/>Back
<wbr/>Pressure
</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=
"#hasWorkerNodeBackPressure.hasWorkerNodeBackPressure-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><code class=
"tsd-tag ts-flagInternal">Internal
</code> <div class=
"tsd-comment tsd-typography"><p>Whether the worker node has back pressure (i.e. its tasks queue is full).
</p>
146 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
147 </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 has back pressure,
<code>false
</code> otherwise.
</p>
148 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#hasWorkerNodeBackPressure">hasWorkerNodeBackPressure
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L1842">src/pools/abstract-pool.ts:
1842</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#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>
149 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><p>Worker nodes busyness boolean status.
</p>
150 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#internalBusy">internalBusy
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L691">src/pools/abstract-pool.ts:
691</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"isMain" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</code> <span>is
<wbr/>Main
</span><a href=
"#isMain" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#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>
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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#isMain">isMain
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/fixed.ts#L55">src/pools/thread/fixed.ts:
55</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Lists the names of task function available in this pool.
</p>
152 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">string
</span><span class=
"tsd-signature-symbol">[]
</span></h4><p>The names of task function available in this pool.
</p>
153 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#listTaskFunctionNames">listTaskFunctionNames
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L859">src/pools/abstract-pool.ts:
859</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"registerOnceWorkerMessageListener" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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><span class=
"tsd-signature-type tsd-kind-type-parameter">Message
</span><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=
"#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>
154 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><h4><span class=
"tsd-kind-type-parameter">Message
</span></h4></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
155 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><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></h5><div class=
"tsd-comment tsd-typography"><p>The message listener callback.
</p>
156 </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><h5><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><span class=
"tsd-signature-type tsd-kind-type-parameter">Message
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></h5></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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#registerOnceWorkerMessageListener">registerOnceWorkerMessageListener
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/fixed.ts#L118">src/pools/thread/fixed.ts:
118</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"registerWorkerMessageListener" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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><span class=
"tsd-signature-type tsd-kind-type-parameter">Message
</span><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=
"#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>
157 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><h4><span class=
"tsd-kind-type-parameter">Message
</span></h4></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
158 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><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></h5><div class=
"tsd-comment tsd-typography"><p>The message listener callback.
</p>
159 </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><h5><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><span class=
"tsd-signature-type tsd-kind-type-parameter">Message
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></h5></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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#registerWorkerMessageListener">registerWorkerMessageListener
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/fixed.ts#L108">src/pools/thread/fixed.ts:
108</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Removes a task function from this pool.
</p>
160 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></h5><div class=
"tsd-comment tsd-typography"><p>The name of the task function.
</p>
161 </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">boolean
</span><span class=
"tsd-signature-symbol">></span></h4><p><code>true
</code> if the task function was removed,
<code>false
</code> otherwise.
</p>
162 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#removeTaskFunction">removeTaskFunction
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L843">src/pools/abstract-pool.ts:
843</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"sendKillMessageToWorker" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#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><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5></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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#sendKillMessageToWorker">sendKillMessageToWorker
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L1007">src/pools/abstract-pool.ts:
1007</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"sendStartupMessageToWorker" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#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>
163 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
164 </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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#sendStartupMessageToWorker">sendStartupMessageToWorker
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/fixed.ts#L93">src/pools/thread/fixed.ts:
93</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id=
"sendToWorker" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagProtected">Protected
</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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#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>
165 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">workerNodeKey
</span>:
<span class=
"tsd-signature-type">number
</span></h5><div class=
"tsd-comment tsd-typography"><p>The worker node key.
</p>
166 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><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><span class=
"tsd-signature-type tsd-kind-type-parameter">Data
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></h5><div class=
"tsd-comment tsd-typography"><p>The message.
</p>
167 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><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></h5><div class=
"tsd-comment tsd-typography"><p>The optional array of transferable objects.
</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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#sendToWorker">sendToWorker
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/thread/fixed.ts#L79">src/pools/thread/fixed.ts:
79</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Sets the default task function in this pool.
</p>
169 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">name
</span>:
<span class=
"tsd-signature-type">string
</span></h5><div class=
"tsd-comment tsd-typography"><p>The name of the task function.
</p>
170 </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">boolean
</span><span class=
"tsd-signature-symbol">></span></h4><p><code>true
</code> if the default task function was set,
<code>false
</code> otherwise.
</p>
171 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#setDefaultTaskFunction">setDefaultTaskFunction
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L872">src/pools/abstract-pool.ts:
872</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Sets the worker node tasks queue options in this pool.
</p>
172 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">tasksQueueOptions
</span>:
<a href=
"../interfaces/TasksQueueOptions.html" class=
"tsd-signature-type tsd-kind-interface">TasksQueueOptions
</a></h5><div class=
"tsd-comment tsd-typography"><p>The worker node tasks queue options.
</p>
173 </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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#setTasksQueueOptions">setTasksQueueOptions
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L591">src/pools/abstract-pool.ts:
591</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Sets the worker choice strategy in this pool.
</p>
174 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><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></h5><div class=
"tsd-comment tsd-typography"><p>The worker choice strategy.
</p>
175 </div><div class=
"tsd-comment tsd-typography"></div></li><li><h5><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></h5><div class=
"tsd-comment tsd-typography"><p>The worker choice strategy options.
</p>
176 </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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#setWorkerChoiceStrategy">setWorkerChoiceStrategy
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L544">src/pools/abstract-pool.ts:
544</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Sets the worker choice strategy options in this pool.
</p>
177 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><span class=
"tsd-kind-parameter">workerChoiceStrategyOptions
</span>:
<a href=
"../interfaces/WorkerChoiceStrategyOptions.html" class=
"tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions
</a></h5><div class=
"tsd-comment tsd-typography"><p>The worker choice strategy options.
</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"></div><aside class=
"tsd-sources"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#setWorkerChoiceStrategyOptions">setWorkerChoiceStrategyOptions
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/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-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#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.
179 Can be overridden.
</p>
180 </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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#setupHook">setupHook
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L1044">src/pools/abstract-pool.ts:
1044</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Starts the minimum number of workers in this pool.
</p>
181 </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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#start">start
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L958">src/pools/abstract-pool.ts:
958</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><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=
"#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-protected tsd-is-inherited"><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=
"#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>
182 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><h5><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><span class=
"tsd-signature-type tsd-kind-type-parameter">Response
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">unknown
</span><span class=
"tsd-signature-symbol">></span></h5></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"><p>Inherited from
<a href=
"FixedThreadPool.html">FixedThreadPool
</a>.
<a href=
"FixedThreadPool.html#workerMessageListener">workerMessageListener
</a></p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d727d87/src/pools/abstract-pool.ts#L1686">src/pools/abstract-pool.ts:
1686</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=
"#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=
"#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=
"#icon-512"></use></svg><span>constructor
</span></a></li><li><a href=
"#emitter" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>emitter
</span></a></li><li><a href=
"#filePath" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>file
<wbr/>Path
</span></a></li><li><a href=
"#max" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>max
</span></a></li><li><a href=
"#numberOfWorkers" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>number
<wbr/>Of
<wbr/>Workers
</span></a></li><li><a href=
"#opts" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>opts
</span></a></li><li><a href=
"#promiseResponseMap" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>promise
<wbr/>Response
<wbr/>Map
</span></a></li><li><a href=
"#workerChoiceStrategyContext" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-1024"></use></svg><span>worker
<wbr/>Choice
<wbr/>Strategy
<wbr/>Context
</span></a></li><li><a href=
"#workerNodes" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#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=
"#icon-262144"></use></svg><span>busy
</span></a></li><li><a href=
"#full" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>full
</span></a></li><li><a href=
"#info" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>info
</span></a></li><li><a href=
"#maxSize" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>max
<wbr/>Size
</span></a></li><li><a href=
"#minSize" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>min
<wbr/>Size
</span></a></li><li><a href=
"#ready" class=
"tsd-is-private tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#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=
"#icon-262144"></use></svg><span>type
</span></a></li><li><a href=
"#utilization" class=
"tsd-is-private tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>utilization
</span></a></li><li><a href=
"#worker" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-262144"></use></svg><span>worker
</span></a></li><li><a href=
"#addTaskFunction" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>add
<wbr/>Task
<wbr/>Function
</span></a></li><li><a href=
"#afterTaskExecutionHook" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>after
<wbr/>Task
<wbr/>Execution
<wbr/>Hook
</span></a></li><li><a href=
"#afterWorkerNodeSetup" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>after
<wbr/>Worker
<wbr/>Node
<wbr/>Setup
</span></a></li><li><a href=
"#beforeTaskExecutionHook" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>before
<wbr/>Task
<wbr/>Execution
<wbr/>Hook
</span></a></li><li><a href=
"#createAndSetupDynamicWorkerNode" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#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 tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>create
<wbr/>And
<wbr/>Setup
<wbr/>Worker
<wbr/>Node
</span></a></li><li><a href=
"#createWorker" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>create
<wbr/>Worker
</span></a></li><li><a href=
"#deregisterWorkerMessageListener" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>deregister
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span></a></li><li><a href=
"#destroy" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>destroy
</span></a></li><li><a href=
"#destroyWorkerNode" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>destroy
<wbr/>Worker
<wbr/>Node
</span></a></li><li><a href=
"#enableTasksQueue" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>enable
<wbr/>Tasks
<wbr/>Queue
</span></a></li><li><a href=
"#execute" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>execute
</span></a></li><li><a href=
"#flagWorkerNodeAsNotReady" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#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 tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>flush
<wbr/>Tasks
<wbr/>Queue
</span></a></li><li><a href=
"#getWorkerInfo" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>get
<wbr/>Worker
<wbr/>Info
</span></a></li><li><a href=
"#hasTaskFunction" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>has
<wbr/>Task
<wbr/>Function
</span></a></li><li><a href=
"#hasWorkerNodeBackPressure" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>has
<wbr/>Worker
<wbr/>Node
<wbr/>Back
<wbr/>Pressure
</span></a></li><li><a href=
"#internalBusy" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>internal
<wbr/>Busy
</span></a></li><li><a href=
"#isMain" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>is
<wbr/>Main
</span></a></li><li><a href=
"#listTaskFunctionNames" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>list
<wbr/>Task
<wbr/>Function
<wbr/>Names
</span></a></li><li><a href=
"#registerOnceWorkerMessageListener" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#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 tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>register
<wbr/>Worker
<wbr/>Message
<wbr/>Listener
</span></a></li><li><a href=
"#removeTaskFunction" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>remove
<wbr/>Task
<wbr/>Function
</span></a></li><li><a href=
"#sendKillMessageToWorker" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#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 tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>send
<wbr/>Startup
<wbr/>Message
<wbr/>To
<wbr/>Worker
</span></a></li><li><a href=
"#sendToWorker" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>send
<wbr/>To
<wbr/>Worker
</span></a></li><li><a href=
"#setDefaultTaskFunction" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>set
<wbr/>Default
<wbr/>Task
<wbr/>Function
</span></a></li><li><a href=
"#setTasksQueueOptions" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>set
<wbr/>Tasks
<wbr/>Queue
<wbr/>Options
</span></a></li><li><a href=
"#setWorkerChoiceStrategy" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>set
<wbr/>Worker
<wbr/>Choice
<wbr/>Strategy
</span></a></li><li><a href=
"#setWorkerChoiceStrategyOptions" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#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 tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>setup
<wbr/>Hook
</span></a></li><li><a href=
"#start" class=
"tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>start
</span></a></li><li><a href=
"#workerMessageListener" class=
"tsd-is-protected tsd-is-inherited"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-2048"></use></svg><span>worker
<wbr/>Message
<wbr/>Listener
</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=
"#icon-1"></use></svg><span>poolifier - v3.0
.13</span></a><ul class=
"tsd-small-nested-navigation" id=
"tsd-nav-container" data-base=
".."><li><a href=
"AbstractPool.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-128"></use></svg>AbstractPool
</a></li><li><a href=
"AbstractWorker.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-128"></use></svg>AbstractWorker
</a></li><li><a href=
"CircularArray.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-128"></use></svg>CircularArray
</a></li><li><a href=
"ClusterWorker.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-128"></use></svg>ClusterWorker
</a></li><li><a href=
"Deque.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-128"></use></svg>Deque
</a></li><li><a href=
"DynamicClusterPool.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-128"></use></svg>DynamicClusterPool
</a></li><li><a href=
"DynamicThreadPool.html" class=
"current"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-128"></use></svg>DynamicThreadPool
</a></li><li><a href=
"FixedClusterPool.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-128"></use></svg>FixedClusterPool
</a></li><li><a href=
"FixedThreadPool.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-128"></use></svg>FixedThreadPool
</a></li><li><a href=
"Node.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-128"></use></svg>Node
</a></li><li><a href=
"ThreadWorker.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-128"></use></svg>ThreadWorker
</a></li><li><a href=
"WorkerChoiceStrategyContext.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-128"></use></svg>WorkerChoiceStrategyContext
</a></li><li><a href=
"../interfaces/ClusterPoolOptions.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-256"></use></svg>ClusterPoolOptions
</a></li><li><a href=
"../interfaces/EventLoopUtilizationMeasurementStatistics.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-256"></use></svg>EventLoopUtilizationMeasurementStatistics
</a></li><li><a href=
"../interfaces/IPool.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-256"></use></svg>IPool
</a></li><li><a href=
"../interfaces/IWorker.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-256"></use></svg>IWorker
</a></li><li><a href=
"../interfaces/IWorkerChoiceStrategy.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-256"></use></svg>IWorkerChoiceStrategy
</a></li><li><a href=
"../interfaces/IWorkerNode.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-256"></use></svg>IWorkerNode
</a></li><li><a href=
"../interfaces/MeasurementOptions.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-256"></use></svg>MeasurementOptions
</a></li><li><a href=
"../interfaces/MeasurementStatistics.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-256"></use></svg>MeasurementStatistics
</a></li><li><a href=
"../interfaces/MeasurementStatisticsRequirements.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"#icon-256"></use></svg>MeasurementStatisticsRequirements
</a></li><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><svg style=
"display: none"><g id=
"icon-1"><rect fill=
"var(--color-icon-background)" stroke=
"var(--color-ts-namespace)" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"6"></rect><path d=
"M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill=
"var(--color-text)"></path></g><g id=
"icon-2"><rect fill=
"var(--color-icon-background)" stroke=
"var(--color-ts-namespace)" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"6"></rect><path d=
"M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill=
"var(--color-text)"></path></g><g id=
"icon-4"><rect fill=
"var(--color-icon-background)" stroke=
"var(--color-ts-namespace)" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"6"></rect><path d=
"M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill=
"var(--color-text)"></path></g><g id=
"icon-8"><rect fill=
"var(--color-icon-background)" stroke=
"var(--color-ts-enum)" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"6"></rect><path d=
"M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill=
"var(--color-text)"></path></g><g id=
"icon-16"><rect fill=
"var(--color-icon-background)" stroke=
"#FF984D" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"12"></rect><path d=
"M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill=
"var(--color-text)"></path></g><g id=
"icon-32"><rect fill=
"var(--color-icon-background)" stroke=
"var(--color-ts-variable)" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"6"></rect><path d=
"M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill=
"var(--color-text)"></path></g><g id=
"icon-64"><rect fill=
"var(--color-icon-background)" stroke=
"var(--color-ts-function)" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"6"></rect><path d=
"M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill=
"var(--color-text)"></path></g><g id=
"icon-128"><rect fill=
"var(--color-icon-background)" stroke=
"var(--color-ts-class)" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"6"></rect><path d=
"M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill=
"var(--color-text)"></path></g><g id=
"icon-256"><rect fill=
"var(--color-icon-background)" stroke=
"var(--color-ts-interface)" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"6"></rect><path d=
"M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill=
"var(--color-text)"></path></g><g id=
"icon-512"><rect fill=
"var(--color-icon-background)" stroke=
"#4D7FFF" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"12"></rect><path d=
"M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill=
"var(--color-text)"></path></g><g id=
"icon-1024"><rect fill=
"var(--color-icon-background)" stroke=
"#FF984D" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"12"></rect><path d=
"M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill=
"var(--color-text)"></path></g><g id=
"icon-2048"><rect fill=
"var(--color-icon-background)" stroke=
"#FF4DB8" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"12"></rect><path d=
"M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill=
"var(--color-text)"></path></g><g id=
"icon-4096"><rect fill=
"var(--color-icon-background)" stroke=
"var(--color-ts-function)" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"6"></rect><path d=
"M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill=
"var(--color-text)"></path></g><g id=
"icon-8192"><rect fill=
"var(--color-icon-background)" stroke=
"#FF984D" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"12"></rect><path d=
"M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill=
"var(--color-text)"></path></g><g id=
"icon-16384"><rect fill=
"var(--color-icon-background)" stroke=
"#4D7FFF" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"12"></rect><path d=
"M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill=
"var(--color-text)"></path></g><g id=
"icon-32768"><rect fill=
"var(--color-icon-background)" stroke=
"#FF984D" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"12"></rect><path d=
"M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill=
"var(--color-text)"></path></g><g id=
"icon-65536"><rect fill=
"var(--color-icon-background)" stroke=
"var(--color-ts-type-alias)" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"6"></rect><path d=
"M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill=
"var(--color-text)"></path></g><g id=
"icon-131072"><rect fill=
"var(--color-icon-background)" stroke=
"var(--color-ts-type-alias)" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"6"></rect><path d=
"M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill=
"var(--color-text)"></path></g><g id=
"icon-262144"><rect fill=
"var(--color-icon-background)" stroke=
"#FF4D4D" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"12"></rect><path d=
"M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill=
"var(--color-text)"></path></g><g id=
"icon-524288"><rect fill=
"var(--color-icon-background)" stroke=
"#FF4D4D" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"12"></rect><path d=
"M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill=
"var(--color-text)"></path></g><g id=
"icon-1048576"><rect fill=
"var(--color-icon-background)" stroke=
"#FF4D4D" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"12"></rect><path d=
"M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill=
"var(--color-text)"></path></g><g id=
"icon-2097152"><rect fill=
"var(--color-icon-background)" stroke=
"var(--color-ts-type-alias)" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"6"></rect><path d=
"M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill=
"var(--color-text)"></path></g><g id=
"icon-4194304"><rect fill=
"var(--color-icon-background)" stroke=
"#FF4D82" stroke-width=
"1.5" x=
"1" y=
"1" width=
"22" height=
"22" rx=
"12"></rect><path d=
"M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill=
"var(--color-text)"></path></g><g id=
"icon-chevronDown"><path d=
"M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill=
"var(--color-text)"></path></g><g id=
"icon-chevronSmall"><path d=
"M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill=
"var(--color-text)"></path></g><g id=
"icon-menu"><rect x=
"1" y=
"3" width=
"14" height=
"2" fill=
"var(--color-text)"></rect><rect x=
"1" y=
"7" width=
"14" height=
"2" fill=
"var(--color-text)"></rect><rect x=
"1" y=
"11" width=
"14" height=
"2" fill=
"var(--color-text)"></rect></g><g id=
"icon-search"><path d=
"M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill=
"var(--color-text)"></path></g><g id=
"icon-anchor"><g stroke-width=
"2" stroke=
"currentColor" fill=
"none" stroke-linecap=
"round" stroke-linejoin=
"round"><path stroke=
"none" d=
"M0 0h24v24H0z" fill=
"none"></path><path d=
"M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d=
"M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></g></svg></body></html>
repositories / poolifier.git / blob