refactor: cleanup handlers
[poolifier.git] / docs / classes / AbstractPool.html
CommitLineData
013a4697 1<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AbstractPool | poolifier - v2.6.26</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">
6c525543 2<div class="tsd-toolbar-contents container">
3<div class="table-cell" id="tsd-search" data-base="..">
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>
7<ul class="results">
8<li class="state loading">Preparing search index...</li>
013a4697 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.6.26</a></div>
6c525543 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>
11<div class="container container-main">
12<div class="col-content">
13<div class="tsd-page-title">
14<ul class="tsd-breadcrumb">
15<li><a href="../index.html">poolifier</a></li>
16<li><a href="AbstractPool.html">AbstractPool</a></li></ul>
17<h1>Class AbstractPool&lt;Worker, Data, Response&gt;<code class="tsd-tag ts-flagAbstract">Abstract</code> </h1></div>
18<section class="tsd-panel tsd-comment">
19<div class="tsd-comment tsd-typography"><p>Base class that implements some shared logic for all poolifier pools.</p>
15d6dfaf 20</div>
21<div class="tsd-comment tsd-typography"></div></section>
fab6d3b5 22<section class="tsd-panel">
6c525543 23<h4>Type Parameters</h4>
fab6d3b5 24<ul class="tsd-type-parameter-list">
6c525543 25<li>
8d1797ad 26<h4><span class="tsd-kind-type-parameter">Worker</span><span class="tsd-signature-symbol"> extends </span><a href="../interfaces/IWorker.html" class="tsd-signature-type tsd-kind-interface">IWorker</a></h4>
6c525543 27<div class="tsd-comment tsd-typography"><p>Type of worker which manages this pool.</p>
15d6dfaf 28</div>
29<div class="tsd-comment tsd-typography"></div></li>
6c525543 30<li>
3bd6a82e 31<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 32<div class="tsd-comment tsd-typography"><p>Type of data sent to the worker. This can only be structured-cloneable data.</p>
15d6dfaf 33</div>
34<div class="tsd-comment tsd-typography"></div></li>
6c525543 35<li>
3bd6a82e 36<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 37<div class="tsd-comment tsd-typography"><p>Type of execution response. This can only be structured-cloneable data.</p>
15d6dfaf 38</div>
39<div class="tsd-comment tsd-typography"></div></li></ul></section>
6c525543 40<section class="tsd-panel tsd-hierarchy">
41<h4>Hierarchy</h4>
42<ul class="tsd-hierarchy">
43<li><span class="target">AbstractPool</span>
44<ul class="tsd-hierarchy">
8d1797ad 45<li><a href="FixedClusterPool.html" class="tsd-signature-type tsd-kind-class">FixedClusterPool</a></li>
46<li><a href="FixedThreadPool.html" class="tsd-signature-type tsd-kind-class">FixedThreadPool</a></li></ul></li></ul></section>
6c525543 47<section class="tsd-panel">
48<h4>Implements</h4>
49<ul class="tsd-hierarchy">
8d1797ad 50<li><a href="../interfaces/IPool.html" class="tsd-signature-type tsd-kind-interface">IPool</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">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></li></ul></section><aside class="tsd-sources">
6c525543 51<ul>
0e16e60a 52<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L56">src/pools/abstract-pool.ts:56</a></li></ul></aside>
6c525543 53<section class="tsd-panel-group tsd-index-group">
54<section class="tsd-panel tsd-index-panel">
55<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
56<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>
57<div class="tsd-accordion-details">
58<section class="tsd-index-section">
59<h3 class="tsd-index-heading">Constructors</h3>
15d6dfaf 60<div class="tsd-index-list"><a href="AbstractPool.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>
6c525543 61</div></section>
62<section class="tsd-index-section">
63<h3 class="tsd-index-heading">Properties</h3>
15d6dfaf 64<div class="tsd-index-list"><a href="AbstractPool.html#emitter" class="tsd-index-link"><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>
65<a href="AbstractPool.html#filePath" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>file<wbr/>Path</span></a>
66<a href="AbstractPool.html#numberOfWorkers" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>number<wbr/>Of<wbr/>Workers</span></a>
67<a href="AbstractPool.html#opts" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>opts</span></a>
68<a href="AbstractPool.html#promiseResponseMap" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>promise<wbr/>Response<wbr/>Map</span></a>
202bcb6b 69<a href="AbstractPool.html#startTimestamp" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>start<wbr/>Timestamp</span></a>
44b95861 70<a href="AbstractPool.html#starting" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>starting</span></a>
013a4697 71<a href="AbstractPool.html#taskFunctions" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>task<wbr/>Functions</span></a>
15d6dfaf 72<a href="AbstractPool.html#workerChoiceStrategyContext" class="tsd-index-link tsd-is-protected"><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>
73<a href="AbstractPool.html#workerNodes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Nodes</span></a>
6c525543 74</div></section>
75<section class="tsd-index-section">
76<h3 class="tsd-index-heading">Accessors</h3>
15d6dfaf 77<div class="tsd-index-list"><a href="AbstractPool.html#busy" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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>
78<a href="AbstractPool.html#full" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>full</span></a>
79<a href="AbstractPool.html#info" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>info</span></a>
80<a href="AbstractPool.html#maxSize" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>max<wbr/>Size</span></a>
81<a href="AbstractPool.html#minSize" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>min<wbr/>Size</span></a>
c914a50e 82<a href="AbstractPool.html#ready" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>ready</span></a>
15d6dfaf 83<a href="AbstractPool.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 84<a href="AbstractPool.html#utilization" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>utilization</span></a>
15d6dfaf 85<a href="AbstractPool.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>
6c525543 86</div></section>
87<section class="tsd-index-section">
88<h3 class="tsd-index-heading">Methods</h3>
7b88db4b 89<div class="tsd-index-list"><a href="AbstractPool.html#addWorkerNode" class="tsd-index-link tsd-is-private"><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>add<wbr/>Worker<wbr/>Node</span></a>
90<a href="AbstractPool.html#afterTaskExecutionHook" class="tsd-index-link tsd-is-protected"><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>
f04db52f 91<a href="AbstractPool.html#afterWorkerNodeSetup" class="tsd-index-link tsd-is-protected"><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 92<a href="AbstractPool.html#beforeTaskExecutionHook" class="tsd-index-link tsd-is-protected"><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>
93<a href="AbstractPool.html#buildTasksQueueOptions" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>build<wbr/>Tasks<wbr/>Queue<wbr/>Options</span></a>
94<a href="AbstractPool.html#checkAndEmitEvents" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>And<wbr/>Emit<wbr/>Events</span></a>
c914a50e 95<a href="AbstractPool.html#checkDynamicPoolSize" class="tsd-index-link tsd-is-protected"><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>
15d6dfaf 96<a href="AbstractPool.html#checkFilePath" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>File<wbr/>Path</span></a>
47c9cec4 97<a href="AbstractPool.html#checkMessageWorkerId" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Message<wbr/>Worker<wbr/>Id</span></a>
15d6dfaf 98<a href="AbstractPool.html#checkNumberOfWorkers" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Number<wbr/>Of<wbr/>Workers</span></a>
99<a href="AbstractPool.html#checkPoolOptions" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Pool<wbr/>Options</span></a>
100<a href="AbstractPool.html#checkValidTasksQueueOptions" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Valid<wbr/>Tasks<wbr/>Queue<wbr/>Options</span></a>
101<a href="AbstractPool.html#checkValidWorkerChoiceStrategy" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Valid<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span></a>
102<a href="AbstractPool.html#checkValidWorkerChoiceStrategyOptions" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Valid<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a>
6be0ab6d 103<a href="AbstractPool.html#chooseWorkerNode" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>choose<wbr/>Worker<wbr/>Node</span></a>
f04db52f 104<a href="AbstractPool.html#createAndSetupDynamicWorkerNode" 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/>And<wbr/>Setup<wbr/>Dynamic<wbr/>Worker<wbr/>Node</span></a>
105<a href="AbstractPool.html#createAndSetupWorkerNode" 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/>And<wbr/>Setup<wbr/>Worker<wbr/>Node</span></a>
15d6dfaf 106<a href="AbstractPool.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>
107<a href="AbstractPool.html#dequeueTask" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>dequeue<wbr/>Task</span></a>
108<a href="AbstractPool.html#destroy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a>
f04db52f 109<a href="AbstractPool.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 110<a href="AbstractPool.html#enableTasksQueue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enable<wbr/>Tasks<wbr/>Queue</span></a>
111<a href="AbstractPool.html#enqueueTask" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enqueue<wbr/>Task</span></a>
112<a href="AbstractPool.html#execute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>execute</span></a>
113<a href="AbstractPool.html#executeTask" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>execute<wbr/>Task</span></a>
f04db52f 114<a href="AbstractPool.html#flushTasksQueue" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flush<wbr/>Tasks<wbr/>Queue</span></a>
15d6dfaf 115<a href="AbstractPool.html#flushTasksQueues" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flush<wbr/>Tasks<wbr/>Queues</span></a>
f04db52f 116<a href="AbstractPool.html#getWorkerInfo" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Worker<wbr/>Info</span></a>
117<a href="AbstractPool.html#getWorkerNodeKeyByWorker" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Worker<wbr/>Node<wbr/>Key<wbr/>By<wbr/>Worker</span></a>
118<a href="AbstractPool.html#getWorkerNodeKeyByWorkerId" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Worker<wbr/>Node<wbr/>Key<wbr/>By<wbr/>Worker<wbr/>Id</span></a>
202bcb6b 119<a href="AbstractPool.html#handleTaskExecutionResponse" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Task<wbr/>Execution<wbr/>Response</span></a>
79f98bd9 120<a href="AbstractPool.html#handleWorkerReadyResponse" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Worker<wbr/>Ready<wbr/>Response</span></a>
15d6dfaf 121<a href="AbstractPool.html#internalBusy" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>internal<wbr/>Busy</span></a>
122<a href="AbstractPool.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 123<a href="AbstractPool.html#listTaskFunctions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Task<wbr/>Functions</span></a>
912e1dfa 124<a href="AbstractPool.html#redistributeQueuedTasks" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>redistribute<wbr/>Queued<wbr/>Tasks</span></a>
76b46937 125<a href="AbstractPool.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>
15d6dfaf 126<a href="AbstractPool.html#removeWorkerNode" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Worker<wbr/>Node</span></a>
013a4697 127<a href="AbstractPool.html#sendKillMessageToWorker" 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/>Kill<wbr/>Message<wbr/>To<wbr/>Worker</span></a>
76b46937 128<a href="AbstractPool.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>
013a4697 129<a href="AbstractPool.html#sendStatisticsMessageToWorker" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Statistics<wbr/>Message<wbr/>To<wbr/>Worker</span></a>
15d6dfaf 130<a href="AbstractPool.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>
131<a href="AbstractPool.html#setTasksQueueOptions" class="tsd-index-link"><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>
132<a href="AbstractPool.html#setWorkerChoiceStrategy" class="tsd-index-link"><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>
133<a href="AbstractPool.html#setWorkerChoiceStrategyOptions" class="tsd-index-link"><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>
15d6dfaf 134<a href="AbstractPool.html#setupHook" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>setup<wbr/>Hook</span></a>
6be0ab6d 135<a href="AbstractPool.html#shallCreateDynamicWorker" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>shall<wbr/>Create<wbr/>Dynamic<wbr/>Worker</span></a>
177be4a6 136<a href="AbstractPool.html#startPool" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>start<wbr/>Pool</span></a>
15d6dfaf 137<a href="AbstractPool.html#tasksQueueSize" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>tasks<wbr/>Queue<wbr/>Size</span></a>
f05afd16 138<a href="AbstractPool.html#updateEluWorkerUsage" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Elu<wbr/>Worker<wbr/>Usage</span></a>
139<a href="AbstractPool.html#updateRunTimeWorkerUsage" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Run<wbr/>Time<wbr/>Worker<wbr/>Usage</span></a>
aac8863d 140<a href="AbstractPool.html#updateTaskStatisticsWorkerUsage" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Task<wbr/>Statistics<wbr/>Worker<wbr/>Usage</span></a>
f05afd16 141<a href="AbstractPool.html#updateWaitTimeWorkerUsage" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Wait<wbr/>Time<wbr/>Worker<wbr/>Usage</span></a>
15d6dfaf 142<a href="AbstractPool.html#workerListener" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>worker<wbr/>Listener</span></a>
6c525543 143</div></section></div></details></section></section>
144<section class="tsd-panel-group tsd-member-group">
145<h2>Constructors</h2>
3bd6a82e 146<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
15d6dfaf 147<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 148<ul class="tsd-signatures">
15d6dfaf 149<li class="tsd-signature tsd-anchor-link" id="constructor.new_AbstractPool"><span class="tsd-kind-constructor-signature">new <wbr/>Abstract<wbr/>Pool</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">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><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">numberOfWorkers</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><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 tsd-kind-type-parameter">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><a href="#constructor.new_AbstractPool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 150<li class="tsd-description">
151<div class="tsd-comment tsd-typography"><p>Constructs a new poolifier pool.</p>
152</div>
fab6d3b5 153<section class="tsd-panel">
6c525543 154<h4>Type Parameters</h4>
fab6d3b5 155<ul class="tsd-type-parameter-list">
6c525543 156<li>
a97f9c80 157<h4><span class="tsd-kind-type-parameter">Worker</span><span class="tsd-signature-symbol"> extends </span><a href="../interfaces/IWorker.html" class="tsd-signature-type tsd-kind-interface">IWorker</a></h4></li>
6c525543 158<li>
3bd6a82e 159<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4></li>
6c525543 160<li>
3bd6a82e 161<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section>
6c525543 162<div class="tsd-parameters">
163<h4 class="tsd-parameters-title">Parameters</h4>
164<ul class="tsd-parameter-list">
165<li>
3bd6a82e 166<h5><span class="tsd-kind-parameter">numberOfWorkers</span>: <span class="tsd-signature-type">number</span></h5>
6c525543 167<div class="tsd-comment tsd-typography"><p>Number of workers that this pool should manage.</p>
15d6dfaf 168</div>
169<div class="tsd-comment tsd-typography"></div></li>
6c525543 170<li>
3bd6a82e 171<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
f63918da 172<div class="tsd-comment tsd-typography"><p>Path to the worker file.</p>
15d6dfaf 173</div>
174<div class="tsd-comment tsd-typography"></div></li>
6c525543 175<li>
8d1797ad 176<h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/PoolOptions.html" class="tsd-signature-type tsd-kind-interface">PoolOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Worker</span><span class="tsd-signature-symbol">&gt;</span></h5>
6c525543 177<div class="tsd-comment tsd-typography"><p>Options for the pool.</p>
15d6dfaf 178</div>
179<div class="tsd-comment tsd-typography"></div></li></ul></div>
180<h4 class="tsd-returns-title">Returns <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 tsd-kind-type-parameter">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></h4>
181<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 182<ul>
0e16e60a 183<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L107">src/pools/abstract-pool.ts:107</a></li></ul></aside></li></ul></section></section>
6c525543 184<section class="tsd-panel-group tsd-member-group">
185<h2>Properties</h2>
3bd6a82e 186<section class="tsd-panel tsd-member"><a id="emitter" class="tsd-anchor"></a>
15d6dfaf 187<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 188<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 189<div class="tsd-comment tsd-typography"><p>Emitter on which events can be listened to.</p>
190<p>Events that can currently be listened to:</p>
191<ul>
c914a50e 192<li><code>&#39;full&#39;</code>: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.</li>
85c03385 193<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 194<li><code>&#39;busy&#39;</code>: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.</li>
ccb7d1a7 195<li><code>&#39;error&#39;</code>: Emitted when an uncaught error occurs.</li>
196<li><code>&#39;taskError&#39;</code>: Emitted when an error occurs while executing a task.</li>
6c525543 197</ul>
15d6dfaf 198</div>
199<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 200<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#emitter">emitter</a></p>
201<ul>
0e16e60a 202<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L65">src/pools/abstract-pool.ts:65</a></li></ul></aside></section>
184d530f 203<section class="tsd-panel tsd-member tsd-is-protected"><a id="filePath" class="tsd-anchor"></a>
15d6dfaf 204<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 205<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 206<div class="tsd-comment tsd-typography"><p>Path to the worker file.</p>
15d6dfaf 207</div>
208<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 209<ul>
0e16e60a 210<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L109">src/pools/abstract-pool.ts:109</a></li></ul></aside></section>
184d530f 211<section class="tsd-panel tsd-member tsd-is-protected"><a id="numberOfWorkers" class="tsd-anchor"></a>
15d6dfaf 212<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 213<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>
6c525543 214<div class="tsd-comment tsd-typography"><p>Number of workers that this pool should manage.</p>
15d6dfaf 215</div>
216<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 217<ul>
0e16e60a 218<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L108">src/pools/abstract-pool.ts:108</a></li></ul></aside></section>
184d530f 219<section class="tsd-panel tsd-member tsd-is-protected"><a id="opts" class="tsd-anchor"></a>
15d6dfaf 220<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>opts</span><a href="#opts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
8d1797ad 221<div class="tsd-signature"><span class="tsd-kind-property">opts</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/PoolOptions.html" class="tsd-signature-type tsd-kind-interface">PoolOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Worker</span><span class="tsd-signature-symbol">&gt;</span></div>
6c525543 222<div class="tsd-comment tsd-typography"><p>Options for the pool.</p>
15d6dfaf 223</div>
224<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 225<ul>
0e16e60a 226<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L110">src/pools/abstract-pool.ts:110</a></li></ul></aside></section>
3bd6a82e 227<section class="tsd-panel tsd-member tsd-is-protected"><a id="promiseResponseMap" class="tsd-anchor"></a>
15d6dfaf 228<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 229<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>
230<div class="tsd-comment tsd-typography"><p>The task execution response promise map.</p>
6c525543 231<ul>
232<li><code>key</code>: The message id of each submitted task.</li>
233<li><code>value</code>: An object that contains the worker, the execution response promise resolve and reject callbacks.</li>
234</ul>
235<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 236</div>
237<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 238<ul>
0e16e60a 239<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L75">src/pools/abstract-pool.ts:75</a></li></ul></aside></section>
202bcb6b 240<section class="tsd-panel tsd-member tsd-is-private"><a id="startTimestamp" class="tsd-anchor"></a>
241<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>start<wbr/>Timestamp</span><a href="#startTimestamp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
242<div class="tsd-signature"><span class="tsd-kind-property">start<wbr/>Timestamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
243<div class="tsd-comment tsd-typography"><p>The start timestamp of the pool.</p>
244</div>
245<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
246<ul>
0e16e60a 247<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L94">src/pools/abstract-pool.ts:94</a></li></ul></aside></section>
44b95861 248<section class="tsd-panel tsd-member tsd-is-private"><a id="starting" class="tsd-anchor"></a>
249<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>starting</span><a href="#starting" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
250<div class="tsd-signature"><span class="tsd-kind-property">starting</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
251<div class="tsd-comment tsd-typography"><p>Whether the pool is starting or not.</p>
252</div>
253<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
254<ul>
0e16e60a 255<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L90">src/pools/abstract-pool.ts:90</a></li></ul></aside></section>
013a4697 256<section class="tsd-panel tsd-member tsd-is-private"><a id="taskFunctions" class="tsd-anchor"></a>
257<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>task<wbr/>Functions</span><a href="#taskFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
258<div class="tsd-signature"><span class="tsd-kind-property">task<wbr/>Functions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
259<div class="tsd-comment tsd-typography"><p>The task function names.</p>
260</div>
261<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
262<ul>
0e16e60a 263<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L98">src/pools/abstract-pool.ts:98</a></li></ul></aside></section>
3bd6a82e 264<section class="tsd-panel tsd-member tsd-is-protected"><a id="workerChoiceStrategyContext" class="tsd-anchor"></a>
15d6dfaf 265<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span><a href="#workerChoiceStrategyContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
8d1797ad 266<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 tsd-kind-type-parameter">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>
6c525543 267<div class="tsd-comment tsd-typography"><p>Worker choice strategy context referencing a worker choice algorithm implementation.</p>
15d6dfaf 268</div>
269<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 270<ul>
0e16e60a 271<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L81">src/pools/abstract-pool.ts:81</a></li></ul></aside></section>
3bd6a82e 272<section class="tsd-panel tsd-member"><a id="workerNodes" class="tsd-anchor"></a>
15d6dfaf 273<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>worker<wbr/>Nodes</span><a href="#workerNodes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
a6b5c73c 274<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 tsd-kind-type-parameter">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 275<div class="tsd-comment tsd-typography"><p>Pool worker nodes.</p>
15d6dfaf 276</div>
277<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 278<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#workerNodes">workerNodes</a></p>
279<ul>
0e16e60a 280<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L62">src/pools/abstract-pool.ts:62</a></li></ul></aside></section></section>
6c525543 281<section class="tsd-panel-group tsd-member-group">
282<h2>Accessors</h2>
3bd6a82e 283<section class="tsd-panel tsd-member tsd-is-protected"><a id="busy" class="tsd-anchor"></a>
15d6dfaf 284<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>busy</span><a href="#busy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 285<ul class="tsd-signatures tsd-is-protected">
6c525543 286<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>
287<li class="tsd-description">
288<div class="tsd-comment tsd-typography"><p>Whether the pool is busy or not.</p>
289<p>The pool busyness boolean status.</p>
290</div>
15d6dfaf 291<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
292<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 293<ul>
0e16e60a 294<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L622">src/pools/abstract-pool.ts:622</a></li></ul></aside></li></ul></section>
3bd6a82e 295<section class="tsd-panel tsd-member tsd-is-protected"><a id="full" class="tsd-anchor"></a>
15d6dfaf 296<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>
3bd6a82e 297<ul class="tsd-signatures tsd-is-protected">
6c525543 298<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>
299<li class="tsd-description">
300<div class="tsd-comment tsd-typography"><p>Whether the pool is full or not.</p>
301<p>The pool filling boolean status.</p>
302</div>
15d6dfaf 303<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
304<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 305<ul>
0e16e60a 306<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L613">src/pools/abstract-pool.ts:613</a></li></ul></aside></li></ul></section>
a2742ce7 307<section class="tsd-panel tsd-member"><a id="info" class="tsd-anchor"></a>
15d6dfaf 308<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 309<ul class="tsd-signatures">
310<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>
6c525543 311<li class="tsd-description">
a2742ce7 312<div class="tsd-comment tsd-typography"><p>Pool information.</p>
6c525543 313</div>
15d6dfaf 314<h4 class="tsd-returns-title">Returns <a href="../interfaces/PoolInfo.html" class="tsd-signature-type tsd-kind-interface">PoolInfo</a></h4>
315<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a2742ce7 316<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#info">info</a></p>
6c525543 317<ul>
0e16e60a 318<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L308">src/pools/abstract-pool.ts:308</a></li></ul></aside></li></ul></section>
a2742ce7 319<section class="tsd-panel tsd-member tsd-is-protected"><a id="maxSize" class="tsd-anchor"></a>
15d6dfaf 320<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>max<wbr/>Size</span><a href="#maxSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
a2742ce7 321<ul class="tsd-signatures tsd-is-protected">
322<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>
6c525543 323<li class="tsd-description">
f04db52f 324<div class="tsd-comment tsd-typography"><p>The pool maximum size.</p>
6c525543 325</div>
15d6dfaf 326<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
327<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 328<ul>
0e16e60a 329<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L504">src/pools/abstract-pool.ts:504</a></li></ul></aside></li></ul></section>
a2742ce7 330<section class="tsd-panel tsd-member tsd-is-protected"><a id="minSize" class="tsd-anchor"></a>
15d6dfaf 331<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>min<wbr/>Size</span><a href="#minSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
a2742ce7 332<ul class="tsd-signatures tsd-is-protected">
333<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 334<li class="tsd-description">
f04db52f 335<div class="tsd-comment tsd-typography"><p>The pool minimum size.</p>
2c94c3a5 336</div>
15d6dfaf 337<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
338<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
2c94c3a5 339<ul>
0e16e60a 340<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L499">src/pools/abstract-pool.ts:499</a></li></ul></aside></li></ul></section>
c914a50e 341<section class="tsd-panel tsd-member tsd-is-private"><a id="ready" class="tsd-anchor"></a>
342<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>
343<ul class="tsd-signatures tsd-is-private">
344<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>
345<li class="tsd-description">
f04db52f 346<div class="tsd-comment tsd-typography"><p>The pool readiness boolean status.</p>
347</div>
348<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
349<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
c914a50e 350<ul>
0e16e60a 351<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L451">src/pools/abstract-pool.ts:451</a></li></ul></aside></li></ul></section>
184d530f 352<section class="tsd-panel tsd-member tsd-is-protected"><a id="type" class="tsd-anchor"></a>
15d6dfaf 353<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
184d530f 354<ul class="tsd-signatures tsd-is-protected">
a2742ce7 355<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>
6c525543 356<li class="tsd-description">
f04db52f 357<div class="tsd-comment tsd-typography"><p>The pool type.</p>
6c525543 358<p>If it is <code>&#39;dynamic&#39;</code>, it provides the <code>max</code> property.</p>
359</div>
15d6dfaf 360<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>
361<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 362<ul>
0e16e60a 363<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L489">src/pools/abstract-pool.ts:489</a></li></ul></aside></li></ul></section>
202bcb6b 364<section class="tsd-panel tsd-member tsd-is-private"><a id="utilization" class="tsd-anchor"></a>
365<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>
366<ul class="tsd-signatures tsd-is-private">
367<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>
368<li class="tsd-description">
f04db52f 369<div class="tsd-comment tsd-typography"><p>The approximate pool utilization.</p>
202bcb6b 370</div>
371<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The pool utilization.</p>
372
373<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
374<ul>
0e16e60a 375<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L468">src/pools/abstract-pool.ts:468</a></li></ul></aside></li></ul></section>
184d530f 376<section class="tsd-panel tsd-member tsd-is-protected"><a id="worker" class="tsd-anchor"></a>
15d6dfaf 377<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>worker</span><a href="#worker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
184d530f 378<ul class="tsd-signatures tsd-is-protected">
3c7c9bd1 379<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 380<li class="tsd-description">
f04db52f 381<div class="tsd-comment tsd-typography"><p>The worker type.</p>
184d530f 382</div>
3c7c9bd1 383<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 384<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
184d530f 385<ul>
0e16e60a 386<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L494">src/pools/abstract-pool.ts:494</a></li></ul></aside></li></ul></section></section>
6c525543 387<section class="tsd-panel-group tsd-member-group">
388<h2>Methods</h2>
7b88db4b 389<section class="tsd-panel tsd-member tsd-is-private"><a id="addWorkerNode" class="tsd-anchor"></a>
390<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>add<wbr/>Worker<wbr/>Node</span><a href="#addWorkerNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
391<ul class="tsd-signatures tsd-is-private">
392<li class="tsd-signature tsd-anchor-link" id="addWorkerNode.addWorkerNode-1"><span class="tsd-kind-call-signature">add<wbr/>Worker<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#addWorkerNode.addWorkerNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
393<li class="tsd-description">
394<div class="tsd-comment tsd-typography"><p>Adds the given worker in the pool worker nodes.</p>
395</div>
396<div class="tsd-parameters">
397<h4 class="tsd-parameters-title">Parameters</h4>
398<ul class="tsd-parameter-list">
399<li>
400<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></h5>
401<div class="tsd-comment tsd-typography"><p>The worker.</p>
402</div>
403<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 404<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The added worker node key.</p>
7b88db4b 405
f04db52f 406<div class="tsd-comment tsd-typography">
407<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the added worker node is not found.</p>
408</div><aside class="tsd-sources">
7b88db4b 409<ul>
0e16e60a 410<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1190">src/pools/abstract-pool.ts:1190</a></li></ul></aside></li></ul></section>
3bd6a82e 411<section class="tsd-panel tsd-member tsd-is-protected"><a id="afterTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 412<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 413<ul class="tsd-signatures tsd-is-protected">
f04db52f 414<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>
6c525543 415<li class="tsd-description">
416<div class="tsd-comment tsd-typography"><p>Hook executed after the worker task execution.
417Can be overridden.</p>
418</div>
419<div class="tsd-parameters">
420<h4 class="tsd-parameters-title">Parameters</h4>
421<ul class="tsd-parameter-list">
422<li>
f04db52f 423<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
424<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 425</div>
426<div class="tsd-comment tsd-typography"></div></li>
6c525543 427<li>
030eb5a3 428<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>
6c525543 429<div class="tsd-comment tsd-typography"><p>The received message.</p>
15d6dfaf 430</div>
431<div class="tsd-comment tsd-typography"></div></li></ul></div>
432<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
433<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 434<ul>
0e16e60a 435<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L792">src/pools/abstract-pool.ts:792</a></li></ul></aside></li></ul></section>
f04db52f 436<section class="tsd-panel tsd-member tsd-is-protected"><a id="afterWorkerNodeSetup" class="tsd-anchor"></a>
437<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>after<wbr/>Worker<wbr/>Node<wbr/>Setup</span><a href="#afterWorkerNodeSetup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 438<ul class="tsd-signatures tsd-is-protected">
f04db52f 439<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>
6c525543 440<li class="tsd-description">
f04db52f 441<div class="tsd-comment tsd-typography"><p>Method hooked up after a worker node has been newly created.
030eb5a3 442Can be overridden.</p>
6c525543 443</div>
444<div class="tsd-parameters">
445<h4 class="tsd-parameters-title">Parameters</h4>
446<ul class="tsd-parameter-list">
447<li>
f04db52f 448<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
449<div class="tsd-comment tsd-typography"><p>The newly created worker node key.</p>
15d6dfaf 450</div>
451<div class="tsd-comment tsd-typography"></div></li></ul></div>
452<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
453<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 454<ul>
0e16e60a 455<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1025">src/pools/abstract-pool.ts:1025</a></li></ul></aside></li></ul></section>
3bd6a82e 456<section class="tsd-panel tsd-member tsd-is-protected"><a id="beforeTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 457<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 458<ul class="tsd-signatures tsd-is-protected">
f05afd16 459<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>
6c525543 460<li class="tsd-description">
461<div class="tsd-comment tsd-typography"><p>Hook executed before the worker task execution.
462Can be overridden.</p>
463</div>
464<div class="tsd-parameters">
465<h4 class="tsd-parameters-title">Parameters</h4>
466<ul class="tsd-parameter-list">
467<li>
3bd6a82e 468<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
6c525543 469<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 470</div>
f05afd16 471<div class="tsd-comment tsd-typography"></div></li>
472<li>
473<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>
474<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
475</div>
15d6dfaf 476<div class="tsd-comment tsd-typography"></div></li></ul></div>
477<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
478<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 479<ul>
0e16e60a 480<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L771">src/pools/abstract-pool.ts:771</a></li></ul></aside></li></ul></section>
3bd6a82e 481<section class="tsd-panel tsd-member tsd-is-private"><a id="buildTasksQueueOptions" class="tsd-anchor"></a>
15d6dfaf 482<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>build<wbr/>Tasks<wbr/>Queue<wbr/>Options</span><a href="#buildTasksQueueOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 483<ul class="tsd-signatures tsd-is-private">
15d6dfaf 484<li class="tsd-signature tsd-anchor-link" id="buildTasksQueueOptions.buildTasksQueueOptions-1"><span class="tsd-kind-call-signature">build<wbr/>Tasks<wbr/>Queue<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tasksQueueOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a><a href="#buildTasksQueueOptions.buildTasksQueueOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6047493a 485<li class="tsd-description">
486<div class="tsd-parameters">
487<h4 class="tsd-parameters-title">Parameters</h4>
488<ul class="tsd-parameter-list">
489<li>
8d1797ad 490<h5><span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5></li></ul></div>
491<h4 class="tsd-returns-title">Returns <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h4><aside class="tsd-sources">
6047493a 492<ul>
0e16e60a 493<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L600">src/pools/abstract-pool.ts:600</a></li></ul></aside></li></ul></section>
3bd6a82e 494<section class="tsd-panel tsd-member tsd-is-private"><a id="checkAndEmitEvents" class="tsd-anchor"></a>
15d6dfaf 495<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>And<wbr/>Emit<wbr/>Events</span><a href="#checkAndEmitEvents" 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-private">
15d6dfaf 497<li class="tsd-signature tsd-anchor-link" id="checkAndEmitEvents.checkAndEmitEvents-1"><span class="tsd-kind-call-signature">check<wbr/>And<wbr/>Emit<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkAndEmitEvents.checkAndEmitEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 498<li class="tsd-description">
499<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
500<ul>
0e16e60a 501<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1162">src/pools/abstract-pool.ts:1162</a></li></ul></aside></li></ul></section>
c914a50e 502<section class="tsd-panel tsd-member tsd-is-protected"><a id="checkDynamicPoolSize" class="tsd-anchor"></a>
503<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>
504<ul class="tsd-signatures tsd-is-protected">
505<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>
506<li class="tsd-description">
507<div class="tsd-parameters">
508<h4 class="tsd-parameters-title">Parameters</h4>
509<ul class="tsd-parameter-list">
510<li>
511<h5><span class="tsd-kind-parameter">min</span>: <span class="tsd-signature-type">number</span></h5></li>
512<li>
513<h5><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
514<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
515<ul>
0e16e60a 516<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L180">src/pools/abstract-pool.ts:180</a></li></ul></aside></li></ul></section>
3bd6a82e 517<section class="tsd-panel tsd-member tsd-is-private"><a id="checkFilePath" class="tsd-anchor"></a>
15d6dfaf 518<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>File<wbr/>Path</span><a href="#checkFilePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 519<ul class="tsd-signatures tsd-is-private">
15d6dfaf 520<li class="tsd-signature tsd-anchor-link" id="checkFilePath.checkFilePath-1"><span class="tsd-kind-call-signature">check<wbr/>File<wbr/>Path</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkFilePath.checkFilePath-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 521<li class="tsd-description">
522<div class="tsd-parameters">
523<h4 class="tsd-parameters-title">Parameters</h4>
524<ul class="tsd-parameter-list">
525<li>
3bd6a82e 526<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
6c525543 527<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
528<ul>
0e16e60a 529<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L149">src/pools/abstract-pool.ts:149</a></li></ul></aside></li></ul></section>
47c9cec4 530<section class="tsd-panel tsd-member tsd-is-private"><a id="checkMessageWorkerId" class="tsd-anchor"></a>
531<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Message<wbr/>Worker<wbr/>Id</span><a href="#checkMessageWorkerId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
532<ul class="tsd-signatures tsd-is-private">
533<li class="tsd-signature tsd-anchor-link" id="checkMessageWorkerId.checkMessageWorkerId-1"><span class="tsd-kind-call-signature">check<wbr/>Message<wbr/>Worker<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkMessageWorkerId.checkMessageWorkerId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
534<li class="tsd-description">
7b88db4b 535<div class="tsd-comment tsd-typography"><p>Checks if the worker id sent in the received message from a worker is valid.</p>
536</div>
47c9cec4 537<div class="tsd-parameters">
538<h4 class="tsd-parameters-title">Parameters</h4>
539<ul class="tsd-parameter-list">
540<li>
7b88db4b 541<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>
542<div class="tsd-comment tsd-typography"><p>The received message.</p>
543</div>
544<div class="tsd-comment tsd-typography"></div></li></ul></div>
545<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
546<div class="tsd-comment tsd-typography">
547<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the worker id is invalid.</p>
548</div><aside class="tsd-sources">
47c9cec4 549<ul>
0e16e60a 550<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L512">src/pools/abstract-pool.ts:512</a></li></ul></aside></li></ul></section>
3bd6a82e 551<section class="tsd-panel tsd-member tsd-is-private"><a id="checkNumberOfWorkers" class="tsd-anchor"></a>
15d6dfaf 552<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Number<wbr/>Of<wbr/>Workers</span><a href="#checkNumberOfWorkers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 553<ul class="tsd-signatures tsd-is-private">
15d6dfaf 554<li class="tsd-signature tsd-anchor-link" id="checkNumberOfWorkers.checkNumberOfWorkers-1"><span class="tsd-kind-call-signature">check<wbr/>Number<wbr/>Of<wbr/>Workers</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">numberOfWorkers</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkNumberOfWorkers.checkNumberOfWorkers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 555<li class="tsd-description">
556<div class="tsd-parameters">
557<h4 class="tsd-parameters-title">Parameters</h4>
558<ul class="tsd-parameter-list">
559<li>
3bd6a82e 560<h5><span class="tsd-kind-parameter">numberOfWorkers</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
6c525543 561<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
562<ul>
0e16e60a 563<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L162">src/pools/abstract-pool.ts:162</a></li></ul></aside></li></ul></section>
3bd6a82e 564<section class="tsd-panel tsd-member tsd-is-private"><a id="checkPoolOptions" class="tsd-anchor"></a>
15d6dfaf 565<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Pool<wbr/>Options</span><a href="#checkPoolOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 566<ul class="tsd-signatures tsd-is-private">
15d6dfaf 567<li class="tsd-signature tsd-anchor-link" id="checkPoolOptions.checkPoolOptions-1"><span class="tsd-kind-call-signature">check<wbr/>Pool<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkPoolOptions.checkPoolOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 568<li class="tsd-description">
569<div class="tsd-parameters">
570<h4 class="tsd-parameters-title">Parameters</h4>
571<ul class="tsd-parameter-list">
572<li>
8d1797ad 573<h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/PoolOptions.html" class="tsd-signature-type tsd-kind-interface">PoolOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Worker</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
6c525543 574<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
575<ul>
0e16e60a 576<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L206">src/pools/abstract-pool.ts:206</a></li></ul></aside></li></ul></section>
3bd6a82e 577<section class="tsd-panel tsd-member tsd-is-private"><a id="checkValidTasksQueueOptions" class="tsd-anchor"></a>
15d6dfaf 578<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Valid<wbr/>Tasks<wbr/>Queue<wbr/>Options</span><a href="#checkValidTasksQueueOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 579<ul class="tsd-signatures tsd-is-private">
15d6dfaf 580<li class="tsd-signature tsd-anchor-link" id="checkValidTasksQueueOptions.checkValidTasksQueueOptions-1"><span class="tsd-kind-call-signature">check<wbr/>Valid<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="#checkValidTasksQueueOptions.checkValidTasksQueueOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6047493a 581<li class="tsd-description">
582<div class="tsd-parameters">
583<h4 class="tsd-parameters-title">Parameters</h4>
584<ul class="tsd-parameter-list">
585<li>
8d1797ad 586<h5><span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5></li></ul></div>
6047493a 587<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
588<ul>
0e16e60a 589<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L271">src/pools/abstract-pool.ts:271</a></li></ul></aside></li></ul></section>
3bd6a82e 590<section class="tsd-panel tsd-member tsd-is-private"><a id="checkValidWorkerChoiceStrategy" class="tsd-anchor"></a>
15d6dfaf 591<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Valid<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span><a href="#checkValidWorkerChoiceStrategy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 592<ul class="tsd-signatures tsd-is-private">
15d6dfaf 593<li class="tsd-signature tsd-anchor-link" id="checkValidWorkerChoiceStrategy.checkValidWorkerChoiceStrategy-1"><span class="tsd-kind-call-signature">check<wbr/>Valid<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerChoiceStrategy</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkValidWorkerChoiceStrategy.checkValidWorkerChoiceStrategy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 594<li class="tsd-description">
595<div class="tsd-parameters">
596<h4 class="tsd-parameters-title">Parameters</h4>
597<ul class="tsd-parameter-list">
598<li>
f05afd16 599<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></li></ul></div>
6c525543 600<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
601<ul>
0e16e60a 602<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L233">src/pools/abstract-pool.ts:233</a></li></ul></aside></li></ul></section>
2c94c3a5 603<section class="tsd-panel tsd-member tsd-is-private"><a id="checkValidWorkerChoiceStrategyOptions" class="tsd-anchor"></a>
15d6dfaf 604<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Valid<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span><a href="#checkValidWorkerChoiceStrategyOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
2c94c3a5 605<ul class="tsd-signatures tsd-is-private">
15d6dfaf 606<li class="tsd-signature tsd-anchor-link" id="checkValidWorkerChoiceStrategyOptions.checkValidWorkerChoiceStrategyOptions-1"><span class="tsd-kind-call-signature">check<wbr/>Valid<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerChoiceStrategyOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkValidWorkerChoiceStrategyOptions.checkValidWorkerChoiceStrategyOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
2c94c3a5 607<li class="tsd-description">
608<div class="tsd-parameters">
609<h4 class="tsd-parameters-title">Parameters</h4>
610<ul class="tsd-parameter-list">
611<li>
612<h5><span class="tsd-kind-parameter">workerChoiceStrategyOptions</span>: <a href="../interfaces/WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></h5></li></ul></div>
613<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
614<ul>
0e16e60a 615<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L243">src/pools/abstract-pool.ts:243</a></li></ul></aside></li></ul></section>
6be0ab6d 616<section class="tsd-panel tsd-member tsd-is-private"><a id="chooseWorkerNode" class="tsd-anchor"></a>
617<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>choose<wbr/>Worker<wbr/>Node</span><a href="#chooseWorkerNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
618<ul class="tsd-signatures tsd-is-private">
15d6dfaf 619<li class="tsd-signature tsd-anchor-link" id="chooseWorkerNode.chooseWorkerNode-1"><span class="tsd-kind-call-signature">choose<wbr/>Worker<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#chooseWorkerNode.chooseWorkerNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 620<li class="tsd-description">
621<div class="tsd-comment tsd-typography"><p>Chooses a worker node for the next task.</p>
6be0ab6d 622<p>The default worker choice strategy uses a round robin algorithm to distribute the tasks.</p>
6c525543 623</div>
f04db52f 624<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The chosen worker node key</p>
15d6dfaf 625
626<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 627<ul>
0e16e60a 628<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L886">src/pools/abstract-pool.ts:886</a></li></ul></aside></li></ul></section>
f04db52f 629<section class="tsd-panel tsd-member tsd-is-protected"><a id="createAndSetupDynamicWorkerNode" class="tsd-anchor"></a>
630<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>
6be0ab6d 631<ul class="tsd-signatures tsd-is-protected">
f04db52f 632<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>
6be0ab6d 633<li class="tsd-description">
f04db52f 634<div class="tsd-comment tsd-typography"><p>Creates a new, completely set up dynamic worker node.</p>
6be0ab6d 635</div>
f04db52f 636<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>New, completely set up dynamic worker node key.</p>
6be0ab6d 637
638<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
639<ul>
0e16e60a 640<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L972">src/pools/abstract-pool.ts:972</a></li></ul></aside></li></ul></section>
f04db52f 641<section class="tsd-panel tsd-member tsd-is-protected"><a id="createAndSetupWorkerNode" class="tsd-anchor"></a>
642<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 643<ul class="tsd-signatures tsd-is-protected">
f04db52f 644<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>
6c525543 645<li class="tsd-description">
f04db52f 646<div class="tsd-comment tsd-typography"><p>Creates a new, completely set up worker node.</p>
6c525543 647</div>
f04db52f 648<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>New, completely set up worker node key.</p>
15d6dfaf 649
650<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 651<ul>
0e16e60a 652<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L932">src/pools/abstract-pool.ts:932</a></li></ul></aside></li></ul></section>
3bd6a82e 653<section class="tsd-panel tsd-member tsd-is-protected"><a id="createWorker" class="tsd-anchor"></a>
15d6dfaf 654<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</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 655<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 656<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 tsd-kind-type-parameter">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>
6c525543 657<li class="tsd-description">
6be0ab6d 658<div class="tsd-comment tsd-typography"><p>Creates a new worker.</p>
6c525543 659</div>
6be0ab6d 660<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></h4><p>Newly created worker.</p>
661
15d6dfaf 662<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 663<ul>
0e16e60a 664<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L925">src/pools/abstract-pool.ts:925</a></li></ul></aside></li></ul></section>
3bd6a82e 665<section class="tsd-panel tsd-member tsd-is-private"><a id="dequeueTask" class="tsd-anchor"></a>
15d6dfaf 666<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>dequeue<wbr/>Task</span><a href="#dequeueTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 667<ul class="tsd-signatures tsd-is-private">
15d6dfaf 668<li class="tsd-signature tsd-anchor-link" id="dequeueTask.dequeueTask-1"><span class="tsd-kind-call-signature">dequeue<wbr/>Task</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Task.html" class="tsd-signature-type tsd-kind-interface">Task</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span><a href="#dequeueTask.dequeueTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 669<li class="tsd-description">
670<div class="tsd-parameters">
671<h4 class="tsd-parameters-title">Parameters</h4>
672<ul class="tsd-parameter-list">
673<li>
3bd6a82e 674<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
8d1797ad 675<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Task.html" class="tsd-signature-type tsd-kind-interface">Task</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
6c525543 676<ul>
0e16e60a 677<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1232">src/pools/abstract-pool.ts:1232</a></li></ul></aside></li></ul></section>
3bd6a82e 678<section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a>
15d6dfaf 679<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 680<ul class="tsd-signatures">
15d6dfaf 681<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>
6c525543 682<li class="tsd-description">
f04db52f 683<div class="tsd-comment tsd-typography"><p>Terminates all workers in this pool.</p>
6c525543 684</div>
15d6dfaf 685<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>
686<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 687<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#destroy">destroy</a></p>
6c525543 688<ul>
0e16e60a 689<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L718">src/pools/abstract-pool.ts:718</a></li></ul></aside></li></ul></section>
f04db52f 690<section class="tsd-panel tsd-member tsd-is-protected"><a id="destroyWorkerNode" class="tsd-anchor"></a>
691<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</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 692<ul class="tsd-signatures tsd-is-protected">
f04db52f 693<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>
6c525543 694<li class="tsd-description">
f04db52f 695<div class="tsd-comment tsd-typography"><p>Terminates the worker node given its worker node key.</p>
6c525543 696</div>
697<div class="tsd-parameters">
698<h4 class="tsd-parameters-title">Parameters</h4>
699<ul class="tsd-parameter-list">
700<li>
f04db52f 701<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
702<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 703</div>
704<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 705<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>
15d6dfaf 706<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 707<ul>
0e16e60a 708<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L747">src/pools/abstract-pool.ts:747</a></li></ul></aside></li></ul></section>
3bd6a82e 709<section class="tsd-panel tsd-member"><a id="enableTasksQueue" class="tsd-anchor"></a>
15d6dfaf 710<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 711<ul class="tsd-signatures">
15d6dfaf 712<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 713<li class="tsd-description">
714<div class="tsd-comment tsd-typography"><p>Enables/disables the worker tasks queue in this pool.</p>
715</div>
716<div class="tsd-parameters">
717<h4 class="tsd-parameters-title">Parameters</h4>
718<ul class="tsd-parameter-list">
719<li>
3bd6a82e 720<h5><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></h5>
6047493a 721<div class="tsd-comment tsd-typography"><p>Whether to enable or disable the worker tasks queue.</p>
15d6dfaf 722</div>
723<div class="tsd-comment tsd-typography"></div></li>
6047493a 724<li>
8d1797ad 725<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5>
d655c2c2 726<div class="tsd-comment tsd-typography"><p>The worker tasks queue options.</p>
15d6dfaf 727</div>
728<div class="tsd-comment tsd-typography"></div></li></ul></div>
729<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
730<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 731<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#enableTasksQueue">enableTasksQueue</a></p>
6047493a 732<ul>
0e16e60a 733<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L578">src/pools/abstract-pool.ts:578</a></li></ul></aside></li></ul></section>
3bd6a82e 734<section class="tsd-panel tsd-member tsd-is-private"><a id="enqueueTask" class="tsd-anchor"></a>
15d6dfaf 735<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>enqueue<wbr/>Task</span><a href="#enqueueTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 736<ul class="tsd-signatures tsd-is-private">
15d6dfaf 737<li class="tsd-signature tsd-anchor-link" id="enqueueTask.enqueueTask-1"><span class="tsd-kind-call-signature">enqueue<wbr/>Task</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span>, <span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#enqueueTask.enqueueTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 738<li class="tsd-description">
739<div class="tsd-parameters">
740<h4 class="tsd-parameters-title">Parameters</h4>
741<ul class="tsd-parameter-list">
742<li>
3bd6a82e 743<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li>
6c525543 744<li>
8d1797ad 745<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></li></ul></div>
6c525543 746<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
747<ul>
0e16e60a 748<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1228">src/pools/abstract-pool.ts:1228</a></li></ul></aside></li></ul></section>
3bd6a82e 749<section class="tsd-panel tsd-member"><a id="execute" class="tsd-anchor"></a>
15d6dfaf 750<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 751<ul class="tsd-signatures">
2447ee8c 752<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>
6c525543 753<li class="tsd-description">
1bb559f9 754<div class="tsd-comment tsd-typography"><p>Executes the specified function in the worker constructor with the task data input parameter.</p>
6c525543 755</div>
756<div class="tsd-parameters">
757<h4 class="tsd-parameters-title">Parameters</h4>
758<ul class="tsd-parameter-list">
759<li>
3bd6a82e 760<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 761<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 762</div>
763<div class="tsd-comment tsd-typography"></div></li>
2c94c3a5 764<li>
765<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 766<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>
767</div>
768<div class="tsd-comment tsd-typography"></div></li>
769<li>
770<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>
771<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 772</div>
773<div class="tsd-comment tsd-typography"></div></li></ul></div>
fab6d3b5 774<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 775
776<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 777<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#execute">execute</a></p>
6c525543 778<ul>
0e16e60a 779<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L659">src/pools/abstract-pool.ts:659</a></li></ul></aside></li></ul></section>
3bd6a82e 780<section class="tsd-panel tsd-member tsd-is-private"><a id="executeTask" class="tsd-anchor"></a>
15d6dfaf 781<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>execute<wbr/>Task</span><a href="#executeTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 782<ul class="tsd-signatures tsd-is-private">
15d6dfaf 783<li class="tsd-signature tsd-anchor-link" id="executeTask.executeTask-1"><span class="tsd-kind-call-signature">execute<wbr/>Task</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span>, <span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#executeTask.executeTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 784<li class="tsd-description">
f04db52f 785<div class="tsd-comment tsd-typography"><p>Executes the given task on the worker given its worker node key.</p>
7b88db4b 786</div>
6c525543 787<div class="tsd-parameters">
788<h4 class="tsd-parameters-title">Parameters</h4>
789<ul class="tsd-parameter-list">
790<li>
f04db52f 791<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
792<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
793</div>
794<div class="tsd-comment tsd-typography"></div></li>
6c525543 795<li>
7b88db4b 796<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>
797<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
798</div>
799<div class="tsd-comment tsd-typography"></div></li></ul></div>
800<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
801<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 802<ul>
0e16e60a 803<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1223">src/pools/abstract-pool.ts:1223</a></li></ul></aside></li></ul></section>
f04db52f 804<section class="tsd-panel tsd-member tsd-is-protected"><a id="flushTasksQueue" class="tsd-anchor"></a>
805<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>
806<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 807<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>
6c525543 808<li class="tsd-description">
809<div class="tsd-parameters">
810<h4 class="tsd-parameters-title">Parameters</h4>
811<ul class="tsd-parameter-list">
812<li>
3bd6a82e 813<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
6c525543 814<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
815<ul>
0e16e60a 816<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1240">src/pools/abstract-pool.ts:1240</a></li></ul></aside></li></ul></section>
3bd6a82e 817<section class="tsd-panel tsd-member tsd-is-private"><a id="flushTasksQueues" class="tsd-anchor"></a>
15d6dfaf 818<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>flush<wbr/>Tasks<wbr/>Queues</span><a href="#flushTasksQueues" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 819<ul class="tsd-signatures tsd-is-private">
15d6dfaf 820<li class="tsd-signature tsd-anchor-link" id="flushTasksQueues.flushTasksQueues-1"><span class="tsd-kind-call-signature">flush<wbr/>Tasks<wbr/>Queues</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#flushTasksQueues.flushTasksQueues-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
761b0c73 821<li class="tsd-description">
822<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
823<ul>
0e16e60a 824<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1250">src/pools/abstract-pool.ts:1250</a></li></ul></aside></li></ul></section>
f04db52f 825<section class="tsd-panel tsd-member tsd-is-protected"><a id="getWorkerInfo" class="tsd-anchor"></a>
826<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>
827<ul class="tsd-signatures tsd-is-protected">
912e1dfa 828<li class="tsd-signature tsd-anchor-link" id="getWorkerInfo.getWorkerInfo-1"><span class="tsd-kind-call-signature">get<wbr/>Worker<wbr/>Info</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/WorkerInfo.html" class="tsd-signature-type tsd-kind-interface">WorkerInfo</a><a href="#getWorkerInfo.getWorkerInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
829<li class="tsd-description">
f04db52f 830<div class="tsd-comment tsd-typography"><p>Gets the worker information given its worker node key.</p>
912e1dfa 831</div>
832<div class="tsd-parameters">
833<h4 class="tsd-parameters-title">Parameters</h4>
834<ul class="tsd-parameter-list">
835<li>
836<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
837<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
838</div>
839<div class="tsd-comment tsd-typography"></div></li></ul></div>
76b46937 840<h4 class="tsd-returns-title">Returns <a href="../interfaces/WorkerInfo.html" class="tsd-signature-type tsd-kind-interface">WorkerInfo</a></h4><p>The worker information.</p>
841
912e1dfa 842<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
843<ul>
0e16e60a 844<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1179">src/pools/abstract-pool.ts:1179</a></li></ul></aside></li></ul></section>
f04db52f 845<section class="tsd-panel tsd-member tsd-is-private"><a id="getWorkerNodeKeyByWorker" class="tsd-anchor"></a>
846<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Worker<wbr/>Node<wbr/>Key<wbr/>By<wbr/>Worker</span><a href="#getWorkerNodeKeyByWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
847<ul class="tsd-signatures tsd-is-private">
848<li class="tsd-signature tsd-anchor-link" id="getWorkerNodeKeyByWorker.getWorkerNodeKeyByWorker-1"><span class="tsd-kind-call-signature">get<wbr/>Worker<wbr/>Node<wbr/>Key<wbr/>By<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getWorkerNodeKeyByWorker.getWorkerNodeKeyByWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
76b46937 849<li class="tsd-description">
f04db52f 850<div class="tsd-comment tsd-typography"><p>Gets the given worker its worker node key.</p>
76b46937 851</div>
852<div class="tsd-parameters">
853<h4 class="tsd-parameters-title">Parameters</h4>
854<ul class="tsd-parameter-list">
855<li>
856<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></h5>
857<div class="tsd-comment tsd-typography"><p>The worker.</p>
858</div>
859<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 860<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The worker node key if found in the pool worker nodes, <code>-1</code> otherwise.</p>
76b46937 861
f04db52f 862<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
76b46937 863<ul>
0e16e60a 864<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L529">src/pools/abstract-pool.ts:529</a></li></ul></aside></li></ul></section>
f04db52f 865<section class="tsd-panel tsd-member tsd-is-private"><a id="getWorkerNodeKeyByWorkerId" class="tsd-anchor"></a>
866<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Worker<wbr/>Node<wbr/>Key<wbr/>By<wbr/>Worker<wbr/>Id</span><a href="#getWorkerNodeKeyByWorkerId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
867<ul class="tsd-signatures tsd-is-private">
868<li class="tsd-signature tsd-anchor-link" id="getWorkerNodeKeyByWorkerId.getWorkerNodeKeyByWorkerId-1"><span class="tsd-kind-call-signature">get<wbr/>Worker<wbr/>Node<wbr/>Key<wbr/>By<wbr/>Worker<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getWorkerNodeKeyByWorkerId.getWorkerNodeKeyByWorkerId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 869<li class="tsd-description">
f04db52f 870<div class="tsd-comment tsd-typography"><p>Gets the worker node key given its worker id.</p>
6c525543 871</div>
872<div class="tsd-parameters">
873<h4 class="tsd-parameters-title">Parameters</h4>
874<ul class="tsd-parameter-list">
875<li>
f04db52f 876<h5><span class="tsd-kind-parameter">workerId</span>: <span class="tsd-signature-type">number</span></h5>
877<div class="tsd-comment tsd-typography"><p>The worker id.</p>
15d6dfaf 878</div>
879<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 880<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The worker node key if the worker id is found in the pool worker nodes, <code>-1</code> otherwise.</p>
15d6dfaf 881
882<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 883<ul>
0e16e60a 884<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L541">src/pools/abstract-pool.ts:541</a></li></ul></aside></li></ul></section>
202bcb6b 885<section class="tsd-panel tsd-member tsd-is-private"><a id="handleTaskExecutionResponse" class="tsd-anchor"></a>
886<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>handle<wbr/>Task<wbr/>Execution<wbr/>Response</span><a href="#handleTaskExecutionResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
887<ul class="tsd-signatures tsd-is-private">
888<li class="tsd-signature tsd-anchor-link" id="handleTaskExecutionResponse.handleTaskExecutionResponse-1"><span class="tsd-kind-call-signature">handle<wbr/>Task<wbr/>Execution<wbr/>Response</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#handleTaskExecutionResponse.handleTaskExecutionResponse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
889<li class="tsd-description">
890<div class="tsd-parameters">
891<h4 class="tsd-parameters-title">Parameters</h4>
892<ul class="tsd-parameter-list">
893<li>
894<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>
895<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
896<ul>
0e16e60a 897<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1133">src/pools/abstract-pool.ts:1133</a></li></ul></aside></li></ul></section>
79f98bd9 898<section class="tsd-panel tsd-member tsd-is-private"><a id="handleWorkerReadyResponse" class="tsd-anchor"></a>
899<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>handle<wbr/>Worker<wbr/>Ready<wbr/>Response</span><a href="#handleWorkerReadyResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
202bcb6b 900<ul class="tsd-signatures tsd-is-private">
79f98bd9 901<li class="tsd-signature tsd-anchor-link" id="handleWorkerReadyResponse.handleWorkerReadyResponse-1"><span class="tsd-kind-call-signature">handle<wbr/>Worker<wbr/>Ready<wbr/>Response</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#handleWorkerReadyResponse.handleWorkerReadyResponse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
202bcb6b 902<li class="tsd-description">
903<div class="tsd-parameters">
904<h4 class="tsd-parameters-title">Parameters</h4>
905<ul class="tsd-parameter-list">
906<li>
907<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>
908<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
909<ul>
0e16e60a 910<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1124">src/pools/abstract-pool.ts:1124</a></li></ul></aside></li></ul></section>
3bd6a82e 911<section class="tsd-panel tsd-member tsd-is-protected"><a id="internalBusy" class="tsd-anchor"></a>
15d6dfaf 912<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 913<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 914<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>
6c525543 915<li class="tsd-description">
f4ff239c 916<div class="tsd-comment tsd-typography"><p>Whether worker nodes are executing concurrently their tasks quota or not.</p>
6be0ab6d 917</div>
918<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Worker nodes busyness boolean status.</p>
919
920<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 921<ul>
0e16e60a 922<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L629">src/pools/abstract-pool.ts:629</a></li></ul></aside></li></ul></section>
3bd6a82e 923<section class="tsd-panel tsd-member tsd-is-protected"><a id="isMain" class="tsd-anchor"></a>
15d6dfaf 924<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>is<wbr/>Main</span><a href="#isMain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 925<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 926<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>
6c525543 927<li class="tsd-description">
928<div class="tsd-comment tsd-typography"><p>Should return whether the worker is the main worker or not.</p>
929</div>
15d6dfaf 930<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
931<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 932<ul>
0e16e60a 933<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L762">src/pools/abstract-pool.ts:762</a></li></ul></aside></li></ul></section>
013a4697 934<section class="tsd-panel tsd-member"><a id="listTaskFunctions" class="tsd-anchor"></a>
935<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>
936<ul class="tsd-signatures">
937<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>
938<li class="tsd-description">
939<div class="tsd-comment tsd-typography"><p>Lists the names of task function available in this pool.</p>
940</div>
941<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>
942
943<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
944<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#listTaskFunctions">listTaskFunctions</a></p>
945<ul>
0e16e60a 946<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L650">src/pools/abstract-pool.ts:650</a></li></ul></aside></li></ul></section>
912e1dfa 947<section class="tsd-panel tsd-member tsd-is-private"><a id="redistributeQueuedTasks" class="tsd-anchor"></a>
948<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>redistribute<wbr/>Queued<wbr/>Tasks</span><a href="#redistributeQueuedTasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
949<ul class="tsd-signatures tsd-is-private">
7b88db4b 950<li class="tsd-signature tsd-anchor-link" id="redistributeQueuedTasks.redistributeQueuedTasks-1"><span class="tsd-kind-call-signature">redistribute<wbr/>Queued<wbr/>Tasks</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#redistributeQueuedTasks.redistributeQueuedTasks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
912e1dfa 951<li class="tsd-description">
952<div class="tsd-parameters">
953<h4 class="tsd-parameters-title">Parameters</h4>
954<ul class="tsd-parameter-list">
955<li>
7b88db4b 956<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
912e1dfa 957<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
958<ul>
0e16e60a 959<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1059">src/pools/abstract-pool.ts:1059</a></li></ul></aside></li></ul></section>
76b46937 960<section class="tsd-panel tsd-member tsd-is-protected"><a id="registerWorkerMessageListener" class="tsd-anchor"></a>
961<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>register<wbr/>Worker<wbr/>Message<wbr/>Listener</span><a href="#registerWorkerMessageListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
962<ul class="tsd-signatures tsd-is-protected">
f04db52f 963<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>
6c525543 964<li class="tsd-description">
f04db52f 965<div class="tsd-comment tsd-typography"><p>Registers a listener callback on the worker given its worker node key.</p>
6c525543 966</div>
fab6d3b5 967<section class="tsd-panel">
6c525543 968<h4>Type Parameters</h4>
fab6d3b5 969<ul class="tsd-type-parameter-list">
6c525543 970<li>
3bd6a82e 971<h4><span class="tsd-kind-type-parameter">Message</span></h4></li></ul></section>
6c525543 972<div class="tsd-parameters">
973<h4 class="tsd-parameters-title">Parameters</h4>
974<ul class="tsd-parameter-list">
975<li>
f04db52f 976<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
977<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 978</div>
979<div class="tsd-comment tsd-typography"></div></li>
6c525543 980<li>
3bd6a82e 981<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>
6c525543 982<div class="tsd-comment tsd-typography"><p>The message listener callback.</p>
983</div>
15d6dfaf 984<div class="tsd-comment tsd-typography"></div>
6c525543 985<ul class="tsd-parameters">
986<li class="tsd-parameter-signature">
3bd6a82e 987<ul class="tsd-signatures">
988<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>
6c525543 989<li class="tsd-description">
990<div class="tsd-parameters">
991<h4 class="tsd-parameters-title">Parameters</h4>
992<ul class="tsd-parameter-list">
993<li>
030eb5a3 994<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>
6c525543 995<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
15d6dfaf 996<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
997<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 998<ul>
0e16e60a 999<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1012">src/pools/abstract-pool.ts:1012</a></li></ul></aside></li></ul></section>
3bd6a82e 1000<section class="tsd-panel tsd-member tsd-is-private"><a id="removeWorkerNode" class="tsd-anchor"></a>
15d6dfaf 1001<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>remove<wbr/>Worker<wbr/>Node</span><a href="#removeWorkerNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 1002<ul class="tsd-signatures tsd-is-private">
15d6dfaf 1003<li class="tsd-signature tsd-anchor-link" id="removeWorkerNode.removeWorkerNode-1"><span class="tsd-kind-call-signature">remove<wbr/>Worker<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#removeWorkerNode.removeWorkerNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 1004<li class="tsd-description">
1005<div class="tsd-comment tsd-typography"><p>Removes the given worker from the pool worker nodes.</p>
1006</div>
1007<div class="tsd-parameters">
1008<h4 class="tsd-parameters-title">Parameters</h4>
1009<ul class="tsd-parameter-list">
1010<li>
3bd6a82e 1011<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></h5>
6c525543 1012<div class="tsd-comment tsd-typography"><p>The worker.</p>
15d6dfaf 1013</div>
1014<div class="tsd-comment tsd-typography"></div></li></ul></div>
1015<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1016<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1017<ul>
0e16e60a 1018<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1209">src/pools/abstract-pool.ts:1209</a></li></ul></aside></li></ul></section>
013a4697 1019<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendKillMessageToWorker" class="tsd-anchor"></a>
1020<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>
1021<ul class="tsd-signatures tsd-is-protected">
1022<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>
1023<li class="tsd-description">
1024<div class="tsd-parameters">
1025<h4 class="tsd-parameters-title">Parameters</h4>
1026<ul class="tsd-parameter-list">
1027<li>
1028<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li>
1029<li>
1030<h5><span class="tsd-kind-parameter">workerId</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
1031<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">
1032<ul>
0e16e60a 1033<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L726">src/pools/abstract-pool.ts:726</a></li></ul></aside></li></ul></section>
76b46937 1034<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendStartupMessageToWorker" class="tsd-anchor"></a>
1035<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>send<wbr/>Startup<wbr/>Message<wbr/>To<wbr/>Worker</span><a href="#sendStartupMessageToWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1036<ul class="tsd-signatures tsd-is-protected">
f04db52f 1037<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 1038<li class="tsd-description">
f04db52f 1039<div class="tsd-comment tsd-typography"><p>Sends the startup message to worker given its worker node key.</p>
76b46937 1040</div>
1041<div class="tsd-parameters">
1042<h4 class="tsd-parameters-title">Parameters</h4>
1043<ul class="tsd-parameter-list">
1044<li>
f04db52f 1045<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1046<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
76b46937 1047</div>
1048<div class="tsd-comment tsd-typography"></div></li></ul></div>
1049<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1050<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1051<ul>
0e16e60a 1052<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1039">src/pools/abstract-pool.ts:1039</a></li></ul></aside></li></ul></section>
013a4697 1053<section class="tsd-panel tsd-member tsd-is-private"><a id="sendStatisticsMessageToWorker" class="tsd-anchor"></a>
1054<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>send<wbr/>Statistics<wbr/>Message<wbr/>To<wbr/>Worker</span><a href="#sendStatisticsMessageToWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1055<ul class="tsd-signatures tsd-is-private">
1056<li class="tsd-signature tsd-anchor-link" id="sendStatisticsMessageToWorker.sendStatisticsMessageToWorker-1"><span class="tsd-kind-call-signature">send<wbr/>Statistics<wbr/>Message<wbr/>To<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sendStatisticsMessageToWorker.sendStatisticsMessageToWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1057<li class="tsd-description">
1058<div class="tsd-comment tsd-typography"><p>Sends the statistics message to worker given its worker node key.</p>
1059</div>
1060<div class="tsd-parameters">
1061<h4 class="tsd-parameters-title">Parameters</h4>
1062<ul class="tsd-parameter-list">
1063<li>
1064<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1065<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
1066</div>
1067<div class="tsd-comment tsd-typography"></div></li></ul></div>
1068<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1069<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1070<ul>
0e16e60a 1071<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1046">src/pools/abstract-pool.ts:1046</a></li></ul></aside></li></ul></section>
3bd6a82e 1072<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendToWorker" class="tsd-anchor"></a>
15d6dfaf 1073<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>send<wbr/>To<wbr/>Worker</span><a href="#sendToWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 1074<ul class="tsd-signatures tsd-is-protected">
2447ee8c 1075<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>
6c525543 1076<li class="tsd-description">
f04db52f 1077<div class="tsd-comment tsd-typography"><p>Sends a message to worker given its worker node key.</p>
6c525543 1078</div>
1079<div class="tsd-parameters">
1080<h4 class="tsd-parameters-title">Parameters</h4>
1081<ul class="tsd-parameter-list">
1082<li>
f04db52f 1083<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1084<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 1085</div>
1086<div class="tsd-comment tsd-typography"></div></li>
6c525543 1087<li>
030eb5a3 1088<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 1089<div class="tsd-comment tsd-typography"><p>The message.</p>
15d6dfaf 1090</div>
2447ee8c 1091<div class="tsd-comment tsd-typography"></div></li>
1092<li>
1093<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>
1094<div class="tsd-comment tsd-typography"><p>The optional array of transferable objects.</p>
1095</div>
15d6dfaf 1096<div class="tsd-comment tsd-typography"></div></li></ul></div>
1097<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1098<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1099<ul>
0e16e60a 1100<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L914">src/pools/abstract-pool.ts:914</a></li></ul></aside></li></ul></section>
3bd6a82e 1101<section class="tsd-panel tsd-member"><a id="setTasksQueueOptions" class="tsd-anchor"></a>
15d6dfaf 1102<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 1103<ul class="tsd-signatures">
15d6dfaf 1104<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 1105<li class="tsd-description">
1106<div class="tsd-comment tsd-typography"><p>Sets the worker tasks queue options in this pool.</p>
1107</div>
1108<div class="tsd-parameters">
1109<h4 class="tsd-parameters-title">Parameters</h4>
1110<ul class="tsd-parameter-list">
1111<li>
8d1797ad 1112<h5><span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5>
6047493a 1113<div class="tsd-comment tsd-typography"><p>The worker tasks queue options.</p>
15d6dfaf 1114</div>
1115<div class="tsd-comment tsd-typography"></div></li></ul></div>
1116<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1117<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 1118<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#setTasksQueueOptions">setTasksQueueOptions</a></p>
6047493a 1119<ul>
0e16e60a 1120<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L590">src/pools/abstract-pool.ts:590</a></li></ul></aside></li></ul></section>
3bd6a82e 1121<section class="tsd-panel tsd-member"><a id="setWorkerChoiceStrategy" class="tsd-anchor"></a>
15d6dfaf 1122<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 1123<ul class="tsd-signatures">
15d6dfaf 1124<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>
6c525543 1125<li class="tsd-description">
1126<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy in this pool.</p>
1127</div>
1128<div class="tsd-parameters">
1129<h4 class="tsd-parameters-title">Parameters</h4>
1130<ul class="tsd-parameter-list">
1131<li>
f05afd16 1132<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 1133<div class="tsd-comment tsd-typography"><p>The worker choice strategy.</p>
15d6dfaf 1134</div>
1135<div class="tsd-comment tsd-typography"></div></li>
a8aeac44 1136<li>
8d1797ad 1137<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 1138<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
15d6dfaf 1139</div>
1140<div class="tsd-comment tsd-typography"></div></li></ul></div>
1141<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1142<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 1143<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#setWorkerChoiceStrategy">setWorkerChoiceStrategy</a></p>
6c525543 1144<ul>
0e16e60a 1145<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L548">src/pools/abstract-pool.ts:548</a></li></ul></aside></li></ul></section>
3bd6a82e 1146<section class="tsd-panel tsd-member"><a id="setWorkerChoiceStrategyOptions" class="tsd-anchor"></a>
15d6dfaf 1147<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 1148<ul class="tsd-signatures">
15d6dfaf 1149<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 1150<li class="tsd-description">
1151<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy options in this pool.</p>
1152</div>
1153<div class="tsd-parameters">
1154<h4 class="tsd-parameters-title">Parameters</h4>
1155<ul class="tsd-parameter-list">
1156<li>
8d1797ad 1157<h5><span class="tsd-kind-parameter">workerChoiceStrategyOptions</span>: <a href="../interfaces/WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></h5>
6047493a 1158<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
15d6dfaf 1159</div>
1160<div class="tsd-comment tsd-typography"></div></li></ul></div>
1161<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1162<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 1163<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#setWorkerChoiceStrategyOptions">setWorkerChoiceStrategyOptions</a></p>
6047493a 1164<ul>
0e16e60a 1165<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L567">src/pools/abstract-pool.ts:567</a></li></ul></aside></li></ul></section>
3bd6a82e 1166<section class="tsd-panel tsd-member tsd-is-protected"><a id="setupHook" class="tsd-anchor"></a>
15d6dfaf 1167<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 1168<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 1169<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>
6c525543 1170<li class="tsd-description">
030eb5a3 1171<div class="tsd-comment tsd-typography"><p>Setup hook to execute code before worker nodes are created in the abstract constructor.
1172Can be overridden.</p>
6c525543 1173</div>
15d6dfaf 1174<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1175<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1176<ul>
0e16e60a 1177<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L755">src/pools/abstract-pool.ts:755</a></li></ul></aside></li></ul></section>
6be0ab6d 1178<section class="tsd-panel tsd-member tsd-is-private"><a id="shallCreateDynamicWorker" class="tsd-anchor"></a>
1179<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>shall<wbr/>Create<wbr/>Dynamic<wbr/>Worker</span><a href="#shallCreateDynamicWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1180<ul class="tsd-signatures tsd-is-private">
1181<li class="tsd-signature tsd-anchor-link" id="shallCreateDynamicWorker.shallCreateDynamicWorker-1"><span class="tsd-kind-call-signature">shall<wbr/>Create<wbr/>Dynamic<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#shallCreateDynamicWorker.shallCreateDynamicWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1182<li class="tsd-description">
1183<div class="tsd-comment tsd-typography"><p>Conditions for dynamic worker creation.</p>
1184</div>
1185<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether to create a dynamic worker or not.</p>
1186
1187<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1188<ul>
0e16e60a 1189<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L903">src/pools/abstract-pool.ts:903</a></li></ul></aside></li></ul></section>
177be4a6 1190<section class="tsd-panel tsd-member tsd-is-private"><a id="startPool" class="tsd-anchor"></a>
1191<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>start<wbr/>Pool</span><a href="#startPool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1192<ul class="tsd-signatures tsd-is-private">
1193<li class="tsd-signature tsd-anchor-link" id="startPool.startPool-1"><span class="tsd-kind-call-signature">start<wbr/>Pool</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="#startPool.startPool-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1194<li class="tsd-description">
1195<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1196<ul>
0e16e60a 1197<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L295">src/pools/abstract-pool.ts:295</a></li></ul></aside></li></ul></section>
3bd6a82e 1198<section class="tsd-panel tsd-member tsd-is-private"><a id="tasksQueueSize" class="tsd-anchor"></a>
15d6dfaf 1199<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>tasks<wbr/>Queue<wbr/>Size</span><a href="#tasksQueueSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 1200<ul class="tsd-signatures tsd-is-private">
15d6dfaf 1201<li class="tsd-signature tsd-anchor-link" id="tasksQueueSize.tasksQueueSize-1"><span class="tsd-kind-call-signature">tasks<wbr/>Queue<wbr/>Size</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#tasksQueueSize.tasksQueueSize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 1202<li class="tsd-description">
1203<div class="tsd-parameters">
1204<h4 class="tsd-parameters-title">Parameters</h4>
1205<ul class="tsd-parameter-list">
1206<li>
3bd6a82e 1207<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
6c525543 1208<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
1209<ul>
0e16e60a 1210<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1236">src/pools/abstract-pool.ts:1236</a></li></ul></aside></li></ul></section>
f05afd16 1211<section class="tsd-panel tsd-member tsd-is-private"><a id="updateEluWorkerUsage" class="tsd-anchor"></a>
1212<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>update<wbr/>Elu<wbr/>Worker<wbr/>Usage</span><a href="#updateEluWorkerUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
afa30fd0 1213<ul class="tsd-signatures tsd-is-private">
f05afd16 1214<li class="tsd-signature tsd-anchor-link" id="updateEluWorkerUsage.updateEluWorkerUsage-1"><span class="tsd-kind-call-signature">update<wbr/>Elu<wbr/>Worker<wbr/>Usage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerUsage</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="#updateEluWorkerUsage.updateEluWorkerUsage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
afa30fd0 1215<li class="tsd-description">
1216<div class="tsd-parameters">
1217<h4 class="tsd-parameters-title">Parameters</h4>
1218<ul class="tsd-parameter-list">
1219<li>
f05afd16 1220<h5><span class="tsd-kind-parameter">workerUsage</span>: <a href="../interfaces/WorkerUsage.html" class="tsd-signature-type tsd-kind-interface">WorkerUsage</a></h5></li>
afa30fd0 1221<li>
030eb5a3 1222<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>
afa30fd0 1223<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1224<ul>
0e16e60a 1225<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L847">src/pools/abstract-pool.ts:847</a></li></ul></aside></li></ul></section>
f05afd16 1226<section class="tsd-panel tsd-member tsd-is-private"><a id="updateRunTimeWorkerUsage" class="tsd-anchor"></a>
1227<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>update<wbr/>Run<wbr/>Time<wbr/>Worker<wbr/>Usage</span><a href="#updateRunTimeWorkerUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
811dc01f 1228<ul class="tsd-signatures tsd-is-private">
f05afd16 1229<li class="tsd-signature tsd-anchor-link" id="updateRunTimeWorkerUsage.updateRunTimeWorkerUsage-1"><span class="tsd-kind-call-signature">update<wbr/>Run<wbr/>Time<wbr/>Worker<wbr/>Usage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerUsage</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="#updateRunTimeWorkerUsage.updateRunTimeWorkerUsage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
811dc01f 1230<li class="tsd-description">
1231<div class="tsd-parameters">
1232<h4 class="tsd-parameters-title">Parameters</h4>
1233<ul class="tsd-parameter-list">
1234<li>
f05afd16 1235<h5><span class="tsd-kind-parameter">workerUsage</span>: <a href="../interfaces/WorkerUsage.html" class="tsd-signature-type tsd-kind-interface">WorkerUsage</a></h5></li>
811dc01f 1236<li>
030eb5a3 1237<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>
811dc01f 1238<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1239<ul>
0e16e60a 1240<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L821">src/pools/abstract-pool.ts:821</a></li></ul></aside></li></ul></section>
aac8863d 1241<section class="tsd-panel tsd-member tsd-is-private"><a id="updateTaskStatisticsWorkerUsage" class="tsd-anchor"></a>
1242<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>update<wbr/>Task<wbr/>Statistics<wbr/>Worker<wbr/>Usage</span><a href="#updateTaskStatisticsWorkerUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1243<ul class="tsd-signatures tsd-is-private">
1244<li class="tsd-signature tsd-anchor-link" id="updateTaskStatisticsWorkerUsage.updateTaskStatisticsWorkerUsage-1"><span class="tsd-kind-call-signature">update<wbr/>Task<wbr/>Statistics<wbr/>Worker<wbr/>Usage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerUsage</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="#updateTaskStatisticsWorkerUsage.updateTaskStatisticsWorkerUsage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1245<li class="tsd-description">
1246<div class="tsd-parameters">
1247<h4 class="tsd-parameters-title">Parameters</h4>
1248<ul class="tsd-parameter-list">
1249<li>
1250<h5><span class="tsd-kind-parameter">workerUsage</span>: <a href="../interfaces/WorkerUsage.html" class="tsd-signature-type tsd-kind-interface">WorkerUsage</a></h5></li>
1251<li>
030eb5a3 1252<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>
aac8863d 1253<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1254<ul>
0e16e60a 1255<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L808">src/pools/abstract-pool.ts:808</a></li></ul></aside></li></ul></section>
f05afd16 1256<section class="tsd-panel tsd-member tsd-is-private"><a id="updateWaitTimeWorkerUsage" class="tsd-anchor"></a>
1257<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>update<wbr/>Wait<wbr/>Time<wbr/>Worker<wbr/>Usage</span><a href="#updateWaitTimeWorkerUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
811dc01f 1258<ul class="tsd-signatures tsd-is-private">
f05afd16 1259<li class="tsd-signature tsd-anchor-link" id="updateWaitTimeWorkerUsage.updateWaitTimeWorkerUsage-1"><span class="tsd-kind-call-signature">update<wbr/>Wait<wbr/>Time<wbr/>Worker<wbr/>Usage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerUsage</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="#updateWaitTimeWorkerUsage.updateWaitTimeWorkerUsage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
811dc01f 1260<li class="tsd-description">
1261<div class="tsd-parameters">
1262<h4 class="tsd-parameters-title">Parameters</h4>
1263<ul class="tsd-parameter-list">
1264<li>
f05afd16 1265<h5><span class="tsd-kind-parameter">workerUsage</span>: <a href="../interfaces/WorkerUsage.html" class="tsd-signature-type tsd-kind-interface">WorkerUsage</a></h5></li>
811dc01f 1266<li>
f05afd16 1267<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></li></ul></div>
811dc01f 1268<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1269<ul>
0e16e60a 1270<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L833">src/pools/abstract-pool.ts:833</a></li></ul></aside></li></ul></section>
3bd6a82e 1271<section class="tsd-panel tsd-member tsd-is-protected"><a id="workerListener" class="tsd-anchor"></a>
15d6dfaf 1272<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 1273<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 1274<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>
6c525543 1275<li class="tsd-description">
f04db52f 1276<div class="tsd-comment tsd-typography"><p>This method is the listener registered for each worker message.</p>
6c525543 1277</div>
fab6d3b5 1278<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>
1279
6c525543 1280<ul class="tsd-parameters">
1281<li class="tsd-parameter-signature">
3bd6a82e 1282<ul class="tsd-signatures">
1283<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>
6c525543 1284<li class="tsd-description">
f04db52f 1285<div class="tsd-comment tsd-typography"><p>This method is the listener registered for each worker message.</p>
6c525543 1286</div>
1287<div class="tsd-parameters">
1288<h4 class="tsd-parameters-title">Parameters</h4>
1289<ul class="tsd-parameter-list">
1290<li>
030eb5a3 1291<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 1292<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 1293
1294<div class="tsd-comment tsd-typography"></div></li></ul></li></ul>
1295<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1296<ul>
0e16e60a 1297<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/pools/abstract-pool.ts#L1108">src/pools/abstract-pool.ts:1108</a></li></ul></aside></li></ul></section></section></div>
6c525543 1298<div class="col-sidebar">
1299<div class="page-menu">
1300<div class="tsd-navigation settings">
1301<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
15d6dfaf 1302<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>
6c525543 1303<div class="tsd-accordion-details">
1304<div class="tsd-filter-visibility">
1305<h4 class="uppercase">Member Visibility</h4><form>
1306<ul id="tsd-filter-options">
1307<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>
1308<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>
1309<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>
1310<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>
1311<div class="tsd-theme-toggle">
3bd6a82e 1312<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>
6c525543 1313<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 1314<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
6c525543 1315<div class="tsd-accordion-details">
1316<ul>
15d6dfaf 1317<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>
1318<li><a href="#emitter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>emitter</span></a></li>
1319<li><a href="#filePath" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>file<wbr/>Path</span></a></li>
1320<li><a href="#numberOfWorkers" class="tsd-is-protected"><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>
1321<li><a href="#opts" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>opts</span></a></li>
1322<li><a href="#promiseResponseMap" class="tsd-is-protected"><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>
202bcb6b 1323<li><a href="#startTimestamp" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>start<wbr/>Timestamp</span></a></li>
44b95861 1324<li><a href="#starting" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>starting</span></a></li>
013a4697 1325<li><a href="#taskFunctions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>task<wbr/>Functions</span></a></li>
15d6dfaf 1326<li><a href="#workerChoiceStrategyContext" class="tsd-is-protected"><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>
1327<li><a href="#workerNodes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Nodes</span></a></li>
1328<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>
1329<li><a href="#full" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>full</span></a></li>
1330<li><a href="#info" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>info</span></a></li>
1331<li><a href="#maxSize" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>max<wbr/>Size</span></a></li>
1332<li><a href="#minSize" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>min<wbr/>Size</span></a></li>
c914a50e 1333<li><a href="#ready" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>ready</span></a></li>
15d6dfaf 1334<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 1335<li><a href="#utilization" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>utilization</span></a></li>
15d6dfaf 1336<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>
7b88db4b 1337<li><a href="#addWorkerNode" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Worker<wbr/>Node</span></a></li>
15d6dfaf 1338<li><a href="#afterTaskExecutionHook" class="tsd-is-protected"><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 1339<li><a href="#afterWorkerNodeSetup" class="tsd-is-protected"><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 1340<li><a href="#beforeTaskExecutionHook" class="tsd-is-protected"><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>
1341<li><a href="#buildTasksQueueOptions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>build<wbr/>Tasks<wbr/>Queue<wbr/>Options</span></a></li>
1342<li><a href="#checkAndEmitEvents" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>And<wbr/>Emit<wbr/>Events</span></a></li>
c914a50e 1343<li><a href="#checkDynamicPoolSize" class="tsd-is-protected"><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>
15d6dfaf 1344<li><a href="#checkFilePath" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>File<wbr/>Path</span></a></li>
47c9cec4 1345<li><a href="#checkMessageWorkerId" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Message<wbr/>Worker<wbr/>Id</span></a></li>
15d6dfaf 1346<li><a href="#checkNumberOfWorkers" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Number<wbr/>Of<wbr/>Workers</span></a></li>
1347<li><a href="#checkPoolOptions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Pool<wbr/>Options</span></a></li>
1348<li><a href="#checkValidTasksQueueOptions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Valid<wbr/>Tasks<wbr/>Queue<wbr/>Options</span></a></li>
1349<li><a href="#checkValidWorkerChoiceStrategy" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Valid<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span></a></li>
1350<li><a href="#checkValidWorkerChoiceStrategyOptions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Valid<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a></li>
6be0ab6d 1351<li><a href="#chooseWorkerNode" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>choose<wbr/>Worker<wbr/>Node</span></a></li>
f04db52f 1352<li><a href="#createAndSetupDynamicWorkerNode" class="tsd-is-protected"><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>
1353<li><a href="#createAndSetupWorkerNode" class="tsd-is-protected"><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 1354<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>
1355<li><a href="#dequeueTask" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>dequeue<wbr/>Task</span></a></li>
1356<li><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a></li>
f04db52f 1357<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 1358<li><a href="#enableTasksQueue" class=""><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>
1359<li><a href="#enqueueTask" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enqueue<wbr/>Task</span></a></li>
1360<li><a href="#execute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>execute</span></a></li>
1361<li><a href="#executeTask" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>execute<wbr/>Task</span></a></li>
f04db52f 1362<li><a href="#flushTasksQueue" class="tsd-is-protected"><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>
15d6dfaf 1363<li><a href="#flushTasksQueues" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flush<wbr/>Tasks<wbr/>Queues</span></a></li>
f04db52f 1364<li><a href="#getWorkerInfo" class="tsd-is-protected"><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>
1365<li><a href="#getWorkerNodeKeyByWorker" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Worker<wbr/>Node<wbr/>Key<wbr/>By<wbr/>Worker</span></a></li>
1366<li><a href="#getWorkerNodeKeyByWorkerId" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Worker<wbr/>Node<wbr/>Key<wbr/>By<wbr/>Worker<wbr/>Id</span></a></li>
202bcb6b 1367<li><a href="#handleTaskExecutionResponse" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Task<wbr/>Execution<wbr/>Response</span></a></li>
79f98bd9 1368<li><a href="#handleWorkerReadyResponse" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Worker<wbr/>Ready<wbr/>Response</span></a></li>
15d6dfaf 1369<li><a href="#internalBusy" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>internal<wbr/>Busy</span></a></li>
1370<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 1371<li><a href="#listTaskFunctions" class=""><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>
912e1dfa 1372<li><a href="#redistributeQueuedTasks" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>redistribute<wbr/>Queued<wbr/>Tasks</span></a></li>
76b46937 1373<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>
15d6dfaf 1374<li><a href="#removeWorkerNode" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Worker<wbr/>Node</span></a></li>
013a4697 1375<li><a href="#sendKillMessageToWorker" class="tsd-is-protected"><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 1376<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>
013a4697 1377<li><a href="#sendStatisticsMessageToWorker" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Statistics<wbr/>Message<wbr/>To<wbr/>Worker</span></a></li>
15d6dfaf 1378<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>
1379<li><a href="#setTasksQueueOptions" class=""><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>
1380<li><a href="#setWorkerChoiceStrategy" class=""><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>
1381<li><a href="#setWorkerChoiceStrategyOptions" class=""><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>
15d6dfaf 1382<li><a href="#setupHook" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>setup<wbr/>Hook</span></a></li>
6be0ab6d 1383<li><a href="#shallCreateDynamicWorker" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>shall<wbr/>Create<wbr/>Dynamic<wbr/>Worker</span></a></li>
177be4a6 1384<li><a href="#startPool" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>start<wbr/>Pool</span></a></li>
15d6dfaf 1385<li><a href="#tasksQueueSize" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>tasks<wbr/>Queue<wbr/>Size</span></a></li>
f05afd16 1386<li><a href="#updateEluWorkerUsage" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Elu<wbr/>Worker<wbr/>Usage</span></a></li>
1387<li><a href="#updateRunTimeWorkerUsage" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Run<wbr/>Time<wbr/>Worker<wbr/>Usage</span></a></li>
aac8863d 1388<li><a href="#updateTaskStatisticsWorkerUsage" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Task<wbr/>Statistics<wbr/>Worker<wbr/>Usage</span></a></li>
f05afd16 1389<li><a href="#updateWaitTimeWorkerUsage" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Wait<wbr/>Time<wbr/>Worker<wbr/>Usage</span></a></li>
15d6dfaf 1390<li><a href="#workerListener" class="tsd-is-protected"><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>
6c525543 1391<div class="site-menu">
013a4697 1392<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.26</span></a>
6c525543 1393<ul class="tsd-small-nested-navigation">
15d6dfaf 1394<li><a href="AbstractPool.html" class="current"><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>
1395<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>
1396<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>
1397<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>
1398<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>
1399<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>
1400<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>
1401<li><a href="FixedThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Fixed<wbr/>Thread<wbr/>Pool</span></a></li>
1402<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>
1403<li><a href="Queue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Queue</span></a></li>
1404<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>
1405<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>
1406<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 1407<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 1408<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>
1409<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>
1410<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 1411<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 1412<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>
1413<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>
1414<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 1415<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>
1416<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>
1417<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>
1418<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 1419<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 1420<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 1421<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 1422<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 1423<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 1424<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 1425<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 1426<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 1427<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 1428<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 1429<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 1430<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 1431<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 1432<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 1433<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>
1434<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 1435<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 1436<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 1437<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>
1438<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>
1439<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>
1440<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 1441<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>
1442<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 1443<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 1444<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 1445<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 1446<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>
1447<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 1448<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 1449<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>
1450<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>
1451<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 1452<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>
1453<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>
6c525543 1454<div class="tsd-generator">
1455<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
1456<div class="overlay"></div></body></html>