chore: generate documentation
[poolifier.git] / docs / classes / DynamicClusterPool.html
CommitLineData
3bd6a82e 1<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DynamicClusterPool | poolifier</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>
cfc6e8df 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier</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="DynamicClusterPool.html">DynamicClusterPool</a></li></ul>
17<h1>Class DynamicClusterPool&lt;Data, Response&gt;</h1></div>
18<section class="tsd-panel tsd-comment">
19<div class="tsd-comment tsd-typography"><p>A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.</p>
20<p>This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
ba92b02f 21When the maximum number of workers 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/Shinigami92">Christopher Quadflieg</a></p>
a76fac14 25
15d6dfaf 26<h4>Since</h4><p>2.0.0</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="FixedClusterPool.html" class="tsd-signature-type tsd-kind-class">FixedClusterPool</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">DynamicClusterPool</span></li></ul></li></ul></section><aside class="tsd-sources">
47<ul>
2a663199 48<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/dynamic.ts#L15">src/pools/cluster/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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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>
202bcb6b 76<a href="DynamicClusterPool.html#runTime" 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>run<wbr/>Time</span></a>
15d6dfaf 77<a href="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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="DynamicClusterPool.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>
84<a href="DynamicClusterPool.html#afterWorkerSetup" 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/>Setup</span></a>
85<a href="DynamicClusterPool.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>
6be0ab6d 86<a href="DynamicClusterPool.html#createAndSetupDynamicWorker" 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</span></a>
15d6dfaf 87<a href="DynamicClusterPool.html#createAndSetupWorker" 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</span></a>
88<a href="DynamicClusterPool.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>
89<a href="DynamicClusterPool.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>
90<a href="DynamicClusterPool.html#destroyWorker" 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</span></a>
91<a href="DynamicClusterPool.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>
92<a href="DynamicClusterPool.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>
93<a href="DynamicClusterPool.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>
94<a href="DynamicClusterPool.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>
15d6dfaf 95<a href="DynamicClusterPool.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>
96<a href="DynamicClusterPool.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>
97<a href="DynamicClusterPool.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>
98<a href="DynamicClusterPool.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>
99<a href="DynamicClusterPool.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>
100<a href="DynamicClusterPool.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
101</div></section></div></details></section></section>
102<section class="tsd-panel-group tsd-member-group">
103<h2>Constructors</h2>
3bd6a82e 104<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
15d6dfaf 105<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 106<ul class="tsd-signatures">
15d6dfaf 107<li class="tsd-signature tsd-anchor-link" id="constructor.new_DynamicClusterPool"><span class="tsd-kind-constructor-signature">new <wbr/>Dynamic<wbr/>Cluster<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="DynamicClusterPool.html" class="tsd-signature-type tsd-kind-class">DynamicClusterPool</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_DynamicClusterPool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14
JB
108<li class="tsd-description">
109<div class="tsd-comment tsd-typography"><p>Constructs a new poolifier dynamic cluster pool.</p>
110</div>
fab6d3b5 111<section class="tsd-panel">
a76fac14 112<h4>Type Parameters</h4>
fab6d3b5 113<ul class="tsd-type-parameter-list">
a76fac14 114<li>
3bd6a82e 115<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4></li>
a76fac14 116<li>
3bd6a82e 117<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section>
a76fac14
JB
118<div class="tsd-parameters">
119<h4 class="tsd-parameters-title">Parameters</h4>
120<ul class="tsd-parameter-list">
121<li>
3bd6a82e 122<h5><span class="tsd-kind-parameter">min</span>: <span class="tsd-signature-type">number</span></h5>
a76fac14 123<div class="tsd-comment tsd-typography"><p>Minimum number of workers which are always active.</p>
15d6dfaf 124</div>
125<div class="tsd-comment tsd-typography"></div></li>
a76fac14 126<li>
3bd6a82e 127<h5><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></h5>
a76fac14 128<div class="tsd-comment tsd-typography"><p>Maximum number of workers that can be created by this pool.</p>
15d6dfaf 129</div>
130<div class="tsd-comment tsd-typography"></div></li>
a76fac14 131<li>
3bd6a82e 132<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
a76fac14 133<div class="tsd-comment tsd-typography"><p>Path to an implementation of a <code>ClusterWorker</code> file, which can be relative or absolute.</p>
15d6dfaf 134</div>
135<div class="tsd-comment tsd-typography"></div></li>
a76fac14 136<li>
8d1797ad 137<h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/ClusterPoolOptions.html" class="tsd-signature-type tsd-kind-interface">ClusterPoolOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
a76fac14 138<div class="tsd-comment tsd-typography"><p>Options for this dynamic cluster pool.</p>
15d6dfaf 139</div>
140<div class="tsd-comment tsd-typography"></div></li></ul></div>
141<h4 class="tsd-returns-title">Returns <a href="DynamicClusterPool.html" class="tsd-signature-type tsd-kind-class">DynamicClusterPool</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>
142<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
143<p>Overrides <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#constructor">constructor</a></p>
144<ul>
2a663199 145<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/dynamic.ts#L27">src/pools/cluster/dynamic.ts:27</a></li></ul></aside></li></ul></section></section>
a76fac14
JB
146<section class="tsd-panel-group tsd-member-group">
147<h2>Properties</h2>
3bd6a82e 148<section class="tsd-panel tsd-member tsd-is-inherited"><a id="emitter" class="tsd-anchor"></a>
15d6dfaf 149<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 150<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 151<div class="tsd-comment tsd-typography"><p>Emitter on which events can be listened to.</p>
152<p>Events that can currently be listened to:</p>
153<ul>
154<li><code>&#39;full&#39;</code>: Emitted when the pool is dynamic and full.</li>
155<li><code>&#39;busy&#39;</code>: Emitted when the pool is busy.</li>
ccb7d1a7 156<li><code>&#39;error&#39;</code>: Emitted when an uncaught error occurs.</li>
157<li><code>&#39;taskError&#39;</code>: Emitted when an error occurs while executing a task.</li>
6c525543 158</ul>
15d6dfaf 159</div>
160<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
161<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#emitter">emitter</a></p>
162<ul>
2a663199 163<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L58">src/pools/abstract-pool.ts:58</a></li></ul></aside></section>
184d530f 164<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="filePath" class="tsd-anchor"></a>
15d6dfaf 165<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 166<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 167<div class="tsd-comment tsd-typography"><p>Path to the worker file.</p>
15d6dfaf 168</div>
169<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
170<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#filePath">filePath</a></p>
171<ul>
2a663199 172<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L96">src/pools/abstract-pool.ts:96</a></li></ul></aside></section>
184d530f 173<section class="tsd-panel tsd-member tsd-is-protected"><a id="max" class="tsd-anchor"></a>
15d6dfaf 174<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 175<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 176<div class="tsd-comment tsd-typography"><p>Maximum number of workers that can be created by this pool.</p>
15d6dfaf 177</div>
178<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14 179<ul>
2a663199 180<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/dynamic.ts#L29">src/pools/cluster/dynamic.ts:29</a></li></ul></aside></section>
184d530f 181<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="numberOfWorkers" class="tsd-anchor"></a>
15d6dfaf 182<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 183<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 184<div class="tsd-comment tsd-typography"><p>Number of workers that this pool should manage.</p>
15d6dfaf 185</div>
186<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
187<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#numberOfWorkers">numberOfWorkers</a></p>
188<ul>
2a663199 189<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L95">src/pools/abstract-pool.ts:95</a></li></ul></aside></section>
184d530f 190<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="opts" class="tsd-anchor"></a>
15d6dfaf 191<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>
8d1797ad 192<div class="tsd-signature"><span class="tsd-kind-property">opts</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ClusterPoolOptions.html" class="tsd-signature-type tsd-kind-interface">ClusterPoolOptions</a><span class="tsd-signature-symbol"> = {}</span></div>
cfc6e8df 193<div class="tsd-comment tsd-typography"><p>Options for this fixed cluster pool.</p>
15d6dfaf 194</div>
195<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
196<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#opts">opts</a></p>
197<ul>
2a663199 198<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/fixed.ts#L52">src/pools/cluster/fixed.ts:52</a></li></ul></aside></section>
3bd6a82e 199<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="promiseResponseMap" class="tsd-anchor"></a>
15d6dfaf 200<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>
8d1797ad 201<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 ">Worker</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">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
21402562 202<div class="tsd-comment tsd-typography"><p>The execution response promise map.</p>
a76fac14 203<ul>
79458fb6 204<li><code>key</code>: The message id of each submitted task.</li>
21402562 205<li><code>value</code>: An object that contains the worker, the execution response promise resolve and reject callbacks.</li>
24c3fcb4 206</ul>
21402562 207<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 208</div>
209<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
79458fb6 210<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#promiseResponseMap">promiseResponseMap</a></p>
a76fac14 211<ul>
2a663199 212<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L68">src/pools/abstract-pool.ts:68</a></li></ul></aside></section>
3bd6a82e 213<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="workerChoiceStrategyContext" class="tsd-anchor"></a>
15d6dfaf 214<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>
8d1797ad 215<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 216<div class="tsd-comment tsd-typography"><p>Worker choice strategy context referencing a worker choice algorithm implementation.</p>
15d6dfaf 217</div>
218<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
219<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#workerChoiceStrategyContext">workerChoiceStrategyContext</a></p>
220<ul>
2a663199 221<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L76">src/pools/abstract-pool.ts:76</a></li></ul></aside></section>
3bd6a82e 222<section class="tsd-panel tsd-member tsd-is-inherited"><a id="workerNodes" class="tsd-anchor"></a>
15d6dfaf 223<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>
8d1797ad 224<div class="tsd-signature"><span class="tsd-kind-property">worker<wbr/>Nodes</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/WorkerNode.html" class="tsd-signature-type tsd-kind-interface">WorkerNode</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 225<div class="tsd-comment tsd-typography"><p>Pool worker nodes.</p>
15d6dfaf 226</div>
227<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
ffc8d144 228<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#workerNodes">workerNodes</a></p>
a76fac14 229<ul>
2a663199 230<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L55">src/pools/abstract-pool.ts:55</a></li></ul></aside></section></section>
a76fac14
JB
231<section class="tsd-panel-group tsd-member-group">
232<h2>Accessors</h2>
3bd6a82e 233<section class="tsd-panel tsd-member tsd-is-protected"><a id="busy" class="tsd-anchor"></a>
15d6dfaf 234<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 235<ul class="tsd-signatures tsd-is-protected">
a76fac14
JB
236<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>
237<li class="tsd-description">
6c525543 238<div class="tsd-comment tsd-typography"><p>Whether the pool is busy or not.</p>
239<p>The pool busyness boolean status.</p>
240</div>
15d6dfaf 241<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
242<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
243<p>Overrides FixedClusterPool.busy</p>
244<ul>
2a663199 245<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/dynamic.ts#L47">src/pools/cluster/dynamic.ts:47</a></li></ul></aside></li></ul></section>
184d530f 246<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="full" class="tsd-anchor"></a>
15d6dfaf 247<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 248<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
0770fe62 249<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 250<li class="tsd-description">
6c525543 251<div class="tsd-comment tsd-typography"><p>Whether the pool is full or not.</p>
252<p>The pool filling boolean status.</p>
253</div>
15d6dfaf 254<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
255<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
184d530f 256<p>Inherited from FixedClusterPool.full</p>
0770fe62 257<ul>
2a663199 258<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L441">src/pools/abstract-pool.ts:441</a></li></ul></aside></li></ul></section>
a2742ce7 259<section class="tsd-panel tsd-member tsd-is-inherited"><a id="info" class="tsd-anchor"></a>
15d6dfaf 260<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 261<ul class="tsd-signatures tsd-is-inherited">
262<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 263<li class="tsd-description">
a2742ce7 264<div class="tsd-comment tsd-typography"><p>Pool information.</p>
ffc8d144 265</div>
15d6dfaf 266<h4 class="tsd-returns-title">Returns <a href="../interfaces/PoolInfo.html" class="tsd-signature-type tsd-kind-interface">PoolInfo</a></h4>
267<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a2742ce7 268<p>Inherited from FixedClusterPool.info</p>
ffc8d144 269<ul>
2a663199 270<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L250">src/pools/abstract-pool.ts:250</a></li></ul></aside></li></ul></section>
a2742ce7 271<section class="tsd-panel tsd-member tsd-is-protected"><a id="maxSize" class="tsd-anchor"></a>
15d6dfaf 272<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 273<ul class="tsd-signatures tsd-is-protected">
274<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 275<li class="tsd-description">
a2742ce7 276<div class="tsd-comment tsd-typography"><p>Pool maximum size.</p>
0770fe62 277</div>
15d6dfaf 278<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
279<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a2742ce7 280<p>Overrides FixedClusterPool.maxSize</p>
a76fac14 281<ul>
2a663199 282<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/dynamic.ts#L42">src/pools/cluster/dynamic.ts:42</a></li></ul></aside></li></ul></section>
a2742ce7 283<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="minSize" class="tsd-anchor"></a>
15d6dfaf 284<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 285<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
286<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 287<li class="tsd-description">
a2742ce7 288<div class="tsd-comment tsd-typography"><p>Pool minimum size.</p>
2c94c3a5 289</div>
15d6dfaf 290<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
291<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a2742ce7 292<p>Inherited from FixedClusterPool.minSize</p>
2c94c3a5 293<ul>
2a663199 294<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/fixed.ts#L97">src/pools/cluster/fixed.ts:97</a></li></ul></aside></li></ul></section>
202bcb6b 295<section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="runTime" class="tsd-anchor"></a>
296<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>run<wbr/>Time</span><a href="#runTime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
297<ul class="tsd-signatures tsd-is-private tsd-is-inherited">
298<li class="tsd-signature" id="runTime.runTime-1"><span class="tsd-signature-symbol">get</span> runTime<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>
299<li class="tsd-description">
300<div class="tsd-comment tsd-typography"><p>Gets the pool run time.</p>
301</div>
302<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The pool run time in milliseconds.</p>
303
304<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
305<p>Inherited from FixedClusterPool.runTime</p>
306<ul>
2a663199 307<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L303">src/pools/abstract-pool.ts:303</a></li></ul></aside></li></ul></section>
184d530f 308<section class="tsd-panel tsd-member tsd-is-protected"><a id="type" class="tsd-anchor"></a>
15d6dfaf 309<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 310<ul class="tsd-signatures tsd-is-protected">
a2742ce7 311<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 312<li class="tsd-description">
6c525543 313<div class="tsd-comment tsd-typography"><p>Pool type.</p>
314<p>If it is <code>&#39;dynamic&#39;</code>, it provides the <code>max</code> property.</p>
315</div>
15d6dfaf 316<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>
317<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
318<p>Overrides FixedClusterPool.type</p>
319<ul>
2a663199 320<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/dynamic.ts#L37">src/pools/cluster/dynamic.ts:37</a></li></ul></aside></li></ul></section>
202bcb6b 321<section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="utilization" class="tsd-anchor"></a>
322<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>
323<ul class="tsd-signatures tsd-is-private tsd-is-inherited">
324<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>
325<li class="tsd-description">
326<div class="tsd-comment tsd-typography"><p>Gets the approximate pool utilization.</p>
327</div>
328<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The pool utilization.</p>
329
330<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
331<p>Inherited from FixedClusterPool.utilization</p>
332<ul>
2a663199 333<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L312">src/pools/abstract-pool.ts:312</a></li></ul></aside></li></ul></section>
184d530f 334<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="worker" class="tsd-anchor"></a>
15d6dfaf 335<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 336<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
337<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;cluster&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;thread&quot;</span></li>
338<li class="tsd-description">
339<div class="tsd-comment tsd-typography"><p>Gets the worker type.</p>
340</div>
15d6dfaf 341<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;cluster&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;thread&quot;</span></h4>
342<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
184d530f 343<p>Inherited from FixedClusterPool.worker</p>
344<ul>
2a663199 345<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/fixed.ts#L92">src/pools/cluster/fixed.ts:92</a></li></ul></aside></li></ul></section></section>
a76fac14
JB
346<section class="tsd-panel-group tsd-member-group">
347<h2>Methods</h2>
3bd6a82e 348<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="afterTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 349<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 350<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 351<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">worker</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 352<li class="tsd-description">
18ba88e2 353<div class="tsd-comment tsd-typography"><p>Hook executed after the worker task execution.
ed1ecf09
JB
354Can be overridden.</p>
355</div>
356<div class="tsd-parameters">
357<h4 class="tsd-parameters-title">Parameters</h4>
358<ul class="tsd-parameter-list">
359<li>
3bd6a82e 360<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type ">Worker</span></h5>
79458fb6 361<div class="tsd-comment tsd-typography"><p>The worker.</p>
15d6dfaf 362</div>
363<div class="tsd-comment tsd-typography"></div></li>
ed1ecf09 364<li>
030eb5a3 365<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 366<div class="tsd-comment tsd-typography"><p>The received message.</p>
15d6dfaf 367</div>
368<div class="tsd-comment tsd-typography"></div></li></ul></div>
369<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
370<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
18ba88e2 371<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#afterTaskExecutionHook">afterTaskExecutionHook</a></p>
ed1ecf09 372<ul>
2a663199 373<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L555">src/pools/abstract-pool.ts:555</a></li></ul></aside></li></ul></section>
3bd6a82e 374<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="afterWorkerSetup" class="tsd-anchor"></a>
15d6dfaf 375<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>after<wbr/>Worker<wbr/>Setup</span><a href="#afterWorkerSetup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 376<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 377<li class="tsd-signature tsd-anchor-link" id="afterWorkerSetup.afterWorkerSetup-1"><span class="tsd-kind-call-signature">after<wbr/>Worker<wbr/>Setup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#afterWorkerSetup.afterWorkerSetup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 378<li class="tsd-description">
030eb5a3 379<div class="tsd-comment tsd-typography"><p>Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
380Can be overridden.</p>
6c525543 381</div>
a76fac14
JB
382<div class="tsd-parameters">
383<h4 class="tsd-parameters-title">Parameters</h4>
384<ul class="tsd-parameter-list">
385<li>
3bd6a82e 386<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type ">Worker</span></h5>
6c525543 387<div class="tsd-comment tsd-typography"><p>The newly created worker.</p>
15d6dfaf 388</div>
389<div class="tsd-comment tsd-typography"></div></li></ul></div>
390<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
391<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
392<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#afterWorkerSetup">afterWorkerSetup</a></p>
393<ul>
2a663199 394<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L747">src/pools/abstract-pool.ts:747</a></li></ul></aside></li></ul></section>
3bd6a82e 395<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="beforeTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 396<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 397<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f05afd16 398<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 399<li class="tsd-description">
18ba88e2 400<div class="tsd-comment tsd-typography"><p>Hook executed before the worker task execution.
ed1ecf09
JB
401Can be overridden.</p>
402</div>
403<div class="tsd-parameters">
404<h4 class="tsd-parameters-title">Parameters</h4>
405<ul class="tsd-parameter-list">
406<li>
3bd6a82e 407<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
ffc8d144 408<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 409</div>
f05afd16 410<div class="tsd-comment tsd-typography"></div></li>
411<li>
412<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>
413<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
414</div>
15d6dfaf 415<div class="tsd-comment tsd-typography"></div></li></ul></div>
416<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
417<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
18ba88e2 418<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#beforeTaskExecutionHook">beforeTaskExecutionHook</a></p>
ed1ecf09 419<ul>
2a663199 420<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L539">src/pools/abstract-pool.ts:539</a></li></ul></aside></li></ul></section>
6be0ab6d 421<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="createAndSetupDynamicWorker" class="tsd-anchor"></a>
422<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>create<wbr/>And<wbr/>Setup<wbr/>Dynamic<wbr/>Worker</span><a href="#createAndSetupDynamicWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 423<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
6be0ab6d 424<li class="tsd-signature tsd-anchor-link" id="createAndSetupDynamicWorker.createAndSetupDynamicWorker-1"><span class="tsd-kind-call-signature">create<wbr/>And<wbr/>Setup<wbr/>Dynamic<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Worker</span><a href="#createAndSetupDynamicWorker.createAndSetupDynamicWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 425<li class="tsd-description">
6be0ab6d 426<div class="tsd-comment tsd-typography"><p>Creates a new dynamic worker and sets it up completely in the pool worker nodes.</p>
a76fac14 427</div>
6be0ab6d 428<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Worker</span></h4><p>New, completely set up dynamic worker.</p>
15d6dfaf 429
430<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6be0ab6d 431<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#createAndSetupDynamicWorker">createAndSetupDynamicWorker</a></p>
a76fac14 432<ul>
2a663199 433<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L790">src/pools/abstract-pool.ts:790</a></li></ul></aside></li></ul></section>
3bd6a82e 434<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="createAndSetupWorker" class="tsd-anchor"></a>
15d6dfaf 435<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>create<wbr/>And<wbr/>Setup<wbr/>Worker</span><a href="#createAndSetupWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 436<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 437<li class="tsd-signature tsd-anchor-link" id="createAndSetupWorker.createAndSetupWorker-1"><span class="tsd-kind-call-signature">create<wbr/>And<wbr/>Setup<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="#createAndSetupWorker.createAndSetupWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 438<li class="tsd-description">
ffc8d144 439<div class="tsd-comment tsd-typography"><p>Creates a new worker and sets it up completely in the pool worker nodes.</p>
a76fac14 440</div>
fab6d3b5 441<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Worker</span></h4><p>New, completely set up worker.</p>
15d6dfaf 442
443<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
444<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#createAndSetupWorker">createAndSetupWorker</a></p>
445<ul>
2a663199 446<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L757">src/pools/abstract-pool.ts:757</a></li></ul></aside></li></ul></section>
3bd6a82e 447<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="createWorker" class="tsd-anchor"></a>
15d6dfaf 448<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 449<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 450<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 451<li class="tsd-description">
6be0ab6d 452<div class="tsd-comment tsd-typography"><p>Creates a new worker.</p>
6c525543 453</div>
6be0ab6d 454<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Worker</span></h4><p>Newly created worker.</p>
455
15d6dfaf 456<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
457<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#createWorker">createWorker</a></p>
458<ul>
2a663199 459<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/fixed.ts#L82">src/pools/cluster/fixed.ts:82</a></li></ul></aside></li></ul></section>
3bd6a82e 460<section class="tsd-panel tsd-member tsd-is-inherited"><a id="destroy" class="tsd-anchor"></a>
15d6dfaf 461<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 462<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 463<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 464<li class="tsd-description">
202bcb6b 465<div class="tsd-comment tsd-typography"><p>Terminates every current worker in this pool.</p>
6c525543 466</div>
15d6dfaf 467<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>
468<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
469<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#destroy">destroy</a></p>
470<ul>
2a663199 471<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L500">src/pools/abstract-pool.ts:500</a></li></ul></aside></li></ul></section>
3bd6a82e 472<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="destroyWorker" class="tsd-anchor"></a>
15d6dfaf 473<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>destroy<wbr/>Worker</span><a href="#destroyWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 474<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 475<li class="tsd-signature tsd-anchor-link" id="destroyWorker.destroyWorker-1"><span class="tsd-kind-call-signature">destroy<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#destroyWorker.destroyWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 476<li class="tsd-description">
6be0ab6d 477<div class="tsd-comment tsd-typography"><p>Terminates the given worker.</p>
6c525543 478</div>
a76fac14
JB
479<div class="tsd-parameters">
480<h4 class="tsd-parameters-title">Parameters</h4>
481<ul class="tsd-parameter-list">
482<li>
3bd6a82e 483<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type ">Worker</span></h5>
6c525543 484<div class="tsd-comment tsd-typography"><p>A worker within <code>workerNodes</code>.</p>
15d6dfaf 485</div>
486<div class="tsd-comment tsd-typography"></div></li></ul></div>
487<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
488<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
489<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#destroyWorker">destroyWorker</a></p>
490<ul>
2a663199 491<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/fixed.ts#L68">src/pools/cluster/fixed.ts:68</a></li></ul></aside></li></ul></section>
3bd6a82e 492<section class="tsd-panel tsd-member tsd-is-inherited"><a id="enableTasksQueue" class="tsd-anchor"></a>
15d6dfaf 493<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 494<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 495<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 496<li class="tsd-description">
497<div class="tsd-comment tsd-typography"><p>Enables/disables the worker tasks queue in this pool.</p>
498</div>
499<div class="tsd-parameters">
500<h4 class="tsd-parameters-title">Parameters</h4>
501<ul class="tsd-parameter-list">
502<li>
3bd6a82e 503<h5><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></h5>
6047493a 504<div class="tsd-comment tsd-typography"><p>Whether to enable or disable the worker tasks queue.</p>
15d6dfaf 505</div>
506<div class="tsd-comment tsd-typography"></div></li>
6047493a 507<li>
8d1797ad 508<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 509<div class="tsd-comment tsd-typography"><p>The worker tasks queue options.</p>
15d6dfaf 510</div>
511<div class="tsd-comment tsd-typography"></div></li></ul></div>
512<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
513<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6047493a 514<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#enableTasksQueue">enableTasksQueue</a></p>
515<ul>
2a663199 516<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L406">src/pools/abstract-pool.ts:406</a></li></ul></aside></li></ul></section>
3bd6a82e 517<section class="tsd-panel tsd-member tsd-is-inherited"><a id="execute" class="tsd-anchor"></a>
15d6dfaf 518<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 519<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 520<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 521<li class="tsd-description">
1bb559f9 522<div class="tsd-comment tsd-typography"><p>Executes the specified function in the worker constructor with the task data input parameter.</p>
6c525543 523</div>
a76fac14
JB
524<div class="tsd-parameters">
525<h4 class="tsd-parameters-title">Parameters</h4>
526<ul class="tsd-parameter-list">
527<li>
3bd6a82e 528<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>
030eb5a3 529<div class="tsd-comment tsd-typography"><p>The task input data for the specified worker function. This can only be structured-cloneable data.</p>
15d6dfaf 530</div>
531<div class="tsd-comment tsd-typography"></div></li>
2c94c3a5 532<li>
533<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
534<div class="tsd-comment tsd-typography"><p>The name of the worker function to execute. If not specified, the default worker function will be executed.</p>
15d6dfaf 535</div>
536<div class="tsd-comment tsd-typography"></div></li></ul></div>
fab6d3b5 537<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 538
539<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
540<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#execute">execute</a></p>
541<ul>
2a663199 542<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L466">src/pools/abstract-pool.ts:466</a></li></ul></aside></li></ul></section>
3bd6a82e 543<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="internalBusy" class="tsd-anchor"></a>
15d6dfaf 544<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 545<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 546<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 547<li class="tsd-description">
6be0ab6d 548<div class="tsd-comment tsd-typography"><p>Whether worker nodes are executing at least one task.</p>
549</div>
550<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Worker nodes busyness boolean status.</p>
551
552<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
0770fe62 553<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#internalBusy">internalBusy</a></p>
a76fac14 554<ul>
2a663199 555<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L457">src/pools/abstract-pool.ts:457</a></li></ul></aside></li></ul></section>
3bd6a82e 556<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="isMain" class="tsd-anchor"></a>
15d6dfaf 557<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 558<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 559<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 560<li class="tsd-description">
6c525543 561<div class="tsd-comment tsd-typography"><p>Should return whether the worker is the main worker or not.</p>
562</div>
15d6dfaf 563<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
564<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
565<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#isMain">isMain</a></p>
566<ul>
2a663199 567<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/fixed.ts#L63">src/pools/cluster/fixed.ts:63</a></li></ul></aside></li></ul></section>
3bd6a82e 568<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="sendToWorker" class="tsd-anchor"></a>
15d6dfaf 569<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 570<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 571<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">worker</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 572<li class="tsd-description">
6c525543 573<div class="tsd-comment tsd-typography"><p>Sends a message to the given worker.</p>
574</div>
a76fac14
JB
575<div class="tsd-parameters">
576<h4 class="tsd-parameters-title">Parameters</h4>
577<ul class="tsd-parameter-list">
578<li>
3bd6a82e 579<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type ">Worker</span></h5>
6c525543 580<div class="tsd-comment tsd-typography"><p>The worker which should receive the message.</p>
15d6dfaf 581</div>
582<div class="tsd-comment tsd-typography"></div></li>
a76fac14 583<li>
030eb5a3 584<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 585<div class="tsd-comment tsd-typography"><p>The message.</p>
15d6dfaf 586</div>
587<div class="tsd-comment tsd-typography"></div></li></ul></div>
588<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
589<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
590<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#sendToWorker">sendToWorker</a></p>
591<ul>
2a663199 592<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/fixed.ts#L77">src/pools/cluster/fixed.ts:77</a></li></ul></aside></li></ul></section>
3bd6a82e 593<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setTasksQueueOptions" class="tsd-anchor"></a>
15d6dfaf 594<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 595<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 596<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 597<li class="tsd-description">
598<div class="tsd-comment tsd-typography"><p>Sets the worker tasks queue options in this pool.</p>
599</div>
600<div class="tsd-parameters">
601<h4 class="tsd-parameters-title">Parameters</h4>
602<ul class="tsd-parameter-list">
603<li>
8d1797ad 604<h5><span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5>
6047493a 605<div class="tsd-comment tsd-typography"><p>The worker tasks queue options.</p>
15d6dfaf 606</div>
607<div class="tsd-comment tsd-typography"></div></li></ul></div>
608<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
609<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6047493a 610<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#setTasksQueueOptions">setTasksQueueOptions</a></p>
611<ul>
2a663199 612<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L418">src/pools/abstract-pool.ts:418</a></li></ul></aside></li></ul></section>
3bd6a82e 613<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setWorkerChoiceStrategy" class="tsd-anchor"></a>
15d6dfaf 614<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 615<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 616<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 617<li class="tsd-description">
6c525543 618<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy in this pool.</p>
619</div>
a76fac14
JB
620<div class="tsd-parameters">
621<h4 class="tsd-parameters-title">Parameters</h4>
622<ul class="tsd-parameter-list">
623<li>
f05afd16 624<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 625<div class="tsd-comment tsd-typography"><p>The worker choice strategy.</p>
15d6dfaf 626</div>
627<div class="tsd-comment tsd-typography"></div></li>
a8aeac44 628<li>
8d1797ad 629<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 630<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
15d6dfaf 631</div>
632<div class="tsd-comment tsd-typography"></div></li></ul></div>
633<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
634<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
635<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#setWorkerChoiceStrategy">setWorkerChoiceStrategy</a></p>
636<ul>
2a663199 637<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L373">src/pools/abstract-pool.ts:373</a></li></ul></aside></li></ul></section>
3bd6a82e 638<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setWorkerChoiceStrategyOptions" class="tsd-anchor"></a>
15d6dfaf 639<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 640<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 641<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 642<li class="tsd-description">
643<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy options in this pool.</p>
644</div>
645<div class="tsd-parameters">
646<h4 class="tsd-parameters-title">Parameters</h4>
647<ul class="tsd-parameter-list">
648<li>
8d1797ad 649<h5><span class="tsd-kind-parameter">workerChoiceStrategyOptions</span>: <a href="../interfaces/WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></h5>
6047493a 650<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
15d6dfaf 651</div>
652<div class="tsd-comment tsd-typography"></div></li></ul></div>
653<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
654<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6047493a 655<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#setWorkerChoiceStrategyOptions">setWorkerChoiceStrategyOptions</a></p>
656<ul>
2a663199 657<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L395">src/pools/abstract-pool.ts:395</a></li></ul></aside></li></ul></section>
3bd6a82e 658<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="setupHook" class="tsd-anchor"></a>
15d6dfaf 659<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 660<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 661<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 662<li class="tsd-description">
030eb5a3 663<div class="tsd-comment tsd-typography"><p>Setup hook to execute code before worker nodes are created in the abstract constructor.
664Can be overridden.</p>
6c525543 665</div>
15d6dfaf 666<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
667<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
668<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#setupHook">setupHook</a></p>
669<ul>
2a663199 670<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/cluster/fixed.ts#L58">src/pools/cluster/fixed.ts:58</a></li></ul></aside></li></ul></section>
3bd6a82e 671<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="workerListener" class="tsd-anchor"></a>
15d6dfaf 672<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 673<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 674<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 675<li class="tsd-description">
ffc8d144 676<div class="tsd-comment tsd-typography"><p>This function is the listener registered for each worker message.</p>
a76fac14 677</div>
fab6d3b5 678<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>
679
a76fac14
JB
680<ul class="tsd-parameters">
681<li class="tsd-parameter-signature">
3bd6a82e 682<ul class="tsd-signatures">
683<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 684<li class="tsd-description">
ffc8d144 685<div class="tsd-comment tsd-typography"><p>This function is the listener registered for each worker message.</p>
a76fac14
JB
686</div>
687<div class="tsd-parameters">
688<h4 class="tsd-parameters-title">Parameters</h4>
689<ul class="tsd-parameter-list">
690<li>
030eb5a3 691<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 692<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 693
694<div class="tsd-comment tsd-typography"></div></li></ul></li></ul>
695<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
696<p>Inherited from <a href="FixedClusterPool.html">FixedClusterPool</a>.<a href="FixedClusterPool.html#workerListener">workerListener</a></p>
697<ul>
2a663199 698<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/f03062d/src/pools/abstract-pool.ts#L815">src/pools/abstract-pool.ts:815</a></li></ul></aside></li></ul></section></section></div>
ec06e4dd 699<div class="col-sidebar">
700<div class="page-menu">
a76fac14
JB
701<div class="tsd-navigation settings">
702<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
15d6dfaf 703<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
704<div class="tsd-accordion-details">
705<div class="tsd-filter-visibility">
706<h4 class="uppercase">Member Visibility</h4><form>
707<ul id="tsd-filter-options">
708<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>
709<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>
710<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>
711<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>
712<div class="tsd-theme-toggle">
3bd6a82e 713<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 714<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 715<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
716<div class="tsd-accordion-details">
717<ul>
15d6dfaf 718<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>
719<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>
720<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>
721<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>
722<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>
723<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>
724<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>
725<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>
726<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>
727<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>
728<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>
729<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>
730<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>
731<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>
202bcb6b 732<li><a href="#runTime" class="tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>run<wbr/>Time</span></a></li>
15d6dfaf 733<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 734<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 735<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>
736<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>
737<li><a href="#afterWorkerSetup" 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/>Setup</span></a></li>
738<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>
6be0ab6d 739<li><a href="#createAndSetupDynamicWorker" 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</span></a></li>
15d6dfaf 740<li><a href="#createAndSetupWorker" 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</span></a></li>
741<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>
742<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>
743<li><a href="#destroyWorker" 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</span></a></li>
744<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>
745<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>
746<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>
747<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>
15d6dfaf 748<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>
749<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>
750<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>
751<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>
752<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>
753<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 754<div class="site-menu">
15d6dfaf 755<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</span></a>
ec06e4dd 756<ul class="tsd-small-nested-navigation">
15d6dfaf 757<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>
758<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>
759<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>
760<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>
761<li><a href="DynamicClusterPool.html" class="current"><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>
762<li><a href="DynamicThreadPool.html"><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>
763<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>
764<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>
765<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>
766<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>
767<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>
768<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>
769<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 770<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 771<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>
772<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>
773<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>
f05afd16 774<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>
775<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>
776<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 777<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>
778<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>
779<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>
780<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 781<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 782<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 783<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 784<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 785<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 786<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 787<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 788<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 789<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 790<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 791<li><a href="../interfaces/WorkerNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Node</span></a></li>
792<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 793<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 794<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 795<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 796<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>
797<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 798<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 799<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>
800<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>
801<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>
802<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>
803<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>
15d6dfaf 804<li><a href="../types/WorkerAsyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Async<wbr/>Function</span></a></li>
805<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>
806<li><a href="../types/WorkerFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Function</span></a></li>
807<li><a href="../types/WorkerSyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Sync<wbr/>Function</span></a></li>
808<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>
809<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 810<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 811<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>
812<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>
813<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 814<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>
815<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 816<div class="tsd-generator">
a76fac14 817<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
ec06e4dd 818<div class="overlay"></div></body></html>