build(deps-dev): downgrade to latest supported typescript version
[poolifier.git] / docs / classes / FixedThreadPool.html
CommitLineData
0bb3df76 1<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FixedThreadPool | poolifier - v2.6.34</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>
0bb3df76 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.6.34</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="FixedThreadPool.html">FixedThreadPool</a></li></ul>
17<h1>Class FixedThreadPool&lt;Data, Response&gt;</h1></div>
18<section class="tsd-panel tsd-comment">
19<div class="tsd-comment tsd-typography"><p>A thread pool with a fixed number of threads.</p>
15d6dfaf 20</div>
21<div class="tsd-comment tsd-typography">
22<h4>Author</h4><p><a href="https://github.com/pioardi">Alessandro Pio Ardizio</a></p>
a76fac14 23
15d6dfaf 24<h4>Since</h4><p>0.0.1</p>
a76fac14 25</div></section>
fab6d3b5 26<section class="tsd-panel">
a76fac14 27<h4>Type Parameters</h4>
fab6d3b5 28<ul class="tsd-type-parameter-list">
a76fac14 29<li>
3bd6a82e 30<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 31<div class="tsd-comment tsd-typography"><p>Type of data sent to the worker. This can only be structured-cloneable data.</p>
15d6dfaf 32</div>
33<div class="tsd-comment tsd-typography"></div></li>
a76fac14 34<li>
3bd6a82e 35<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 36<div class="tsd-comment tsd-typography"><p>Type of execution response. This can only be structured-cloneable data.</p>
15d6dfaf 37</div>
38<div class="tsd-comment tsd-typography"></div></li></ul></section>
a76fac14
JB
39<section class="tsd-panel tsd-hierarchy">
40<h4>Hierarchy</h4>
41<ul class="tsd-hierarchy">
030eb5a3 42<li><a href="AbstractPool.html" class="tsd-signature-type tsd-kind-class">AbstractPool</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>
a76fac14
JB
43<ul class="tsd-hierarchy">
44<li><span class="target">FixedThreadPool</span>
45<ul class="tsd-hierarchy">
8d1797ad 46<li><a href="DynamicThreadPool.html" class="tsd-signature-type tsd-kind-class">DynamicThreadPool</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
a76fac14 47<ul>
95c33366 48<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/thread/fixed.ts#L35">src/pools/thread/fixed.ts:35</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="FixedThreadPool.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="FixedThreadPool.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="FixedThreadPool.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>
00471704 62<a href="FixedThreadPool.html#max" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max?</span></a>
15d6dfaf 63<a href="FixedThreadPool.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="FixedThreadPool.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="FixedThreadPool.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="FixedThreadPool.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="FixedThreadPool.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="FixedThreadPool.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="FixedThreadPool.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="FixedThreadPool.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>
00471704 74<a href="FixedThreadPool.html#maxSize" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>max<wbr/>Size</span></a>
75<a href="FixedThreadPool.html#minSize" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>min<wbr/>Size</span></a>
c914a50e 76<a href="FixedThreadPool.html#ready" class="tsd-index-link tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>ready</span></a>
15d6dfaf 77<a href="FixedThreadPool.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="FixedThreadPool.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="FixedThreadPool.html#worker" class="tsd-index-link tsd-is-protected"><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="FixedThreadPool.html#afterTaskExecutionHook" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>after<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a>
f04db52f 84<a href="FixedThreadPool.html#afterWorkerNodeSetup" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>after<wbr/>Worker<wbr/>Node<wbr/>Setup</span></a>
15d6dfaf 85<a href="FixedThreadPool.html#beforeTaskExecutionHook" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>before<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a>
c914a50e 86<a href="FixedThreadPool.html#checkDynamicPoolSize" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Dynamic<wbr/>Pool<wbr/>Size</span></a>
f04db52f 87<a href="FixedThreadPool.html#createAndSetupDynamicWorkerNode" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>And<wbr/>Setup<wbr/>Dynamic<wbr/>Worker<wbr/>Node</span></a>
88<a href="FixedThreadPool.html#createAndSetupWorkerNode" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>And<wbr/>Setup<wbr/>Worker<wbr/>Node</span></a>
15d6dfaf 89<a href="FixedThreadPool.html#createWorker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Worker</span></a>
90<a href="FixedThreadPool.html#destroy" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a>
f04db52f 91<a href="FixedThreadPool.html#destroyWorkerNode" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy<wbr/>Worker<wbr/>Node</span></a>
15d6dfaf 92<a href="FixedThreadPool.html#enableTasksQueue" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enable<wbr/>Tasks<wbr/>Queue</span></a>
93<a href="FixedThreadPool.html#execute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>execute</span></a>
f04db52f 94<a href="FixedThreadPool.html#flushTasksQueue" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flush<wbr/>Tasks<wbr/>Queue</span></a>
95<a href="FixedThreadPool.html#getWorkerInfo" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Worker<wbr/>Info</span></a>
c22b117f 96<a href="FixedThreadPool.html#hasWorkerNodeBackPressure" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span></a>
15d6dfaf 97<a href="FixedThreadPool.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>
98<a href="FixedThreadPool.html#isMain" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Main</span></a>
013a4697 99<a href="FixedThreadPool.html#listTaskFunctions" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Task<wbr/>Functions</span></a>
76b46937 100<a href="FixedThreadPool.html#registerWorkerMessageListener" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Worker<wbr/>Message<wbr/>Listener</span></a>
013a4697 101<a href="FixedThreadPool.html#sendKillMessageToWorker" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Kill<wbr/>Message<wbr/>To<wbr/>Worker</span></a>
76b46937 102<a href="FixedThreadPool.html#sendStartupMessageToWorker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Startup<wbr/>Message<wbr/>To<wbr/>Worker</span></a>
15d6dfaf 103<a href="FixedThreadPool.html#sendToWorker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>To<wbr/>Worker</span></a>
104<a href="FixedThreadPool.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>
105<a href="FixedThreadPool.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>
106<a href="FixedThreadPool.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>
107<a href="FixedThreadPool.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>
108<a href="FixedThreadPool.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
109</div></section></div></details></section></section>
110<section class="tsd-panel-group tsd-member-group">
111<h2>Constructors</h2>
3bd6a82e 112<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
15d6dfaf 113<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 114<ul class="tsd-signatures">
15d6dfaf 115<li class="tsd-signature tsd-anchor-link" id="constructor.new_FixedThreadPool"><span class="tsd-kind-constructor-signature">new <wbr/>Fixed<wbr/>Thread<wbr/>Pool</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">numberOfThreads</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="FixedThreadPool.html" class="tsd-signature-type tsd-kind-class">FixedThreadPool</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_FixedThreadPool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14
JB
116<li class="tsd-description">
117<div class="tsd-comment tsd-typography"><p>Constructs a new poolifier fixed thread pool.</p>
118</div>
fab6d3b5 119<section class="tsd-panel">
a76fac14 120<h4>Type Parameters</h4>
fab6d3b5 121<ul class="tsd-type-parameter-list">
a76fac14 122<li>
3bd6a82e 123<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4></li>
a76fac14 124<li>
3bd6a82e 125<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section>
a76fac14
JB
126<div class="tsd-parameters">
127<h4 class="tsd-parameters-title">Parameters</h4>
128<ul class="tsd-parameter-list">
129<li>
3bd6a82e 130<h5><span class="tsd-kind-parameter">numberOfThreads</span>: <span class="tsd-signature-type">number</span></h5>
a76fac14 131<div class="tsd-comment tsd-typography"><p>Number of threads for this pool.</p>
15d6dfaf 132</div>
133<div class="tsd-comment tsd-typography"></div></li>
a76fac14 134<li>
3bd6a82e 135<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
a76fac14 136<div class="tsd-comment tsd-typography"><p>Path to an implementation of a <code>ThreadWorker</code> file, which can be relative or absolute.</p>
15d6dfaf 137</div>
138<div class="tsd-comment tsd-typography"></div></li>
a76fac14 139<li>
f45a3823 140<h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/ThreadPoolOptions.html" class="tsd-signature-type tsd-kind-interface">ThreadPoolOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
a76fac14 141<div class="tsd-comment tsd-typography"><p>Options for this fixed thread pool.</p>
15d6dfaf 142</div>
143<div class="tsd-comment tsd-typography"></div></li></ul></div>
144<h4 class="tsd-returns-title">Returns <a href="FixedThreadPool.html" class="tsd-signature-type tsd-kind-class">FixedThreadPool</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span></h4>
145<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 146<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#constructor">constructor</a></p>
a76fac14 147<ul>
95c33366 148<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/thread/fixed.ts#L46">src/pools/thread/fixed.ts:46</a></li></ul></aside></li></ul></section></section>
a76fac14
JB
149<section class="tsd-panel-group tsd-member-group">
150<h2>Properties</h2>
3bd6a82e 151<section class="tsd-panel tsd-member tsd-is-inherited"><a id="emitter" class="tsd-anchor"></a>
15d6dfaf 152<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 153<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 154<div class="tsd-comment tsd-typography"><p>Emitter on which events can be listened to.</p>
155<p>Events that can currently be listened to:</p>
a76fac14 156<ul>
85c03385 157<li><code>&#39;ready&#39;</code>: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.</li>
c914a50e 158<li><code>&#39;busy&#39;</code>: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.</li>
a13e50c3 159<li><code>&#39;full&#39;</code>: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.</li>
160<li>&#39;<code>destroy</code>&#39;: Emitted when the pool is destroyed.</li>
ccb7d1a7 161<li><code>&#39;error&#39;</code>: Emitted when an uncaught error occurs.</li>
162<li><code>&#39;taskError&#39;</code>: Emitted when an error occurs while executing a task.</li>
31542ddf 163<li><code>&#39;backPressure&#39;</code>: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size &gt;= maximum queue size).</li>
6c525543 164</ul>
15d6dfaf 165</div>
166<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 167<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#emitter">emitter</a></p>
168<ul>
95c33366 169<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L66">src/pools/abstract-pool.ts:66</a></li></ul></aside></section>
184d530f 170<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="filePath" class="tsd-anchor"></a>
15d6dfaf 171<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>file<wbr/>Path</span><a href="#filePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
8d1797ad 172<div class="tsd-signature"><span class="tsd-kind-property">file<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
f63918da 173<div class="tsd-comment tsd-typography"><p>Path to the worker file.</p>
15d6dfaf 174</div>
175<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 176<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#filePath">filePath</a></p>
a76fac14 177<ul>
95c33366 178<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L115">src/pools/abstract-pool.ts:115</a></li></ul></aside></section>
00471704 179<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="max" class="tsd-anchor"></a>
180<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>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>
181<div class="tsd-signature"><span class="tsd-kind-property">max</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
182<div class="tsd-comment tsd-typography"><p>Dynamic pool maximum size property placeholder.</p>
183</div>
184<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
185<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#max">max</a></p>
186<ul>
95c33366 187<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L91">src/pools/abstract-pool.ts:91</a></li></ul></aside></section>
184d530f 188<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="numberOfWorkers" class="tsd-anchor"></a>
15d6dfaf 189<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 190<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 191<div class="tsd-comment tsd-typography"><p>Number of workers that this pool should manage.</p>
15d6dfaf 192</div>
193<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 194<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#numberOfWorkers">numberOfWorkers</a></p>
a76fac14 195<ul>
95c33366 196<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L114">src/pools/abstract-pool.ts:114</a></li></ul></aside></section>
184d530f 197<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="opts" class="tsd-anchor"></a>
15d6dfaf 198<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>opts</span><a href="#opts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
f45a3823 199<div class="tsd-signature"><span class="tsd-kind-property">opts</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ThreadPoolOptions.html" class="tsd-signature-type tsd-kind-interface">ThreadPoolOptions</a><span class="tsd-signature-symbol"> = {}</span></div>
200<div class="tsd-comment tsd-typography"><p>Options for this fixed thread pool.</p>
15d6dfaf 201</div>
202<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 203<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#opts">opts</a></p>
a76fac14 204<ul>
95c33366 205<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/thread/fixed.ts#L49">src/pools/thread/fixed.ts:49</a></li></ul></aside></section>
3bd6a82e 206<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="promiseResponseMap" class="tsd-anchor"></a>
15d6dfaf 207<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>promise<wbr/>Response<wbr/>Map</span><a href="#promiseResponseMap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
f04db52f 208<div class="tsd-signature"><span class="tsd-kind-property">promise<wbr/>Response<wbr/>Map</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/PromiseResponseWrapper.html" class="tsd-signature-type tsd-kind-interface">PromiseResponseWrapper</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
209<div class="tsd-comment tsd-typography"><p>The task execution response promise map.</p>
a76fac14 210<ul>
79458fb6 211<li><code>key</code>: The message id of each submitted task.</li>
21402562 212<li><code>value</code>: An object that contains the worker, the execution response promise resolve and reject callbacks.</li>
24c3fcb4 213</ul>
21402562 214<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 215</div>
216<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 217<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#promiseResponseMap">promiseResponseMap</a></p>
a76fac14 218<ul>
95c33366 219<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L76">src/pools/abstract-pool.ts:76</a></li></ul></aside></section>
3bd6a82e 220<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="workerChoiceStrategyContext" class="tsd-anchor"></a>
15d6dfaf 221<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span><a href="#workerChoiceStrategyContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
030eb5a3 222<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 223<div class="tsd-comment tsd-typography"><p>Worker choice strategy context referencing a worker choice algorithm implementation.</p>
15d6dfaf 224</div>
225<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 226<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#workerChoiceStrategyContext">workerChoiceStrategyContext</a></p>
a76fac14 227<ul>
95c33366 228<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L82">src/pools/abstract-pool.ts:82</a></li></ul></aside></section>
3bd6a82e 229<section class="tsd-panel tsd-member tsd-is-inherited"><a id="workerNodes" class="tsd-anchor"></a>
c22b117f 230<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <code class="tsd-tag ts-flagInternal">Internal</code> <span>worker<wbr/>Nodes</span><a href="#workerNodes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
a6b5c73c 231<div class="tsd-signature"><span class="tsd-kind-property">worker<wbr/>Nodes</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IWorkerNode.html" class="tsd-signature-type tsd-kind-interface">IWorkerNode</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
6c525543 232<div class="tsd-comment tsd-typography"><p>Pool worker nodes.</p>
15d6dfaf 233</div>
234<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 235<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#workerNodes">workerNodes</a></p>
a76fac14 236<ul>
95c33366 237<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L63">src/pools/abstract-pool.ts:63</a></li></ul></aside></section></section>
a76fac14
JB
238<section class="tsd-panel-group tsd-member-group">
239<h2>Accessors</h2>
3bd6a82e 240<section class="tsd-panel tsd-member tsd-is-protected"><a id="busy" class="tsd-anchor"></a>
15d6dfaf 241<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 242<ul class="tsd-signatures tsd-is-protected">
a76fac14
JB
243<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>
244<li class="tsd-description">
6c525543 245<div class="tsd-comment tsd-typography"><p>Whether the pool is busy or not.</p>
246<p>The pool busyness boolean status.</p>
247</div>
15d6dfaf 248<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
249<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
250<p>Overrides AbstractPool.busy</p>
251<ul>
95c33366 252<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/thread/fixed.ts#L132">src/pools/thread/fixed.ts:132</a></li></ul></aside></li></ul></section>
184d530f 253<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="full" class="tsd-anchor"></a>
15d6dfaf 254<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 255<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
0770fe62 256<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 257<li class="tsd-description">
6c525543 258<div class="tsd-comment tsd-typography"><p>Whether the pool is full or not.</p>
259<p>The pool filling boolean status.</p>
260</div>
15d6dfaf 261<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
262<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
184d530f 263<p>Inherited from AbstractPool.full</p>
0770fe62 264<ul>
95c33366 265<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L682">src/pools/abstract-pool.ts:682</a></li></ul></aside></li></ul></section>
a2742ce7 266<section class="tsd-panel tsd-member tsd-is-inherited"><a id="info" class="tsd-anchor"></a>
15d6dfaf 267<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 268<ul class="tsd-signatures tsd-is-inherited">
269<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 270<li class="tsd-description">
a2742ce7 271<div class="tsd-comment tsd-typography"><p>Pool information.</p>
ffc8d144 272</div>
15d6dfaf 273<h4 class="tsd-returns-title">Returns <a href="../interfaces/PoolInfo.html" class="tsd-signature-type tsd-kind-interface">PoolInfo</a></h4>
274<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a2742ce7 275<p>Inherited from AbstractPool.info</p>
ffc8d144 276<ul>
95c33366 277<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L354">src/pools/abstract-pool.ts:354</a></li></ul></aside></li></ul></section>
00471704 278<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="maxSize" class="tsd-anchor"></a>
15d6dfaf 279<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>
00471704 280<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
a2742ce7 281<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 282<li class="tsd-description">
f04db52f 283<div class="tsd-comment tsd-typography"><p>The pool maximum size.</p>
0770fe62 284</div>
15d6dfaf 285<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
286<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
00471704 287<p>Inherited from AbstractPool.maxSize</p>
a76fac14 288<ul>
95c33366 289<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L555">src/pools/abstract-pool.ts:555</a></li></ul></aside></li></ul></section>
00471704 290<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="minSize" class="tsd-anchor"></a>
15d6dfaf 291<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>
00471704 292<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
a2742ce7 293<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 294<li class="tsd-description">
f04db52f 295<div class="tsd-comment tsd-typography"><p>The pool minimum size.</p>
2c94c3a5 296</div>
15d6dfaf 297<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
298<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
00471704 299<p>Inherited from AbstractPool.minSize</p>
2c94c3a5 300<ul>
95c33366 301<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L548">src/pools/abstract-pool.ts:548</a></li></ul></aside></li></ul></section>
c914a50e 302<section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="ready" class="tsd-anchor"></a>
303<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>ready</span><a href="#ready" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
304<ul class="tsd-signatures tsd-is-private tsd-is-inherited">
305<li class="tsd-signature" id="ready.ready-1"><span class="tsd-signature-symbol">get</span> ready<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
306<li class="tsd-description">
f04db52f 307<div class="tsd-comment tsd-typography"><p>The pool readiness boolean status.</p>
308</div>
309<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
310<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
c914a50e 311<p>Inherited from AbstractPool.ready</p>
312<ul>
95c33366 313<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L500">src/pools/abstract-pool.ts:500</a></li></ul></aside></li></ul></section>
184d530f 314<section class="tsd-panel tsd-member tsd-is-protected"><a id="type" class="tsd-anchor"></a>
15d6dfaf 315<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 316<ul class="tsd-signatures tsd-is-protected">
a2742ce7 317<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 318<li class="tsd-description">
f04db52f 319<div class="tsd-comment tsd-typography"><p>The pool type.</p>
6c525543 320<p>If it is <code>&#39;dynamic&#39;</code>, it provides the <code>max</code> property.</p>
321</div>
15d6dfaf 322<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>
323<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
324<p>Overrides AbstractPool.type</p>
325<ul>
95c33366 326<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/thread/fixed.ts#L122">src/pools/thread/fixed.ts:122</a></li></ul></aside></li></ul></section>
202bcb6b 327<section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="utilization" class="tsd-anchor"></a>
328<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>
329<ul class="tsd-signatures tsd-is-private tsd-is-inherited">
330<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>
331<li class="tsd-description">
f04db52f 332<div class="tsd-comment tsd-typography"><p>The approximate pool utilization.</p>
202bcb6b 333</div>
334<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The pool utilization.</p>
335
336<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
337<p>Inherited from AbstractPool.utilization</p>
338<ul>
95c33366 339<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L517">src/pools/abstract-pool.ts:517</a></li></ul></aside></li></ul></section>
184d530f 340<section class="tsd-panel tsd-member tsd-is-protected"><a id="worker" class="tsd-anchor"></a>
15d6dfaf 341<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 342<ul class="tsd-signatures tsd-is-protected">
3c7c9bd1 343<li class="tsd-signature" id="worker.worker-1"><span class="tsd-signature-symbol">get</span> worker<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;thread&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;cluster&quot;</span></li>
184d530f 344<li class="tsd-description">
f04db52f 345<div class="tsd-comment tsd-typography"><p>The worker type.</p>
184d530f 346</div>
3c7c9bd1 347<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;thread&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;cluster&quot;</span></h4>
15d6dfaf 348<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
184d530f 349<p>Overrides AbstractPool.worker</p>
350<ul>
95c33366 351<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/thread/fixed.ts#L127">src/pools/thread/fixed.ts:127</a></li></ul></aside></li></ul></section></section>
a76fac14
JB
352<section class="tsd-panel-group tsd-member-group">
353<h2>Methods</h2>
3bd6a82e 354<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="afterTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 355<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 356<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 357<li class="tsd-signature tsd-anchor-link" id="afterTaskExecutionHook.afterTaskExecutionHook-1"><span class="tsd-kind-call-signature">after<wbr/>Task<wbr/>Execution<wbr/>Hook</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#afterTaskExecutionHook.afterTaskExecutionHook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
ed1ecf09 358<li class="tsd-description">
18ba88e2 359<div class="tsd-comment tsd-typography"><p>Hook executed after the worker task execution.
ed1ecf09
JB
360Can be overridden.</p>
361</div>
362<div class="tsd-parameters">
363<h4 class="tsd-parameters-title">Parameters</h4>
364<ul class="tsd-parameter-list">
365<li>
f04db52f 366<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
367<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 368</div>
369<div class="tsd-comment tsd-typography"></div></li>
ed1ecf09 370<li>
030eb5a3 371<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 372<div class="tsd-comment tsd-typography"><p>The received message.</p>
15d6dfaf 373</div>
374<div class="tsd-comment tsd-typography"></div></li></ul></div>
375<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
376<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 377<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#afterTaskExecutionHook">afterTaskExecutionHook</a></p>
ed1ecf09 378<ul>
95c33366 379<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L879">src/pools/abstract-pool.ts:879</a></li></ul></aside></li></ul></section>
f04db52f 380<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="afterWorkerNodeSetup" class="tsd-anchor"></a>
381<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>after<wbr/>Worker<wbr/>Node<wbr/>Setup</span><a href="#afterWorkerNodeSetup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
030eb5a3 382<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 383<li class="tsd-signature tsd-anchor-link" id="afterWorkerNodeSetup.afterWorkerNodeSetup-1"><span class="tsd-kind-call-signature">after<wbr/>Worker<wbr/>Node<wbr/>Setup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#afterWorkerNodeSetup.afterWorkerNodeSetup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 384<li class="tsd-description">
f04db52f 385<div class="tsd-comment tsd-typography"><p>Method hooked up after a worker node has been newly created.
030eb5a3 386Can be overridden.</p>
6c525543 387</div>
a76fac14
JB
388<div class="tsd-parameters">
389<h4 class="tsd-parameters-title">Parameters</h4>
390<ul class="tsd-parameter-list">
391<li>
f04db52f 392<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
393<div class="tsd-comment tsd-typography"><p>The newly created worker node key.</p>
15d6dfaf 394</div>
395<div class="tsd-comment tsd-typography"></div></li></ul></div>
396<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
397<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 398<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#afterWorkerNodeSetup">afterWorkerNodeSetup</a></p>
a76fac14 399<ul>
95c33366 400<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L1151">src/pools/abstract-pool.ts:1151</a></li></ul></aside></li></ul></section>
3bd6a82e 401<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="beforeTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 402<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 403<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f05afd16 404<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 405<li class="tsd-description">
18ba88e2 406<div class="tsd-comment tsd-typography"><p>Hook executed before the worker task execution.
ed1ecf09
JB
407Can be overridden.</p>
408</div>
409<div class="tsd-parameters">
410<h4 class="tsd-parameters-title">Parameters</h4>
411<ul class="tsd-parameter-list">
412<li>
3bd6a82e 413<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
ffc8d144 414<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 415</div>
f05afd16 416<div class="tsd-comment tsd-typography"></div></li>
417<li>
418<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>
419<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
420</div>
15d6dfaf 421<div class="tsd-comment tsd-typography"></div></li></ul></div>
422<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
423<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 424<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#beforeTaskExecutionHook">beforeTaskExecutionHook</a></p>
ed1ecf09 425<ul>
95c33366 426<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L849">src/pools/abstract-pool.ts:849</a></li></ul></aside></li></ul></section>
c914a50e 427<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="checkDynamicPoolSize" class="tsd-anchor"></a>
428<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>check<wbr/>Dynamic<wbr/>Pool<wbr/>Size</span><a href="#checkDynamicPoolSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
429<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
430<li class="tsd-signature tsd-anchor-link" id="checkDynamicPoolSize.checkDynamicPoolSize-1"><span class="tsd-kind-call-signature">check<wbr/>Dynamic<wbr/>Pool<wbr/>Size</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">min</span>, <span class="tsd-kind-parameter">max</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkDynamicPoolSize.checkDynamicPoolSize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
431<li class="tsd-description">
432<div class="tsd-parameters">
433<h4 class="tsd-parameters-title">Parameters</h4>
434<ul class="tsd-parameter-list">
435<li>
436<h5><span class="tsd-kind-parameter">min</span>: <span class="tsd-signature-type">number</span></h5></li>
437<li>
438<h5><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
439<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
440<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#checkDynamicPoolSize">checkDynamicPoolSize</a></p>
441<ul>
95c33366 442<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L185">src/pools/abstract-pool.ts:185</a></li></ul></aside></li></ul></section>
f04db52f 443<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="createAndSetupDynamicWorkerNode" class="tsd-anchor"></a>
444<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>create<wbr/>And<wbr/>Setup<wbr/>Dynamic<wbr/>Worker<wbr/>Node</span><a href="#createAndSetupDynamicWorkerNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 445<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 446<li class="tsd-signature tsd-anchor-link" id="createAndSetupDynamicWorkerNode.createAndSetupDynamicWorkerNode-1"><span class="tsd-kind-call-signature">create<wbr/>And<wbr/>Setup<wbr/>Dynamic<wbr/>Worker<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#createAndSetupDynamicWorkerNode.createAndSetupDynamicWorkerNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 447<li class="tsd-description">
f04db52f 448<div class="tsd-comment tsd-typography"><p>Creates a new, completely set up dynamic worker node.</p>
a76fac14 449</div>
f04db52f 450<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>New, completely set up dynamic worker node key.</p>
15d6dfaf 451
452<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 453<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#createAndSetupDynamicWorkerNode">createAndSetupDynamicWorkerNode</a></p>
a76fac14 454<ul>
95c33366 455<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L1094">src/pools/abstract-pool.ts:1094</a></li></ul></aside></li></ul></section>
f04db52f 456<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="createAndSetupWorkerNode" class="tsd-anchor"></a>
457<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>create<wbr/>And<wbr/>Setup<wbr/>Worker<wbr/>Node</span><a href="#createAndSetupWorkerNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 458<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 459<li class="tsd-signature tsd-anchor-link" id="createAndSetupWorkerNode.createAndSetupWorkerNode-1"><span class="tsd-kind-call-signature">create<wbr/>And<wbr/>Setup<wbr/>Worker<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#createAndSetupWorkerNode.createAndSetupWorkerNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 460<li class="tsd-description">
f04db52f 461<div class="tsd-comment tsd-typography"><p>Creates a new, completely set up worker node.</p>
a76fac14 462</div>
f04db52f 463<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>New, completely set up worker node key.</p>
15d6dfaf 464
465<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 466<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#createAndSetupWorkerNode">createAndSetupWorkerNode</a></p>
a76fac14 467<ul>
95c33366 468<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L1050">src/pools/abstract-pool.ts:1050</a></li></ul></aside></li></ul></section>
3bd6a82e 469<section class="tsd-panel tsd-member tsd-is-protected"><a id="createWorker" class="tsd-anchor"></a>
15d6dfaf 470<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 471<ul class="tsd-signatures tsd-is-protected">
030eb5a3 472<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 473<li class="tsd-description">
6be0ab6d 474<div class="tsd-comment tsd-typography"><p>Creates a new worker.</p>
6c525543 475</div>
030eb5a3 476<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Worker</span></h4><p>Newly created worker.</p>
6be0ab6d 477
15d6dfaf 478<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 479<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#createWorker">createWorker</a></p>
a76fac14 480<ul>
95c33366 481<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/thread/fixed.ts#L114">src/pools/thread/fixed.ts:114</a></li></ul></aside></li></ul></section>
3bd6a82e 482<section class="tsd-panel tsd-member tsd-is-inherited"><a id="destroy" class="tsd-anchor"></a>
15d6dfaf 483<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 484<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 485<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 486<li class="tsd-description">
f04db52f 487<div class="tsd-comment tsd-typography"><p>Terminates all workers in this pool.</p>
6c525543 488</div>
15d6dfaf 489<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>
490<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 491<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#destroy">destroy</a></p>
a76fac14 492<ul>
95c33366 493<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L794">src/pools/abstract-pool.ts:794</a></li></ul></aside></li></ul></section>
f04db52f 494<section class="tsd-panel tsd-member tsd-is-protected"><a id="destroyWorkerNode" class="tsd-anchor"></a>
495<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>destroy<wbr/>Worker<wbr/>Node</span><a href="#destroyWorkerNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 496<ul class="tsd-signatures tsd-is-protected">
f04db52f 497<li class="tsd-signature tsd-anchor-link" id="destroyWorkerNode.destroyWorkerNode-1"><span class="tsd-kind-call-signature">destroy<wbr/>Worker<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#destroyWorkerNode.destroyWorkerNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 498<li class="tsd-description">
f04db52f 499<div class="tsd-comment tsd-typography"><p>Terminates the worker node given its worker node key.</p>
6c525543 500</div>
a76fac14
JB
501<div class="tsd-parameters">
502<h4 class="tsd-parameters-title">Parameters</h4>
503<ul class="tsd-parameter-list">
504<li>
f04db52f 505<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
506<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 507</div>
508<div class="tsd-comment tsd-typography"></div></li></ul></div>
509<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>
510<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 511<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#destroyWorkerNode">destroyWorkerNode</a></p>
a76fac14 512<ul>
95c33366 513<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/thread/fixed.ts#L60">src/pools/thread/fixed.ts:60</a></li></ul></aside></li></ul></section>
3bd6a82e 514<section class="tsd-panel tsd-member tsd-is-inherited"><a id="enableTasksQueue" class="tsd-anchor"></a>
15d6dfaf 515<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 516<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 517<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 518<li class="tsd-description">
31542ddf 519<div class="tsd-comment tsd-typography"><p>Enables/disables the worker node tasks queue in this pool.</p>
6047493a 520</div>
521<div class="tsd-parameters">
522<h4 class="tsd-parameters-title">Parameters</h4>
523<ul class="tsd-parameter-list">
524<li>
3bd6a82e 525<h5><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></h5>
31542ddf 526<div class="tsd-comment tsd-typography"><p>Whether to enable or disable the worker node tasks queue.</p>
15d6dfaf 527</div>
528<div class="tsd-comment tsd-typography"></div></li>
6047493a 529<li>
8d1797ad 530<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>
31542ddf 531<div class="tsd-comment tsd-typography"><p>The worker node tasks queue options.</p>
15d6dfaf 532</div>
533<div class="tsd-comment tsd-typography"></div></li></ul></div>
534<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
535<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6047493a 536<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#enableTasksQueue">enableTasksQueue</a></p>
537<ul>
95c33366 538<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L636">src/pools/abstract-pool.ts:636</a></li></ul></aside></li></ul></section>
3bd6a82e 539<section class="tsd-panel tsd-member tsd-is-inherited"><a id="execute" class="tsd-anchor"></a>
15d6dfaf 540<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 541<ul class="tsd-signatures tsd-is-inherited">
2447ee8c 542<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-kind-parameter">transferList</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&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 543<li class="tsd-description">
1bb559f9 544<div class="tsd-comment tsd-typography"><p>Executes the specified function in the worker constructor with the task data input parameter.</p>
6c525543 545</div>
a76fac14
JB
546<div class="tsd-parameters">
547<h4 class="tsd-parameters-title">Parameters</h4>
548<ul class="tsd-parameter-list">
549<li>
3bd6a82e 550<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>
2447ee8c 551<div class="tsd-comment tsd-typography"><p>The optional task input data for the specified task function. This can only be structured-cloneable data.</p>
15d6dfaf 552</div>
553<div class="tsd-comment tsd-typography"></div></li>
2c94c3a5 554<li>
555<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
2447ee8c 556<div class="tsd-comment tsd-typography"><p>The optional name of the task function to execute. If not specified, the default task function will be executed.</p>
557</div>
558<div class="tsd-comment tsd-typography"></div></li>
559<li>
560<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">transferList</span>: <span class="tsd-signature-type ">TransferListItem</span><span class="tsd-signature-symbol">[]</span></h5>
561<div class="tsd-comment tsd-typography"><p>An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool&#39;s worker_threads worker and they should not be used in the main thread afterwards.</p>
15d6dfaf 562</div>
563<div class="tsd-comment tsd-typography"></div></li></ul></div>
fab6d3b5 564<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 565
566<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 567<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#execute">execute</a></p>
a76fac14 568<ul>
95c33366 569<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L732">src/pools/abstract-pool.ts:732</a></li></ul></aside></li></ul></section>
f04db52f 570<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="flushTasksQueue" class="tsd-anchor"></a>
571<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>flush<wbr/>Tasks<wbr/>Queue</span><a href="#flushTasksQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
76b46937 572<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 573<li class="tsd-signature tsd-anchor-link" id="flushTasksQueue.flushTasksQueue-1"><span class="tsd-kind-call-signature">flush<wbr/>Tasks<wbr/>Queue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#flushTasksQueue.flushTasksQueue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
76b46937 574<li class="tsd-description">
76b46937 575<div class="tsd-parameters">
576<h4 class="tsd-parameters-title">Parameters</h4>
577<ul class="tsd-parameter-list">
578<li>
f04db52f 579<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
580<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
581<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#flushTasksQueue">flushTasksQueue</a></p>
76b46937 582<ul>
95c33366 583<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L1475">src/pools/abstract-pool.ts:1475</a></li></ul></aside></li></ul></section>
f04db52f 584<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="getWorkerInfo" class="tsd-anchor"></a>
585<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Worker<wbr/>Info</span><a href="#getWorkerInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
76b46937 586<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
953288ed 587<li class="tsd-signature tsd-anchor-link" id="getWorkerInfo.getWorkerInfo-1"><span class="tsd-kind-call-signature">get<wbr/>Worker<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/WorkerInfo.html" class="tsd-signature-type tsd-kind-interface">WorkerInfo</a><a href="#getWorkerInfo.getWorkerInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
76b46937 588<li class="tsd-description">
f04db52f 589<div class="tsd-comment tsd-typography"><p>Gets the worker information given its worker node key.</p>
76b46937 590</div>
591<div class="tsd-parameters">
592<h4 class="tsd-parameters-title">Parameters</h4>
593<ul class="tsd-parameter-list">
594<li>
f04db52f 595<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
596<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
76b46937 597</div>
598<div class="tsd-comment tsd-typography"></div></li></ul></div>
953288ed 599<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/WorkerInfo.html" class="tsd-signature-type tsd-kind-interface">WorkerInfo</a></h4><p>The worker information.</p>
76b46937 600
601<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 602<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#getWorkerInfo">getWorkerInfo</a></p>
76b46937 603<ul>
95c33366 604<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L1390">src/pools/abstract-pool.ts:1390</a></li></ul></aside></li></ul></section>
c22b117f 605<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hasWorkerNodeBackPressure" class="tsd-anchor"></a>
606<h3 class="tsd-anchor-link"><span>has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span><a href="#hasWorkerNodeBackPressure" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
607<ul class="tsd-signatures tsd-is-inherited">
608<li class="tsd-signature tsd-anchor-link" id="hasWorkerNodeBackPressure.hasWorkerNodeBackPressure-1"><span class="tsd-kind-call-signature">has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasWorkerNodeBackPressure.hasWorkerNodeBackPressure-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
609<li class="tsd-description"><code class="tsd-tag ts-flagInternal">Internal</code>
610<div class="tsd-comment tsd-typography"><p>Whether the worker node has back pressure (i.e. its tasks queue is full).</p>
611</div>
612<div class="tsd-parameters">
613<h4 class="tsd-parameters-title">Parameters</h4>
614<ul class="tsd-parameter-list">
615<li>
616<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
617<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
618</div>
619<div class="tsd-comment tsd-typography"></div></li></ul></div>
620<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the worker node has back pressure, <code>false</code> otherwise.</p>
621
622<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
623<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#hasWorkerNodeBackPressure">hasWorkerNodeBackPressure</a></p>
624<ul>
95c33366 625<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L1433">src/pools/abstract-pool.ts:1433</a></li></ul></aside></li></ul></section>
3bd6a82e 626<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="internalBusy" class="tsd-anchor"></a>
15d6dfaf 627<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 628<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 629<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 630<li class="tsd-description">
f4ff239c 631<div class="tsd-comment tsd-typography"><p>Whether worker nodes are executing concurrently their tasks quota or not.</p>
6be0ab6d 632</div>
633<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Worker nodes busyness boolean status.</p>
634
635<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 636<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#internalBusy">internalBusy</a></p>
a76fac14 637<ul>
95c33366 638<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L698">src/pools/abstract-pool.ts:698</a></li></ul></aside></li></ul></section>
3bd6a82e 639<section class="tsd-panel tsd-member tsd-is-protected"><a id="isMain" class="tsd-anchor"></a>
15d6dfaf 640<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 641<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 642<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 643<li class="tsd-description">
6c525543 644<div class="tsd-comment tsd-typography"><p>Should return whether the worker is the main worker or not.</p>
645</div>
15d6dfaf 646<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
647<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 648<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#isMain">isMain</a></p>
a76fac14 649<ul>
95c33366 650<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/thread/fixed.ts#L55">src/pools/thread/fixed.ts:55</a></li></ul></aside></li></ul></section>
013a4697 651<section class="tsd-panel tsd-member tsd-is-inherited"><a id="listTaskFunctions" class="tsd-anchor"></a>
652<h3 class="tsd-anchor-link"><span>list<wbr/>Task<wbr/>Functions</span><a href="#listTaskFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
653<ul class="tsd-signatures tsd-is-inherited">
654<li class="tsd-signature tsd-anchor-link" id="listTaskFunctions.listTaskFunctions-1"><span class="tsd-kind-call-signature">list<wbr/>Task<wbr/>Functions</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#listTaskFunctions.listTaskFunctions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
655<li class="tsd-description">
656<div class="tsd-comment tsd-typography"><p>Lists the names of task function available in this pool.</p>
657</div>
658<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><p>The names of task function available in this pool.</p>
659
660<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
661<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#listTaskFunctions">listTaskFunctions</a></p>
662<ul>
95c33366 663<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L719">src/pools/abstract-pool.ts:719</a></li></ul></aside></li></ul></section>
76b46937 664<section class="tsd-panel tsd-member tsd-is-protected"><a id="registerWorkerMessageListener" class="tsd-anchor"></a>
665<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>register<wbr/>Worker<wbr/>Message<wbr/>Listener</span><a href="#registerWorkerMessageListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
666<ul class="tsd-signatures tsd-is-protected">
f04db52f 667<li class="tsd-signature tsd-anchor-link" id="registerWorkerMessageListener.registerWorkerMessageListener-1"><span class="tsd-kind-call-signature">register<wbr/>Worker<wbr/>Message<wbr/>Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Message</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#registerWorkerMessageListener.registerWorkerMessageListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
76b46937 668<li class="tsd-description">
f04db52f 669<div class="tsd-comment tsd-typography"><p>Registers a listener callback on the worker given its worker node key.</p>
76b46937 670</div>
671<section class="tsd-panel">
672<h4>Type Parameters</h4>
673<ul class="tsd-type-parameter-list">
674<li>
675<h4><span class="tsd-kind-type-parameter">Message</span></h4></li></ul></section>
676<div class="tsd-parameters">
677<h4 class="tsd-parameters-title">Parameters</h4>
678<ul class="tsd-parameter-list">
679<li>
f04db52f 680<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
681<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
76b46937 682</div>
683<div class="tsd-comment tsd-typography"></div></li>
684<li>
685<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
686<div class="tsd-comment tsd-typography"><p>The message listener callback.</p>
687</div>
688<div class="tsd-comment tsd-typography"></div>
689<ul class="tsd-parameters">
690<li class="tsd-parameter-signature">
691<ul class="tsd-signatures">
692<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
693<li class="tsd-description">
694<div class="tsd-parameters">
695<h4 class="tsd-parameters-title">Parameters</h4>
696<ul class="tsd-parameter-list">
697<li>
698<h5><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/MessageValue.html" class="tsd-signature-type tsd-kind-interface">MessageValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Message</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
699<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
700<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
701<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
702<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#registerWorkerMessageListener">registerWorkerMessageListener</a></p>
703<ul>
95c33366 704<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/thread/fixed.ts#L104">src/pools/thread/fixed.ts:104</a></li></ul></aside></li></ul></section>
013a4697 705<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="sendKillMessageToWorker" class="tsd-anchor"></a>
706<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>send<wbr/>Kill<wbr/>Message<wbr/>To<wbr/>Worker</span><a href="#sendKillMessageToWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
707<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
708<li class="tsd-signature tsd-anchor-link" id="sendKillMessageToWorker.sendKillMessageToWorker-1"><span class="tsd-kind-call-signature">send<wbr/>Kill<wbr/>Message<wbr/>To<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span>, <span class="tsd-kind-parameter">workerId</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="#sendKillMessageToWorker.sendKillMessageToWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
709<li class="tsd-description">
710<div class="tsd-parameters">
711<h4 class="tsd-parameters-title">Parameters</h4>
712<ul class="tsd-parameter-list">
713<li>
714<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li>
715<li>
716<h5><span class="tsd-kind-parameter">workerId</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
717<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><aside class="tsd-sources">
718<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#sendKillMessageToWorker">sendKillMessageToWorker</a></p>
719<ul>
95c33366 720<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L804">src/pools/abstract-pool.ts:804</a></li></ul></aside></li></ul></section>
76b46937 721<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendStartupMessageToWorker" class="tsd-anchor"></a>
722<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>send<wbr/>Startup<wbr/>Message<wbr/>To<wbr/>Worker</span><a href="#sendStartupMessageToWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
723<ul class="tsd-signatures tsd-is-protected">
f04db52f 724<li class="tsd-signature tsd-anchor-link" id="sendStartupMessageToWorker.sendStartupMessageToWorker-1"><span class="tsd-kind-call-signature">send<wbr/>Startup<wbr/>Message<wbr/>To<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sendStartupMessageToWorker.sendStartupMessageToWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
76b46937 725<li class="tsd-description">
f04db52f 726<div class="tsd-comment tsd-typography"><p>Sends the startup message to worker given its worker node key.</p>
76b46937 727</div>
728<div class="tsd-parameters">
729<h4 class="tsd-parameters-title">Parameters</h4>
730<ul class="tsd-parameter-list">
731<li>
f04db52f 732<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
733<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
76b46937 734</div>
735<div class="tsd-comment tsd-typography"></div></li></ul></div>
736<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
737<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
738<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#sendStartupMessageToWorker">sendStartupMessageToWorker</a></p>
739<ul>
95c33366 740<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/thread/fixed.ts#L88">src/pools/thread/fixed.ts:88</a></li></ul></aside></li></ul></section>
3bd6a82e 741<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendToWorker" class="tsd-anchor"></a>
15d6dfaf 742<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 743<ul class="tsd-signatures tsd-is-protected">
2447ee8c 744<li class="tsd-signature tsd-anchor-link" id="sendToWorker.sendToWorker-1"><span class="tsd-kind-call-signature">send<wbr/>To<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span>, <span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">transferList</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sendToWorker.sendToWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 745<li class="tsd-description">
f04db52f 746<div class="tsd-comment tsd-typography"><p>Sends a message to worker given its worker node key.</p>
6c525543 747</div>
a76fac14
JB
748<div class="tsd-parameters">
749<h4 class="tsd-parameters-title">Parameters</h4>
750<ul class="tsd-parameter-list">
751<li>
f04db52f 752<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
753<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 754</div>
755<div class="tsd-comment tsd-typography"></div></li>
a76fac14 756<li>
030eb5a3 757<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 758<div class="tsd-comment tsd-typography"><p>The message.</p>
15d6dfaf 759</div>
2447ee8c 760<div class="tsd-comment tsd-typography"></div></li>
761<li>
762<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">transferList</span>: <span class="tsd-signature-type ">TransferListItem</span><span class="tsd-signature-symbol">[]</span></h5>
763<div class="tsd-comment tsd-typography"><p>The optional array of transferable objects.</p>
764</div>
15d6dfaf 765<div class="tsd-comment tsd-typography"></div></li></ul></div>
766<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
767<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 768<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#sendToWorker">sendToWorker</a></p>
a76fac14 769<ul>
95c33366 770<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/thread/fixed.ts#L77">src/pools/thread/fixed.ts:77</a></li></ul></aside></li></ul></section>
3bd6a82e 771<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setTasksQueueOptions" class="tsd-anchor"></a>
15d6dfaf 772<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 773<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 774<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 775<li class="tsd-description">
31542ddf 776<div class="tsd-comment tsd-typography"><p>Sets the worker node tasks queue options in this pool.</p>
6047493a 777</div>
778<div class="tsd-parameters">
779<h4 class="tsd-parameters-title">Parameters</h4>
780<ul class="tsd-parameter-list">
781<li>
8d1797ad 782<h5><span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5>
31542ddf 783<div class="tsd-comment tsd-typography"><p>The worker node tasks queue options.</p>
15d6dfaf 784</div>
785<div class="tsd-comment tsd-typography"></div></li></ul></div>
786<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
787<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6047493a 788<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#setTasksQueueOptions">setTasksQueueOptions</a></p>
789<ul>
95c33366 790<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L648">src/pools/abstract-pool.ts:648</a></li></ul></aside></li></ul></section>
3bd6a82e 791<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setWorkerChoiceStrategy" class="tsd-anchor"></a>
15d6dfaf 792<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 793<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 794<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 795<li class="tsd-description">
6c525543 796<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy in this pool.</p>
797</div>
a76fac14
JB
798<div class="tsd-parameters">
799<h4 class="tsd-parameters-title">Parameters</h4>
800<ul class="tsd-parameter-list">
801<li>
f05afd16 802<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 803<div class="tsd-comment tsd-typography"><p>The worker choice strategy.</p>
15d6dfaf 804</div>
805<div class="tsd-comment tsd-typography"></div></li>
a8aeac44 806<li>
8d1797ad 807<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 808<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
15d6dfaf 809</div>
810<div class="tsd-comment tsd-typography"></div></li></ul></div>
811<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
812<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 813<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#setWorkerChoiceStrategy">setWorkerChoiceStrategy</a></p>
a76fac14 814<ul>
95c33366 815<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L603">src/pools/abstract-pool.ts:603</a></li></ul></aside></li></ul></section>
3bd6a82e 816<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setWorkerChoiceStrategyOptions" class="tsd-anchor"></a>
15d6dfaf 817<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 818<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 819<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 820<li class="tsd-description">
821<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy options in this pool.</p>
822</div>
823<div class="tsd-parameters">
824<h4 class="tsd-parameters-title">Parameters</h4>
825<ul class="tsd-parameter-list">
826<li>
8d1797ad 827<h5><span class="tsd-kind-parameter">workerChoiceStrategyOptions</span>: <a href="../interfaces/WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></h5>
6047493a 828<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
15d6dfaf 829</div>
830<div class="tsd-comment tsd-typography"></div></li></ul></div>
831<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
832<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6047493a 833<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#setWorkerChoiceStrategyOptions">setWorkerChoiceStrategyOptions</a></p>
834<ul>
95c33366 835<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L622">src/pools/abstract-pool.ts:622</a></li></ul></aside></li></ul></section>
3bd6a82e 836<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="setupHook" class="tsd-anchor"></a>
15d6dfaf 837<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 838<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 839<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 840<li class="tsd-description">
030eb5a3 841<div class="tsd-comment tsd-typography"><p>Setup hook to execute code before worker nodes are created in the abstract constructor.
842Can be overridden.</p>
a76fac14 843</div>
15d6dfaf 844<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
845<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 846<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#setupHook">setupHook</a></p>
a76fac14 847<ul>
95c33366 848<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L833">src/pools/abstract-pool.ts:833</a></li></ul></aside></li></ul></section>
3bd6a82e 849<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="workerListener" class="tsd-anchor"></a>
15d6dfaf 850<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 851<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 852<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 853<li class="tsd-description">
f04db52f 854<div class="tsd-comment tsd-typography"><p>This method is the listener registered for each worker message.</p>
a76fac14 855</div>
fab6d3b5 856<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>
857
a76fac14
JB
858<ul class="tsd-parameters">
859<li class="tsd-parameter-signature">
3bd6a82e 860<ul class="tsd-signatures">
861<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 862<li class="tsd-description">
f04db52f 863<div class="tsd-comment tsd-typography"><p>This method is the listener registered for each worker message.</p>
a76fac14
JB
864</div>
865<div class="tsd-parameters">
866<h4 class="tsd-parameters-title">Parameters</h4>
867<ul class="tsd-parameter-list">
868<li>
030eb5a3 869<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 870<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 871
872<div class="tsd-comment tsd-typography"></div></li></ul></li></ul>
873<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 874<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#workerListener">workerListener</a></p>
a76fac14 875<ul>
95c33366 876<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/069e56f/src/pools/abstract-pool.ts#L1302">src/pools/abstract-pool.ts:1302</a></li></ul></aside></li></ul></section></section></div>
ec06e4dd 877<div class="col-sidebar">
878<div class="page-menu">
a76fac14
JB
879<div class="tsd-navigation settings">
880<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
15d6dfaf 881<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
882<div class="tsd-accordion-details">
883<div class="tsd-filter-visibility">
884<h4 class="uppercase">Member Visibility</h4><form>
885<ul id="tsd-filter-options">
886<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>
887<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>
888<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>
889<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>
890<div class="tsd-theme-toggle">
3bd6a82e 891<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 892<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 893<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
894<div class="tsd-accordion-details">
895<ul>
15d6dfaf 896<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>
897<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>
898<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>
00471704 899<li><a href="#max" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max</span></a></li>
15d6dfaf 900<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>
901<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>
902<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>
903<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>
904<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>
905<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>
906<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>
907<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>
00471704 908<li><a href="#maxSize" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>max<wbr/>Size</span></a></li>
909<li><a href="#minSize" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>min<wbr/>Size</span></a></li>
c914a50e 910<li><a href="#ready" class="tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>ready</span></a></li>
15d6dfaf 911<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 912<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 913<li><a href="#worker" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>worker</span></a></li>
914<li><a href="#afterTaskExecutionHook" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>after<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a></li>
f04db52f 915<li><a href="#afterWorkerNodeSetup" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>after<wbr/>Worker<wbr/>Node<wbr/>Setup</span></a></li>
15d6dfaf 916<li><a href="#beforeTaskExecutionHook" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>before<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a></li>
c914a50e 917<li><a href="#checkDynamicPoolSize" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Dynamic<wbr/>Pool<wbr/>Size</span></a></li>
f04db52f 918<li><a href="#createAndSetupDynamicWorkerNode" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>And<wbr/>Setup<wbr/>Dynamic<wbr/>Worker<wbr/>Node</span></a></li>
919<li><a href="#createAndSetupWorkerNode" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>And<wbr/>Setup<wbr/>Worker<wbr/>Node</span></a></li>
15d6dfaf 920<li><a href="#createWorker" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Worker</span></a></li>
921<li><a href="#destroy" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a></li>
f04db52f 922<li><a href="#destroyWorkerNode" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy<wbr/>Worker<wbr/>Node</span></a></li>
15d6dfaf 923<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>
924<li><a href="#execute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>execute</span></a></li>
f04db52f 925<li><a href="#flushTasksQueue" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flush<wbr/>Tasks<wbr/>Queue</span></a></li>
926<li><a href="#getWorkerInfo" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Worker<wbr/>Info</span></a></li>
c22b117f 927<li><a href="#hasWorkerNodeBackPressure" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span></a></li>
15d6dfaf 928<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>
929<li><a href="#isMain" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Main</span></a></li>
013a4697 930<li><a href="#listTaskFunctions" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Task<wbr/>Functions</span></a></li>
76b46937 931<li><a href="#registerWorkerMessageListener" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Worker<wbr/>Message<wbr/>Listener</span></a></li>
013a4697 932<li><a href="#sendKillMessageToWorker" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Kill<wbr/>Message<wbr/>To<wbr/>Worker</span></a></li>
76b46937 933<li><a href="#sendStartupMessageToWorker" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Startup<wbr/>Message<wbr/>To<wbr/>Worker</span></a></li>
15d6dfaf 934<li><a href="#sendToWorker" class="tsd-is-protected"><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>
935<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>
936<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>
937<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>
938<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>
939<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 940<div class="site-menu">
0bb3df76 941<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>poolifier -<wbr/> v2.6.34</span></a>
ec06e4dd 942<ul class="tsd-small-nested-navigation">
15d6dfaf 943<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>
944<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>
945<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>
946<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>
31542ddf 947<li><a href="Deque.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Deque</span></a></li>
15d6dfaf 948<li><a href="DynamicClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dynamic<wbr/>Cluster<wbr/>Pool</span></a></li>
949<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>
950<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>
951<li><a href="FixedThreadPool.html" class="current"><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>
f2d2c4a4 952<li><a href="Node.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Node</span></a></li>
15d6dfaf 953<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>
15d6dfaf 954<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>
955<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>
956<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 957<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 958<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>
959<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>
960<li><a href="../interfaces/IWorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker<wbr/>Choice<wbr/>Strategy</span></a></li>
a6b5c73c 961<li><a href="../interfaces/IWorkerNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker<wbr/>Node</span></a></li>
f05afd16 962<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>
963<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>
964<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 965<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>
966<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>
967<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>
968<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 969<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 970<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 971<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 972<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 973<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 974<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 975<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 976<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 977<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 978<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 979<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 980<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 981<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 982<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 983<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>
984<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>
0e16e60a 985<li><a href="../types/KillHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Kill<wbr/>Handler</span></a></li>
f05afd16 986<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 987<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>
988<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>
989<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>
990<li><a href="../types/PoolType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Pool<wbr/>Type</span></a></li>
3c7c9bd1 991<li><a href="../types/TaskAsyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Async<wbr/>Function</span></a></li>
992<li><a href="../types/TaskFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Function</span></a></li>
15d6dfaf 993<li><a href="../types/TaskFunctions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Functions</span></a></li>
3c7c9bd1 994<li><a href="../types/TaskSyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Sync<wbr/>Function</span></a></li>
15d6dfaf 995<li><a href="../types/WorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy</span></a></li>
15d6dfaf 996<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>
969223ea 997<li><a href="../types/Writable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Writable</span></a></li>
15d6dfaf 998<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 999<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 1000<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>
1001<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>
1002<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 1003<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>
1004<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 1005<div class="tsd-generator">
a76fac14 1006<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
ec06e4dd 1007<div class="overlay"></div></body></html>