chore: generate documentation
[poolifier.git] / docs / classes / DynamicThreadPool.html
CommitLineData
3c7c9bd1 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 - v2.6.21</title><meta name="description" content="Documentation for poolifier"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
a76fac14
JB
2<div class="tsd-toolbar-contents container">
3<div class="table-cell" id="tsd-search" data-base="..">
41015374
JB
4<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"><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></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5<div class="field">
6<div id="tsd-toolbar-links"></div></div>
a76fac14
JB
7<ul class="results">
8<li class="state loading">Preparing search index...</li>
3c7c9bd1 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.6.21</a></div>
41015374 10<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"><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></svg></a></div></div></header>
a76fac14 11<div class="container container-main">
ec06e4dd 12<div class="col-content">
a76fac14
JB
13<div class="tsd-page-title">
14<ul class="tsd-breadcrumb">
15<li><a href="../index.html">poolifier</a></li>
16<li><a href="DynamicThreadPool.html">DynamicThreadPool</a></li></ul>
17<h1>Class DynamicThreadPool&lt;Data, Response&gt;</h1></div>
18<section class="tsd-panel tsd-comment">
19<div class="tsd-comment tsd-typography"><p>A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.</p>
20<p>This thread pool creates new threads when the others are busy, up to the maximum number of threads.
ba92b02f 21When 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&#39;s <code>emitter</code>.</p>
15d6dfaf 22</div>
23<div class="tsd-comment tsd-typography">
24<h4>Author</h4><p><a href="https://github.com/pioardi">Alessandro Pio Ardizio</a></p>
a76fac14 25
15d6dfaf 26<h4>Since</h4><p>0.0.1</p>
a76fac14 27</div></section>
fab6d3b5 28<section class="tsd-panel">
a76fac14 29<h4>Type Parameters</h4>
fab6d3b5 30<ul class="tsd-type-parameter-list">
a76fac14 31<li>
3bd6a82e 32<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 33<div class="tsd-comment tsd-typography"><p>Type of data sent to the worker. This can only be structured-cloneable data.</p>
15d6dfaf 34</div>
35<div class="tsd-comment tsd-typography"></div></li>
a76fac14 36<li>
3bd6a82e 37<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 38<div class="tsd-comment tsd-typography"><p>Type of execution response. This can only be structured-cloneable data.</p>
15d6dfaf 39</div>
40<div class="tsd-comment tsd-typography"></div></li></ul></section>
a76fac14
JB
41<section class="tsd-panel tsd-hierarchy">
42<h4>Hierarchy</h4>
43<ul class="tsd-hierarchy">
8d1797ad 44<li><a href="FixedThreadPool.html" class="tsd-signature-type tsd-kind-class">FixedThreadPool</a><span class="tsd-signature-symbol">&lt;</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">&gt;</span>
a76fac14
JB
45<ul class="tsd-hierarchy">
46<li><span class="target">DynamicThreadPool</span></li></ul></li></ul></section><aside class="tsd-sources">
47<ul>
3c7c9bd1 48<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/dynamic.ts#L15">src/pools/thread/dynamic.ts:15</a></li></ul></aside>
a76fac14
JB
49<section class="tsd-panel-group tsd-index-group">
50<section class="tsd-panel tsd-index-panel">
51<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
52<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"><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></svg> Index</h5></summary>
53<div class="tsd-accordion-details">
54<section class="tsd-index-section">
55<h3 class="tsd-index-heading">Constructors</h3>
15d6dfaf 56<div class="tsd-index-list"><a href="DynamicThreadPool.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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></svg><span>constructor</span></a>
a76fac14
JB
57</div></section>
58<section class="tsd-index-section">
59<h3 class="tsd-index-heading">Properties</h3>
15d6dfaf 60<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"><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></svg><span>emitter?</span></a>
61<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>
62<a href="DynamicThreadPool.html#max" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max</span></a>
63<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>
64<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>
65<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>
66<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>
67<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>
a76fac14
JB
68</div></section>
69<section class="tsd-index-section">
70<h3 class="tsd-index-heading">Accessors</h3>
15d6dfaf 71<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"><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></svg><span>busy</span></a>
72<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>
73<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>
74<a href="DynamicThreadPool.html#maxSize" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>max<wbr/>Size</span></a>
75<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>
c914a50e 76<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>
15d6dfaf 77<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>
202bcb6b 78<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>
15d6dfaf 79<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>
a76fac14
JB
80</div></section>
81<section class="tsd-index-section">
82<h3 class="tsd-index-heading">Methods</h3>
15d6dfaf 83<div class="tsd-index-list"><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"><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></svg><span>after<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a>
f04db52f 84<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>
15d6dfaf 85<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>
c914a50e 86<a href="DynamicThreadPool.html#checkDynamicPoolSize" 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>check<wbr/>Dynamic<wbr/>Pool<wbr/>Size</span></a>
f04db52f 87<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>
88<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>
15d6dfaf 89<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>
90<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>
f04db52f 91<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>
15d6dfaf 92<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>
93<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>
f04db52f 94<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>
95<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>
15d6dfaf 96<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>
97<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>
76b46937 98<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>
99<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>
15d6dfaf 100<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>
101<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>
102<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>
103<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>
104<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>
105<a href="DynamicThreadPool.html#workerListener" 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/>Listener</span></a>
a76fac14
JB
106</div></section></div></details></section></section>
107<section class="tsd-panel-group tsd-member-group">
108<h2>Constructors</h2>
3bd6a82e 109<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
15d6dfaf 110<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><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></svg></a></h3>
3bd6a82e 111<ul class="tsd-signatures">
15d6dfaf 112<li class="tsd-signature tsd-anchor-link" id="constructor.new_DynamicThreadPool"><span class="tsd-kind-constructor-signature">new <wbr/>Dynamic<wbr/>Thread<wbr/>Pool</span><span class="tsd-signature-symbol">&lt;</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">&gt;</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">&lt;</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">&gt;</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>
a76fac14
JB
113<li class="tsd-description">
114<div class="tsd-comment tsd-typography"><p>Constructs a new poolifier dynamic thread pool.</p>
115</div>
fab6d3b5 116<section class="tsd-panel">
a76fac14 117<h4>Type Parameters</h4>
fab6d3b5 118<ul class="tsd-type-parameter-list">
a76fac14 119<li>
3bd6a82e 120<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4></li>
a76fac14 121<li>
3bd6a82e 122<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section>
a76fac14
JB
123<div class="tsd-parameters">
124<h4 class="tsd-parameters-title">Parameters</h4>
125<ul class="tsd-parameter-list">
126<li>
3bd6a82e 127<h5><span class="tsd-kind-parameter">min</span>: <span class="tsd-signature-type">number</span></h5>
a76fac14 128<div class="tsd-comment tsd-typography"><p>Minimum number of threads which are always active.</p>
15d6dfaf 129</div>
130<div class="tsd-comment tsd-typography"></div></li>
a76fac14 131<li>
3bd6a82e 132<h5><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></h5>
a76fac14 133<div class="tsd-comment tsd-typography"><p>Maximum number of threads that can be created by this pool.</p>
15d6dfaf 134</div>
135<div class="tsd-comment tsd-typography"></div></li>
a76fac14 136<li>
3bd6a82e 137<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
a76fac14 138<div class="tsd-comment tsd-typography"><p>Path to an implementation of a <code>ThreadWorker</code> file, which can be relative or absolute.</p>
15d6dfaf 139</div>
140<div class="tsd-comment tsd-typography"></div></li>
a76fac14 141<li>
f45a3823 142<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>
a76fac14 143<div class="tsd-comment tsd-typography"><p>Options for this dynamic thread pool.</p>
15d6dfaf 144</div>
145<div class="tsd-comment tsd-typography"></div></li></ul></div>
146<h4 class="tsd-returns-title">Returns <a href="DynamicThreadPool.html" class="tsd-signature-type tsd-kind-class">DynamicThreadPool</a><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4>
147<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
148<p>Overrides <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#constructor">constructor</a></p>
149<ul>
3c7c9bd1 150<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/dynamic.ts#L27">src/pools/thread/dynamic.ts:27</a></li></ul></aside></li></ul></section></section>
a76fac14
JB
151<section class="tsd-panel-group tsd-member-group">
152<h2>Properties</h2>
3bd6a82e 153<section class="tsd-panel tsd-member tsd-is-inherited"><a id="emitter" class="tsd-anchor"></a>
15d6dfaf 154<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</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>
8d1797ad 155<div class="tsd-signature"><span class="tsd-kind-property">emitter</span><span class="tsd-signature-symbol">?:</span> <a href="PoolEmitter.html" class="tsd-signature-type tsd-kind-class">PoolEmitter</a></div>
6c525543 156<div class="tsd-comment tsd-typography"><p>Emitter on which events can be listened to.</p>
157<p>Events that can currently be listened to:</p>
158<ul>
c914a50e 159<li><code>&#39;full&#39;</code>: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.</li>
85c03385 160<li><code>&#39;ready&#39;</code>: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.</li>
c914a50e 161<li><code>&#39;busy&#39;</code>: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.</li>
ccb7d1a7 162<li><code>&#39;error&#39;</code>: Emitted when an uncaught error occurs.</li>
163<li><code>&#39;taskError&#39;</code>: Emitted when an error occurs while executing a task.</li>
6c525543 164</ul>
15d6dfaf 165</div>
166<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
167<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#emitter">emitter</a></p>
168<ul>
3c7c9bd1 169<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L64">src/pools/abstract-pool.ts:64</a></li></ul></aside></section>
184d530f 170<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="filePath" class="tsd-anchor"></a>
15d6dfaf 171<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>
8d1797ad 172<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>
f63918da 173<div class="tsd-comment tsd-typography"><p>Path to the worker file.</p>
15d6dfaf 174</div>
175<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
176<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#filePath">filePath</a></p>
177<ul>
3c7c9bd1 178<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L104">src/pools/abstract-pool.ts:104</a></li></ul></aside></section>
184d530f 179<section class="tsd-panel tsd-member tsd-is-protected"><a id="max" class="tsd-anchor"></a>
15d6dfaf 180<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>
8d1797ad 181<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>
cfc6e8df 182<div class="tsd-comment tsd-typography"><p>Maximum number of threads that can be created by this pool.</p>
15d6dfaf 183</div>
184<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14 185<ul>
3c7c9bd1 186<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/dynamic.ts#L29">src/pools/thread/dynamic.ts:29</a></li></ul></aside></section>
184d530f 187<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="numberOfWorkers" class="tsd-anchor"></a>
15d6dfaf 188<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>
8d1797ad 189<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>
cfc6e8df 190<div class="tsd-comment tsd-typography"><p>Number of workers that this pool should manage.</p>
15d6dfaf 191</div>
192<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
193<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#numberOfWorkers">numberOfWorkers</a></p>
194<ul>
3c7c9bd1 195<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L103">src/pools/abstract-pool.ts:103</a></li></ul></aside></section>
184d530f 196<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="opts" class="tsd-anchor"></a>
15d6dfaf 197<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>
f45a3823 198<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>
199<div class="tsd-comment tsd-typography"><p>Options for this fixed thread pool.</p>
15d6dfaf 200</div>
201<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
202<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#opts">opts</a></p>
203<ul>
3c7c9bd1 204<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/fixed.ts#L48">src/pools/thread/fixed.ts:48</a></li></ul></aside></section>
3bd6a82e 205<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="promiseResponseMap" class="tsd-anchor"></a>
15d6dfaf 206<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>
f04db52f 207<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">&lt;</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">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
208<div class="tsd-comment tsd-typography"><p>The task execution response promise map.</p>
a76fac14 209<ul>
79458fb6 210<li><code>key</code>: The message id of each submitted task.</li>
21402562 211<li><code>value</code>: An object that contains the worker, the execution response promise resolve and reject callbacks.</li>
24c3fcb4 212</ul>
21402562 213<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>
15d6dfaf 214</div>
215<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
79458fb6 216<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#promiseResponseMap">promiseResponseMap</a></p>
a76fac14 217<ul>
3c7c9bd1 218<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L74">src/pools/abstract-pool.ts:74</a></li></ul></aside></section>
3bd6a82e 219<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="workerChoiceStrategyContext" class="tsd-anchor"></a>
15d6dfaf 220<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>
030eb5a3 221<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">&lt;</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">&gt;</span></div>
e604957d 222<div class="tsd-comment tsd-typography"><p>Worker choice strategy context referencing a worker choice algorithm implementation.</p>
15d6dfaf 223</div>
224<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
225<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#workerChoiceStrategyContext">workerChoiceStrategyContext</a></p>
226<ul>
3c7c9bd1 227<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L80">src/pools/abstract-pool.ts:80</a></li></ul></aside></section>
3bd6a82e 228<section class="tsd-panel tsd-member tsd-is-inherited"><a id="workerNodes" class="tsd-anchor"></a>
15d6dfaf 229<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</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>
a6b5c73c 230<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">&lt;</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">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
6c525543 231<div class="tsd-comment tsd-typography"><p>Pool worker nodes.</p>
15d6dfaf 232</div>
233<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
ffc8d144 234<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#workerNodes">workerNodes</a></p>
a76fac14 235<ul>
3c7c9bd1 236<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L61">src/pools/abstract-pool.ts:61</a></li></ul></aside></section></section>
a76fac14
JB
237<section class="tsd-panel-group tsd-member-group">
238<h2>Accessors</h2>
3bd6a82e 239<section class="tsd-panel tsd-member tsd-is-protected"><a id="busy" class="tsd-anchor"></a>
15d6dfaf 240<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>
3bd6a82e 241<ul class="tsd-signatures tsd-is-protected">
a76fac14
JB
242<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>
243<li class="tsd-description">
6c525543 244<div class="tsd-comment tsd-typography"><p>Whether the pool is busy or not.</p>
245<p>The pool busyness boolean status.</p>
246</div>
15d6dfaf 247<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
248<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
249<p>Overrides FixedThreadPool.busy</p>
250<ul>
3c7c9bd1 251<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/dynamic.ts#L48">src/pools/thread/dynamic.ts:48</a></li></ul></aside></li></ul></section>
184d530f 252<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="full" class="tsd-anchor"></a>
15d6dfaf 253<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>
184d530f 254<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
0770fe62 255<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>
a76fac14 256<li class="tsd-description">
6c525543 257<div class="tsd-comment tsd-typography"><p>Whether the pool is full or not.</p>
258<p>The pool filling boolean status.</p>
259</div>
15d6dfaf 260<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
261<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
184d530f 262<p>Inherited from FixedThreadPool.full</p>
0770fe62 263<ul>
3c7c9bd1 264<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L606">src/pools/abstract-pool.ts:606</a></li></ul></aside></li></ul></section>
a2742ce7 265<section class="tsd-panel tsd-member tsd-is-inherited"><a id="info" class="tsd-anchor"></a>
15d6dfaf 266<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>
a2742ce7 267<ul class="tsd-signatures tsd-is-inherited">
268<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>
ffc8d144 269<li class="tsd-description">
a2742ce7 270<div class="tsd-comment tsd-typography"><p>Pool information.</p>
ffc8d144 271</div>
15d6dfaf 272<h4 class="tsd-returns-title">Returns <a href="../interfaces/PoolInfo.html" class="tsd-signature-type tsd-kind-interface">PoolInfo</a></h4>
273<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a2742ce7 274<p>Inherited from FixedThreadPool.info</p>
ffc8d144 275<ul>
3c7c9bd1 276<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L301">src/pools/abstract-pool.ts:301</a></li></ul></aside></li></ul></section>
a2742ce7 277<section class="tsd-panel tsd-member tsd-is-protected"><a id="maxSize" class="tsd-anchor"></a>
15d6dfaf 278<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>
a2742ce7 279<ul class="tsd-signatures tsd-is-protected">
280<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>
0770fe62 281<li class="tsd-description">
f04db52f 282<div class="tsd-comment tsd-typography"><p>The pool maximum size.</p>
0770fe62 283</div>
15d6dfaf 284<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
285<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a2742ce7 286<p>Overrides FixedThreadPool.maxSize</p>
a76fac14 287<ul>
3c7c9bd1 288<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/dynamic.ts#L43">src/pools/thread/dynamic.ts:43</a></li></ul></aside></li></ul></section>
a2742ce7 289<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="minSize" class="tsd-anchor"></a>
15d6dfaf 290<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>
a2742ce7 291<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
292<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>
2c94c3a5 293<li class="tsd-description">
f04db52f 294<div class="tsd-comment tsd-typography"><p>The pool minimum size.</p>
2c94c3a5 295</div>
15d6dfaf 296<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
297<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a2742ce7 298<p>Inherited from FixedThreadPool.minSize</p>
2c94c3a5 299<ul>
3c7c9bd1 300<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/fixed.ts#L130">src/pools/thread/fixed.ts:130</a></li></ul></aside></li></ul></section>
c914a50e 301<section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="ready" class="tsd-anchor"></a>
302<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>
303<ul class="tsd-signatures tsd-is-private tsd-is-inherited">
304<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>
305<li class="tsd-description">
f04db52f 306<div class="tsd-comment tsd-typography"><p>The pool readiness boolean status.</p>
307</div>
308<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
309<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
c914a50e 310<p>Inherited from FixedThreadPool.ready</p>
311<ul>
3c7c9bd1 312<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L444">src/pools/abstract-pool.ts:444</a></li></ul></aside></li></ul></section>
184d530f 313<section class="tsd-panel tsd-member tsd-is-protected"><a id="type" class="tsd-anchor"></a>
15d6dfaf 314<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>
184d530f 315<ul class="tsd-signatures tsd-is-protected">
a2742ce7 316<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">&quot;fixed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dynamic&quot;</span></li>
a76fac14 317<li class="tsd-description">
f04db52f 318<div class="tsd-comment tsd-typography"><p>The pool type.</p>
6c525543 319<p>If it is <code>&#39;dynamic&#39;</code>, it provides the <code>max</code> property.</p>
320</div>
15d6dfaf 321<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;fixed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dynamic&quot;</span></h4>
322<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
323<p>Overrides FixedThreadPool.type</p>
324<ul>
3c7c9bd1 325<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/dynamic.ts#L38">src/pools/thread/dynamic.ts:38</a></li></ul></aside></li></ul></section>
202bcb6b 326<section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="utilization" class="tsd-anchor"></a>
327<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>
328<ul class="tsd-signatures tsd-is-private tsd-is-inherited">
329<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>
330<li class="tsd-description">
f04db52f 331<div class="tsd-comment tsd-typography"><p>The approximate pool utilization.</p>
202bcb6b 332</div>
333<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The pool utilization.</p>
334
335<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
336<p>Inherited from FixedThreadPool.utilization</p>
337<ul>
3c7c9bd1 338<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L461">src/pools/abstract-pool.ts:461</a></li></ul></aside></li></ul></section>
184d530f 339<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="worker" class="tsd-anchor"></a>
15d6dfaf 340<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>
184d530f 341<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
3c7c9bd1 342<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">&quot;thread&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;cluster&quot;</span></li>
184d530f 343<li class="tsd-description">
f04db52f 344<div class="tsd-comment tsd-typography"><p>The worker type.</p>
184d530f 345</div>
3c7c9bd1 346<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;thread&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;cluster&quot;</span></h4>
15d6dfaf 347<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
184d530f 348<p>Inherited from FixedThreadPool.worker</p>
349<ul>
3c7c9bd1 350<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/fixed.ts#L125">src/pools/thread/fixed.ts:125</a></li></ul></aside></li></ul></section></section>
a76fac14
JB
351<section class="tsd-panel-group tsd-member-group">
352<h2>Methods</h2>
3bd6a82e 353<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="afterTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 354<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>
3bd6a82e 355<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 356<li class="tsd-signature tsd-anchor-link" id="afterTaskExecutionHook.afterTaskExecutionHook-1"><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>
ed1ecf09 357<li class="tsd-description">
18ba88e2 358<div class="tsd-comment tsd-typography"><p>Hook executed after the worker task execution.
ed1ecf09
JB
359Can be overridden.</p>
360</div>
361<div class="tsd-parameters">
362<h4 class="tsd-parameters-title">Parameters</h4>
363<ul class="tsd-parameter-list">
364<li>
f04db52f 365<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
366<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 367</div>
368<div class="tsd-comment tsd-typography"></div></li>
ed1ecf09 369<li>
030eb5a3 370<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">&lt;</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">&gt;</span></h5>
79458fb6 371<div class="tsd-comment tsd-typography"><p>The received message.</p>
15d6dfaf 372</div>
373<div class="tsd-comment tsd-typography"></div></li></ul></div>
374<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
375<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
18ba88e2 376<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#afterTaskExecutionHook">afterTaskExecutionHook</a></p>
ed1ecf09 377<ul>
3c7c9bd1 378<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L722">src/pools/abstract-pool.ts:722</a></li></ul></aside></li></ul></section>
f04db52f 379<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="afterWorkerNodeSetup" class="tsd-anchor"></a>
380<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>
3bd6a82e 381<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 382<li class="tsd-signature tsd-anchor-link" id="afterWorkerNodeSetup.afterWorkerNodeSetup-1"><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>
a76fac14 383<li class="tsd-description">
f04db52f 384<div class="tsd-comment tsd-typography"><p>Method hooked up after a worker node has been newly created.
030eb5a3 385Can be overridden.</p>
6c525543 386</div>
a76fac14
JB
387<div class="tsd-parameters">
388<h4 class="tsd-parameters-title">Parameters</h4>
389<ul class="tsd-parameter-list">
390<li>
f04db52f 391<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
392<div class="tsd-comment tsd-typography"><p>The newly created worker node key.</p>
15d6dfaf 393</div>
394<div class="tsd-comment tsd-typography"></div></li></ul></div>
395<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
396<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 397<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#afterWorkerNodeSetup">afterWorkerNodeSetup</a></p>
a76fac14 398<ul>
3c7c9bd1 399<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L951">src/pools/abstract-pool.ts:951</a></li></ul></aside></li></ul></section>
3bd6a82e 400<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="beforeTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 401<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>
3bd6a82e 402<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f05afd16 403<li class="tsd-signature tsd-anchor-link" id="beforeTaskExecutionHook.beforeTaskExecutionHook-1"><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>
ed1ecf09 404<li class="tsd-description">
18ba88e2 405<div class="tsd-comment tsd-typography"><p>Hook executed before the worker task execution.
ed1ecf09
JB
406Can be overridden.</p>
407</div>
408<div class="tsd-parameters">
409<h4 class="tsd-parameters-title">Parameters</h4>
410<ul class="tsd-parameter-list">
411<li>
3bd6a82e 412<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
ffc8d144 413<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 414</div>
f05afd16 415<div class="tsd-comment tsd-typography"></div></li>
416<li>
417<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">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span></h5>
418<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
419</div>
15d6dfaf 420<div class="tsd-comment tsd-typography"></div></li></ul></div>
421<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
422<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
18ba88e2 423<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#beforeTaskExecutionHook">beforeTaskExecutionHook</a></p>
ed1ecf09 424<ul>
3c7c9bd1 425<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L701">src/pools/abstract-pool.ts:701</a></li></ul></aside></li></ul></section>
c914a50e 426<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="checkDynamicPoolSize" class="tsd-anchor"></a>
427<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>check<wbr/>Dynamic<wbr/>Pool<wbr/>Size</span><a href="#checkDynamicPoolSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
428<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
429<li class="tsd-signature tsd-anchor-link" id="checkDynamicPoolSize.checkDynamicPoolSize-1"><span class="tsd-kind-call-signature">check<wbr/>Dynamic<wbr/>Pool<wbr/>Size</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">min</span>, <span class="tsd-kind-parameter">max</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkDynamicPoolSize.checkDynamicPoolSize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
430<li class="tsd-description">
431<div class="tsd-parameters">
432<h4 class="tsd-parameters-title">Parameters</h4>
433<ul class="tsd-parameter-list">
434<li>
435<h5><span class="tsd-kind-parameter">min</span>: <span class="tsd-signature-type">number</span></h5></li>
436<li>
437<h5><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
438<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
439<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#checkDynamicPoolSize">checkDynamicPoolSize</a></p>
440<ul>
3c7c9bd1 441<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L173">src/pools/abstract-pool.ts:173</a></li></ul></aside></li></ul></section>
f04db52f 442<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="createAndSetupDynamicWorkerNode" class="tsd-anchor"></a>
443<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>
3bd6a82e 444<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 445<li class="tsd-signature tsd-anchor-link" id="createAndSetupDynamicWorkerNode.createAndSetupDynamicWorkerNode-1"><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>
a76fac14 446<li class="tsd-description">
f04db52f 447<div class="tsd-comment tsd-typography"><p>Creates a new, completely set up dynamic worker node.</p>
a76fac14 448</div>
f04db52f 449<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>New, completely set up dynamic worker node key.</p>
15d6dfaf 450
451<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 452<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#createAndSetupDynamicWorkerNode">createAndSetupDynamicWorkerNode</a></p>
a76fac14 453<ul>
3c7c9bd1 454<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L900">src/pools/abstract-pool.ts:900</a></li></ul></aside></li></ul></section>
f04db52f 455<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="createAndSetupWorkerNode" class="tsd-anchor"></a>
456<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>
3bd6a82e 457<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 458<li class="tsd-signature tsd-anchor-link" id="createAndSetupWorkerNode.createAndSetupWorkerNode-1"><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>
a76fac14 459<li class="tsd-description">
f04db52f 460<div class="tsd-comment tsd-typography"><p>Creates a new, completely set up worker node.</p>
a76fac14 461</div>
f04db52f 462<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>New, completely set up worker node key.</p>
15d6dfaf 463
464<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 465<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#createAndSetupWorkerNode">createAndSetupWorkerNode</a></p>
a76fac14 466<ul>
3c7c9bd1 467<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L860">src/pools/abstract-pool.ts:860</a></li></ul></aside></li></ul></section>
3bd6a82e 468<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="createWorker" class="tsd-anchor"></a>
15d6dfaf 469<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>
3bd6a82e 470<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
030eb5a3 471<li class="tsd-signature tsd-anchor-link" id="createWorker.createWorker-1"><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>
a76fac14 472<li class="tsd-description">
6be0ab6d 473<div class="tsd-comment tsd-typography"><p>Creates a new worker.</p>
6c525543 474</div>
030eb5a3 475<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Worker</span></h4><p>Newly created worker.</p>
6be0ab6d 476
15d6dfaf 477<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
478<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#createWorker">createWorker</a></p>
479<ul>
3c7c9bd1 480<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/fixed.ts#L112">src/pools/thread/fixed.ts:112</a></li></ul></aside></li></ul></section>
3bd6a82e 481<section class="tsd-panel tsd-member tsd-is-inherited"><a id="destroy" class="tsd-anchor"></a>
15d6dfaf 482<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>
3bd6a82e 483<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 484<li class="tsd-signature tsd-anchor-link" id="destroy.destroy-1"><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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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>
a76fac14 485<li class="tsd-description">
f04db52f 486<div class="tsd-comment tsd-typography"><p>Terminates all workers in this pool.</p>
6c525543 487</div>
15d6dfaf 488<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
489<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
490<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#destroy">destroy</a></p>
491<ul>
3c7c9bd1 492<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L664">src/pools/abstract-pool.ts:664</a></li></ul></aside></li></ul></section>
f04db52f 493<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="destroyWorkerNode" class="tsd-anchor"></a>
494<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>
3bd6a82e 495<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 496<li class="tsd-signature tsd-anchor-link" id="destroyWorkerNode.destroyWorkerNode-1"><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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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>
a76fac14 497<li class="tsd-description">
f04db52f 498<div class="tsd-comment tsd-typography"><p>Terminates the worker node given its worker node key.</p>
6c525543 499</div>
a76fac14
JB
500<div class="tsd-parameters">
501<h4 class="tsd-parameters-title">Parameters</h4>
502<ul class="tsd-parameter-list">
503<li>
f04db52f 504<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
505<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 506</div>
507<div class="tsd-comment tsd-typography"></div></li></ul></div>
508<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
509<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 510<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#destroyWorkerNode">destroyWorkerNode</a></p>
a76fac14 511<ul>
3c7c9bd1 512<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/fixed.ts#L59">src/pools/thread/fixed.ts:59</a></li></ul></aside></li></ul></section>
3bd6a82e 513<section class="tsd-panel tsd-member tsd-is-inherited"><a id="enableTasksQueue" class="tsd-anchor"></a>
15d6dfaf 514<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>
3bd6a82e 515<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 516<li class="tsd-signature tsd-anchor-link" id="enableTasksQueue.enableTasksQueue-1"><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>
6047493a 517<li class="tsd-description">
518<div class="tsd-comment tsd-typography"><p>Enables/disables the worker tasks queue in this pool.</p>
519</div>
520<div class="tsd-parameters">
521<h4 class="tsd-parameters-title">Parameters</h4>
522<ul class="tsd-parameter-list">
523<li>
3bd6a82e 524<h5><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></h5>
6047493a 525<div class="tsd-comment tsd-typography"><p>Whether to enable or disable the worker tasks queue.</p>
15d6dfaf 526</div>
527<div class="tsd-comment tsd-typography"></div></li>
6047493a 528<li>
8d1797ad 529<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>
d655c2c2 530<div class="tsd-comment tsd-typography"><p>The worker tasks queue options.</p>
15d6dfaf 531</div>
532<div class="tsd-comment tsd-typography"></div></li></ul></div>
533<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
534<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6047493a 535<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#enableTasksQueue">enableTasksQueue</a></p>
536<ul>
3c7c9bd1 537<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L571">src/pools/abstract-pool.ts:571</a></li></ul></aside></li></ul></section>
3bd6a82e 538<section class="tsd-panel tsd-member tsd-is-inherited"><a id="execute" class="tsd-anchor"></a>
15d6dfaf 539<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>
3bd6a82e 540<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 541<li class="tsd-signature tsd-anchor-link" id="execute.execute-1"><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-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</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>
a76fac14 542<li class="tsd-description">
1bb559f9 543<div class="tsd-comment tsd-typography"><p>Executes the specified function in the worker constructor with the task data input parameter.</p>
6c525543 544</div>
a76fac14
JB
545<div class="tsd-parameters">
546<h4 class="tsd-parameters-title">Parameters</h4>
547<ul class="tsd-parameter-list">
548<li>
3bd6a82e 549<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>
3c7c9bd1 550<div class="tsd-comment tsd-typography"><p>The task input data for the specified task function. This can only be structured-cloneable data.</p>
15d6dfaf 551</div>
552<div class="tsd-comment tsd-typography"></div></li>
2c94c3a5 553<li>
554<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
3c7c9bd1 555<div class="tsd-comment tsd-typography"><p>The name of the task function to execute. If not specified, the default task function will be executed.</p>
15d6dfaf 556</div>
557<div class="tsd-comment tsd-typography"></div></li></ul></div>
fab6d3b5 558<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise that will be fulfilled when the task is completed.</p>
15d6dfaf 559
560<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
561<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#execute">execute</a></p>
562<ul>
3c7c9bd1 563<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L632">src/pools/abstract-pool.ts:632</a></li></ul></aside></li></ul></section>
f04db52f 564<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="flushTasksQueue" class="tsd-anchor"></a>
565<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>
76b46937 566<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 567<li class="tsd-signature tsd-anchor-link" id="flushTasksQueue.flushTasksQueue-1"><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>
76b46937 568<li class="tsd-description">
76b46937 569<div class="tsd-parameters">
570<h4 class="tsd-parameters-title">Parameters</h4>
571<ul class="tsd-parameter-list">
572<li>
f04db52f 573<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
574<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
575<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#flushTasksQueue">flushTasksQueue</a></p>
76b46937 576<ul>
3c7c9bd1 577<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L1161">src/pools/abstract-pool.ts:1161</a></li></ul></aside></li></ul></section>
f04db52f 578<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="getWorkerInfo" class="tsd-anchor"></a>
579<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>
76b46937 580<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 581<li class="tsd-signature tsd-anchor-link" id="getWorkerInfo.getWorkerInfo-1"><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>
76b46937 582<li class="tsd-description">
f04db52f 583<div class="tsd-comment tsd-typography"><p>Gets the worker information given its worker node key.</p>
76b46937 584</div>
585<div class="tsd-parameters">
586<h4 class="tsd-parameters-title">Parameters</h4>
587<ul class="tsd-parameter-list">
588<li>
f04db52f 589<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
590<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
76b46937 591</div>
592<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 593<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>
76b46937 594
595<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 596<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#getWorkerInfo">getWorkerInfo</a></p>
76b46937 597<ul>
3c7c9bd1 598<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L1100">src/pools/abstract-pool.ts:1100</a></li></ul></aside></li></ul></section>
3bd6a82e 599<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="internalBusy" class="tsd-anchor"></a>
15d6dfaf 600<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>
3bd6a82e 601<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 602<li class="tsd-signature tsd-anchor-link" id="internalBusy.internalBusy-1"><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>
a76fac14 603<li class="tsd-description">
6be0ab6d 604<div class="tsd-comment tsd-typography"><p>Whether worker nodes are executing at least one task.</p>
605</div>
606<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Worker nodes busyness boolean status.</p>
607
608<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
0770fe62 609<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#internalBusy">internalBusy</a></p>
a76fac14 610<ul>
3c7c9bd1 611<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L622">src/pools/abstract-pool.ts:622</a></li></ul></aside></li></ul></section>
3bd6a82e 612<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="isMain" class="tsd-anchor"></a>
15d6dfaf 613<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>
3bd6a82e 614<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 615<li class="tsd-signature tsd-anchor-link" id="isMain.isMain-1"><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>
a76fac14 616<li class="tsd-description">
6c525543 617<div class="tsd-comment tsd-typography"><p>Should return whether the worker is the main worker or not.</p>
618</div>
15d6dfaf 619<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
620<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
621<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#isMain">isMain</a></p>
622<ul>
3c7c9bd1 623<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/fixed.ts#L54">src/pools/thread/fixed.ts:54</a></li></ul></aside></li></ul></section>
76b46937 624<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="registerWorkerMessageListener" class="tsd-anchor"></a>
625<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>
626<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 627<li class="tsd-signature tsd-anchor-link" id="registerWorkerMessageListener.registerWorkerMessageListener-1"><span class="tsd-kind-call-signature">register<wbr/>Worker<wbr/>Message<wbr/>Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Message</span><span class="tsd-signature-symbol">&gt;</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>
76b46937 628<li class="tsd-description">
f04db52f 629<div class="tsd-comment tsd-typography"><p>Registers a listener callback on the worker given its worker node key.</p>
76b46937 630</div>
631<section class="tsd-panel">
632<h4>Type Parameters</h4>
633<ul class="tsd-type-parameter-list">
634<li>
635<h4><span class="tsd-kind-type-parameter">Message</span></h4></li></ul></section>
636<div class="tsd-parameters">
637<h4 class="tsd-parameters-title">Parameters</h4>
638<ul class="tsd-parameter-list">
639<li>
f04db52f 640<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
641<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
76b46937 642</div>
643<div class="tsd-comment tsd-typography"></div></li>
644<li>
645<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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
646<div class="tsd-comment tsd-typography"><p>The message listener callback.</p>
647</div>
648<div class="tsd-comment tsd-typography"></div>
649<ul class="tsd-parameters">
650<li class="tsd-parameter-signature">
651<ul class="tsd-signatures">
652<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>
653<li class="tsd-description">
654<div class="tsd-parameters">
655<h4 class="tsd-parameters-title">Parameters</h4>
656<ul class="tsd-parameter-list">
657<li>
658<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">&lt;</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">&gt;</span></h5></li></ul></div>
659<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
660<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
661<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
662<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#registerWorkerMessageListener">registerWorkerMessageListener</a></p>
663<ul>
3c7c9bd1 664<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/fixed.ts#L102">src/pools/thread/fixed.ts:102</a></li></ul></aside></li></ul></section>
76b46937 665<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="sendStartupMessageToWorker" class="tsd-anchor"></a>
666<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>
667<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 668<li class="tsd-signature tsd-anchor-link" id="sendStartupMessageToWorker.sendStartupMessageToWorker-1"><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>
76b46937 669<li class="tsd-description">
f04db52f 670<div class="tsd-comment tsd-typography"><p>Sends the startup message to worker given its worker node key.</p>
76b46937 671</div>
672<div class="tsd-parameters">
673<h4 class="tsd-parameters-title">Parameters</h4>
674<ul class="tsd-parameter-list">
675<li>
f04db52f 676<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
677<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
76b46937 678</div>
679<div class="tsd-comment tsd-typography"></div></li></ul></div>
680<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
681<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
682<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#sendStartupMessageToWorker">sendStartupMessageToWorker</a></p>
683<ul>
3c7c9bd1 684<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/fixed.ts#L86">src/pools/thread/fixed.ts:86</a></li></ul></aside></li></ul></section>
3bd6a82e 685<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="sendToWorker" class="tsd-anchor"></a>
15d6dfaf 686<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>
3bd6a82e 687<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 688<li class="tsd-signature tsd-anchor-link" id="sendToWorker.sendToWorker-1"><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-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>
a76fac14 689<li class="tsd-description">
f04db52f 690<div class="tsd-comment tsd-typography"><p>Sends a message to worker given its worker node key.</p>
6c525543 691</div>
a76fac14
JB
692<div class="tsd-parameters">
693<h4 class="tsd-parameters-title">Parameters</h4>
694<ul class="tsd-parameter-list">
695<li>
f04db52f 696<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
697<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 698</div>
699<div class="tsd-comment tsd-typography"></div></li>
a76fac14 700<li>
030eb5a3 701<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">&lt;</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">&gt;</span></h5>
6c525543 702<div class="tsd-comment tsd-typography"><p>The message.</p>
15d6dfaf 703</div>
704<div class="tsd-comment tsd-typography"></div></li></ul></div>
705<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
706<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
707<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#sendToWorker">sendToWorker</a></p>
708<ul>
3c7c9bd1 709<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/thread/fixed.ts#L76">src/pools/thread/fixed.ts:76</a></li></ul></aside></li></ul></section>
3bd6a82e 710<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setTasksQueueOptions" class="tsd-anchor"></a>
15d6dfaf 711<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>
3bd6a82e 712<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 713<li class="tsd-signature tsd-anchor-link" id="setTasksQueueOptions.setTasksQueueOptions-1"><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>
6047493a 714<li class="tsd-description">
715<div class="tsd-comment tsd-typography"><p>Sets the worker tasks queue options in this pool.</p>
716</div>
717<div class="tsd-parameters">
718<h4 class="tsd-parameters-title">Parameters</h4>
719<ul class="tsd-parameter-list">
720<li>
8d1797ad 721<h5><span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5>
6047493a 722<div class="tsd-comment tsd-typography"><p>The worker tasks queue options.</p>
15d6dfaf 723</div>
724<div class="tsd-comment tsd-typography"></div></li></ul></div>
725<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
726<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6047493a 727<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#setTasksQueueOptions">setTasksQueueOptions</a></p>
728<ul>
3c7c9bd1 729<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L583">src/pools/abstract-pool.ts:583</a></li></ul></aside></li></ul></section>
3bd6a82e 730<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setWorkerChoiceStrategy" class="tsd-anchor"></a>
15d6dfaf 731<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>
3bd6a82e 732<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 733<li class="tsd-signature tsd-anchor-link" id="setWorkerChoiceStrategy.setWorkerChoiceStrategy-1"><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>
a76fac14 734<li class="tsd-description">
6c525543 735<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy in this pool.</p>
736</div>
a76fac14
JB
737<div class="tsd-parameters">
738<h4 class="tsd-parameters-title">Parameters</h4>
739<ul class="tsd-parameter-list">
740<li>
f05afd16 741<h5><span class="tsd-kind-parameter">workerChoiceStrategy</span>: <span class="tsd-signature-type">&quot;ROUND_ROBIN&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;LEAST_USED&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;LEAST_BUSY&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;LEAST_ELU&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;FAIR_SHARE&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;WEIGHTED_ROUND_ROBIN&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;INTERLEAVED_WEIGHTED_ROUND_ROBIN&quot;</span></h5>
6c525543 742<div class="tsd-comment tsd-typography"><p>The worker choice strategy.</p>
15d6dfaf 743</div>
744<div class="tsd-comment tsd-typography"></div></li>
a8aeac44 745<li>
8d1797ad 746<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>
a8aeac44 747<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
15d6dfaf 748</div>
749<div class="tsd-comment tsd-typography"></div></li></ul></div>
750<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
751<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
752<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#setWorkerChoiceStrategy">setWorkerChoiceStrategy</a></p>
753<ul>
3c7c9bd1 754<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L541">src/pools/abstract-pool.ts:541</a></li></ul></aside></li></ul></section>
3bd6a82e 755<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setWorkerChoiceStrategyOptions" class="tsd-anchor"></a>
15d6dfaf 756<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>
3bd6a82e 757<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 758<li class="tsd-signature tsd-anchor-link" id="setWorkerChoiceStrategyOptions.setWorkerChoiceStrategyOptions-1"><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>
6047493a 759<li class="tsd-description">
760<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy options in this pool.</p>
761</div>
762<div class="tsd-parameters">
763<h4 class="tsd-parameters-title">Parameters</h4>
764<ul class="tsd-parameter-list">
765<li>
8d1797ad 766<h5><span class="tsd-kind-parameter">workerChoiceStrategyOptions</span>: <a href="../interfaces/WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></h5>
6047493a 767<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
15d6dfaf 768</div>
769<div class="tsd-comment tsd-typography"></div></li></ul></div>
770<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
771<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6047493a 772<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#setWorkerChoiceStrategyOptions">setWorkerChoiceStrategyOptions</a></p>
773<ul>
3c7c9bd1 774<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L560">src/pools/abstract-pool.ts:560</a></li></ul></aside></li></ul></section>
3bd6a82e 775<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="setupHook" class="tsd-anchor"></a>
15d6dfaf 776<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>
3bd6a82e 777<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 778<li class="tsd-signature tsd-anchor-link" id="setupHook.setupHook-1"><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>
a76fac14 779<li class="tsd-description">
030eb5a3 780<div class="tsd-comment tsd-typography"><p>Setup hook to execute code before worker nodes are created in the abstract constructor.
781Can be overridden.</p>
a76fac14 782</div>
15d6dfaf 783<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
784<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
785<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#setupHook">setupHook</a></p>
786<ul>
3c7c9bd1 787<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L685">src/pools/abstract-pool.ts:685</a></li></ul></aside></li></ul></section>
3bd6a82e 788<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="workerListener" class="tsd-anchor"></a>
15d6dfaf 789<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>worker<wbr/>Listener</span><a href="#workerListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 790<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 791<li class="tsd-signature tsd-anchor-link" id="workerListener.workerListener-1"><span class="tsd-kind-call-signature">worker<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><a href="#workerListener.workerListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 792<li class="tsd-description">
f04db52f 793<div class="tsd-comment tsd-typography"><p>This method is the listener registered for each worker message.</p>
a76fac14 794</div>
fab6d3b5 795<h4 class="tsd-returns-title">Returns <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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4><p>The listener function to execute when a message is received from a worker.</p>
796
a76fac14
JB
797<ul class="tsd-parameters">
798<li class="tsd-parameter-signature">
3bd6a82e 799<ul class="tsd-signatures">
800<li class="tsd-signature" id="workerListener.workerListener-1.__type.__type-1"><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>
a76fac14 801<li class="tsd-description">
f04db52f 802<div class="tsd-comment tsd-typography"><p>This method is the listener registered for each worker message.</p>
a76fac14
JB
803</div>
804<div class="tsd-parameters">
805<h4 class="tsd-parameters-title">Parameters</h4>
806<ul class="tsd-parameter-list">
807<li>
030eb5a3 808<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">&lt;</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">&gt;</span></h5></li></ul></div>
fab6d3b5 809<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>The listener function to execute when a message is received from a worker.</p>
15d6dfaf 810
811<div class="tsd-comment tsd-typography"></div></li></ul></li></ul>
812<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
813<p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#workerListener">workerListener</a></p>
814<ul>
3c7c9bd1 815<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/d9647bd/src/pools/abstract-pool.ts#L1034">src/pools/abstract-pool.ts:1034</a></li></ul></aside></li></ul></section></section></div>
ec06e4dd 816<div class="col-sidebar">
817<div class="page-menu">
a76fac14
JB
818<div class="tsd-navigation settings">
819<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
15d6dfaf 820<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><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)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
a76fac14
JB
821<div class="tsd-accordion-details">
822<div class="tsd-filter-visibility">
823<h4 class="uppercase">Member Visibility</h4><form>
824<ul id="tsd-filter-options">
825<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>
826<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>
827<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>
828<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>
829<div class="tsd-theme-toggle">
3bd6a82e 830<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>
ec06e4dd 831<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 832<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
a76fac14
JB
833<div class="tsd-accordion-details">
834<ul>
15d6dfaf 835<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>
836<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>
837<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>
838<li><a href="#max" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max</span></a></li>
839<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>
840<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>
841<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>
842<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>
843<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>
844<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>
845<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>
846<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>
847<li><a href="#maxSize" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>max<wbr/>Size</span></a></li>
848<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>
c914a50e 849<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>
15d6dfaf 850<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>
202bcb6b 851<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>
15d6dfaf 852<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>
853<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>
f04db52f 854<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>
15d6dfaf 855<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>
c914a50e 856<li><a href="#checkDynamicPoolSize" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Dynamic<wbr/>Pool<wbr/>Size</span></a></li>
f04db52f 857<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>
858<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>
15d6dfaf 859<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>
860<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>
f04db52f 861<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>
15d6dfaf 862<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>
863<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>
f04db52f 864<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>
865<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>
15d6dfaf 866<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>
867<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>
76b46937 868<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>
869<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>
15d6dfaf 870<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>
871<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>
872<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>
873<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>
874<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>
875<li><a href="#workerListener" 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/>Listener</span></a></li></ul></div></details></div>
ec06e4dd 876<div class="site-menu">
3c7c9bd1 877<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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></svg><span>poolifier -<wbr/> v2.6.21</span></a>
ec06e4dd 878<ul class="tsd-small-nested-navigation">
15d6dfaf 879<li><a href="AbstractPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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></svg><span>Abstract<wbr/>Pool</span></a></li>
880<li><a href="AbstractWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Abstract<wbr/>Worker</span></a></li>
881<li><a href="CircularArray.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Circular<wbr/>Array</span></a></li>
882<li><a href="ClusterWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cluster<wbr/>Worker</span></a></li>
883<li><a href="DynamicClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dynamic<wbr/>Cluster<wbr/>Pool</span></a></li>
884<li><a href="DynamicThreadPool.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dynamic<wbr/>Thread<wbr/>Pool</span></a></li>
885<li><a href="FixedClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Fixed<wbr/>Cluster<wbr/>Pool</span></a></li>
886<li><a href="FixedThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Fixed<wbr/>Thread<wbr/>Pool</span></a></li>
887<li><a href="PoolEmitter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Pool<wbr/>Emitter</span></a></li>
888<li><a href="Queue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Queue</span></a></li>
889<li><a href="ThreadWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Thread<wbr/>Worker</span></a></li>
890<li><a href="WorkerChoiceStrategyContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span></a></li>
891<li><a href="../interfaces/ClusterPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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></svg><span>Cluster<wbr/>Pool<wbr/>Options</span></a></li>
f05afd16 892<li><a href="../interfaces/EventLoopUtilizationMeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Event<wbr/>Loop<wbr/>Utilization<wbr/>Measurement<wbr/>Statistics</span></a></li>
15d6dfaf 893<li><a href="../interfaces/IPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IPool</span></a></li>
894<li><a href="../interfaces/IWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker</span></a></li>
895<li><a href="../interfaces/IWorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker<wbr/>Choice<wbr/>Strategy</span></a></li>
a6b5c73c 896<li><a href="../interfaces/IWorkerNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker<wbr/>Node</span></a></li>
f05afd16 897<li><a href="../interfaces/MeasurementOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Measurement<wbr/>Options</span></a></li>
898<li><a href="../interfaces/MeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Measurement<wbr/>Statistics</span></a></li>
899<li><a href="../interfaces/MeasurementStatisticsRequirements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Measurement<wbr/>Statistics<wbr/>Requirements</span></a></li>
15d6dfaf 900<li><a href="../interfaces/MessageValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Message<wbr/>Value</span></a></li>
901<li><a href="../interfaces/PoolInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Pool<wbr/>Info</span></a></li>
902<li><a href="../interfaces/PoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Pool<wbr/>Options</span></a></li>
903<li><a href="../interfaces/PromiseResponseWrapper.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Promise<wbr/>Response<wbr/>Wrapper</span></a></li>
aba8d9bd 904<li><a href="../interfaces/StrategyPolicy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Strategy<wbr/>Policy</span></a></li>
15d6dfaf 905<li><a href="../interfaces/Task.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task</span></a></li>
f05afd16 906<li><a href="../interfaces/TaskError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Error</span></a></li>
71056a0a 907<li><a href="../interfaces/TaskPerformance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Performance</span></a></li>
afa30fd0 908<li><a href="../interfaces/TaskStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Statistics</span></a></li>
f05afd16 909<li><a href="../interfaces/TaskStatisticsRequirements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Statistics<wbr/>Requirements</span></a></li>
15d6dfaf 910<li><a href="../interfaces/TasksQueueOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tasks<wbr/>Queue<wbr/>Options</span></a></li>
f45a3823 911<li><a href="../interfaces/ThreadPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Thread<wbr/>Pool<wbr/>Options</span></a></li>
15d6dfaf 912<li><a href="../interfaces/WorkerChoiceStrategyOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a></li>
ac2cb9e2 913<li><a href="../interfaces/WorkerInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Info</span></a></li>
15d6dfaf 914<li><a href="../interfaces/WorkerOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Options</span></a></li>
71056a0a 915<li><a href="../interfaces/WorkerStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Statistics</span></a></li>
f05afd16 916<li><a href="../interfaces/WorkerUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Usage</span></a></li>
030eb5a3 917<li><a href="../types/ErrorHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><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></svg><span>Error<wbr/>Handler</span></a></li>
15d6dfaf 918<li><a href="../types/ExitHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Exit<wbr/>Handler</span></a></li>
919<li><a href="../types/KillBehavior.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Kill<wbr/>Behavior</span></a></li>
f05afd16 920<li><a href="../types/Measurement.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Measurement</span></a></li>
15d6dfaf 921<li><a href="../types/MessageHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Message<wbr/>Handler</span></a></li>
922<li><a href="../types/OnlineHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Online<wbr/>Handler</span></a></li>
923<li><a href="../types/PoolEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Pool<wbr/>Event</span></a></li>
924<li><a href="../types/PoolType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Pool<wbr/>Type</span></a></li>
3c7c9bd1 925<li><a href="../types/TaskAsyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Async<wbr/>Function</span></a></li>
926<li><a href="../types/TaskFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Function</span></a></li>
15d6dfaf 927<li><a href="../types/TaskFunctions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Functions</span></a></li>
3c7c9bd1 928<li><a href="../types/TaskSyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Sync<wbr/>Function</span></a></li>
15d6dfaf 929<li><a href="../types/WorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy</span></a></li>
15d6dfaf 930<li><a href="../types/WorkerType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Type</span></a></li>
931<li><a href="../variables/KillBehaviors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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></svg><span>Kill<wbr/>Behaviors</span></a></li>
f05afd16 932<li><a href="../variables/Measurements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Measurements</span></a></li>
15d6dfaf 933<li><a href="../variables/PoolEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Pool<wbr/>Events</span></a></li>
934<li><a href="../variables/PoolTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Pool<wbr/>Types</span></a></li>
935<li><a href="../variables/WorkerChoiceStrategies.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategies</span></a></li>
a97f9c80 936<li><a href="../variables/WorkerTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Worker<wbr/>Types</span></a></li>
937<li><a href="../functions/availableParallelism.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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></svg><span>available<wbr/>Parallelism</span></a></li></ul></nav></div></div></div>
ec06e4dd 938<div class="tsd-generator">
a76fac14 939<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
ec06e4dd 940<div class="overlay"></div></body></html>