refactor: use object destructuration at handling task execution response
[poolifier.git] / docs / classes / AbstractPool.html
CommitLineData
fb8fbcfd 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.28</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>
fb8fbcfd 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.6.28</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>
fb8fbcfd 52<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/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>
fb8fbcfd 183<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/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>
85c03385 192<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 193<li><code>&#39;busy&#39;</code>: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.</li>
a13e50c3 194<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>
195<li>&#39;<code>destroy</code>&#39;: Emitted when the pool is destroyed.</li>
ccb7d1a7 196<li><code>&#39;error&#39;</code>: Emitted when an uncaught error occurs.</li>
197<li><code>&#39;taskError&#39;</code>: Emitted when an error occurs while executing a task.</li>
6c525543 198</ul>
15d6dfaf 199</div>
200<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 201<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#emitter">emitter</a></p>
202<ul>
fb8fbcfd 203<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L65">src/pools/abstract-pool.ts:65</a></li></ul></aside></section>
184d530f 204<section class="tsd-panel tsd-member tsd-is-protected"><a id="filePath" class="tsd-anchor"></a>
15d6dfaf 205<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 206<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 207<div class="tsd-comment tsd-typography"><p>Path to the worker file.</p>
15d6dfaf 208</div>
209<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 210<ul>
fb8fbcfd 211<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L109">src/pools/abstract-pool.ts:109</a></li></ul></aside></section>
184d530f 212<section class="tsd-panel tsd-member tsd-is-protected"><a id="numberOfWorkers" class="tsd-anchor"></a>
15d6dfaf 213<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 214<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 215<div class="tsd-comment tsd-typography"><p>Number of workers that this pool should manage.</p>
15d6dfaf 216</div>
217<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 218<ul>
fb8fbcfd 219<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L108">src/pools/abstract-pool.ts:108</a></li></ul></aside></section>
184d530f 220<section class="tsd-panel tsd-member tsd-is-protected"><a id="opts" class="tsd-anchor"></a>
15d6dfaf 221<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 222<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 223<div class="tsd-comment tsd-typography"><p>Options for the pool.</p>
15d6dfaf 224</div>
225<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 226<ul>
fb8fbcfd 227<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L110">src/pools/abstract-pool.ts:110</a></li></ul></aside></section>
3bd6a82e 228<section class="tsd-panel tsd-member tsd-is-protected"><a id="promiseResponseMap" class="tsd-anchor"></a>
15d6dfaf 229<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 230<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>
231<div class="tsd-comment tsd-typography"><p>The task execution response promise map.</p>
6c525543 232<ul>
233<li><code>key</code>: The message id of each submitted task.</li>
234<li><code>value</code>: An object that contains the worker, the execution response promise resolve and reject callbacks.</li>
235</ul>
236<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 237</div>
238<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 239<ul>
fb8fbcfd 240<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L75">src/pools/abstract-pool.ts:75</a></li></ul></aside></section>
202bcb6b 241<section class="tsd-panel tsd-member tsd-is-private"><a id="startTimestamp" class="tsd-anchor"></a>
242<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>
243<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>
244<div class="tsd-comment tsd-typography"><p>The start timestamp of the pool.</p>
245</div>
246<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
247<ul>
fb8fbcfd 248<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L94">src/pools/abstract-pool.ts:94</a></li></ul></aside></section>
44b95861 249<section class="tsd-panel tsd-member tsd-is-private"><a id="starting" class="tsd-anchor"></a>
250<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>
251<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>
252<div class="tsd-comment tsd-typography"><p>Whether the pool is starting or not.</p>
253</div>
254<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
255<ul>
fb8fbcfd 256<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L90">src/pools/abstract-pool.ts:90</a></li></ul></aside></section>
013a4697 257<section class="tsd-panel tsd-member tsd-is-private"><a id="taskFunctions" class="tsd-anchor"></a>
258<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>
259<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>
260<div class="tsd-comment tsd-typography"><p>The task function names.</p>
261</div>
262<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
263<ul>
fb8fbcfd 264<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L98">src/pools/abstract-pool.ts:98</a></li></ul></aside></section>
3bd6a82e 265<section class="tsd-panel tsd-member tsd-is-protected"><a id="workerChoiceStrategyContext" class="tsd-anchor"></a>
15d6dfaf 266<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 267<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 268<div class="tsd-comment tsd-typography"><p>Worker choice strategy context referencing a worker choice algorithm implementation.</p>
15d6dfaf 269</div>
270<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 271<ul>
fb8fbcfd 272<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L81">src/pools/abstract-pool.ts:81</a></li></ul></aside></section>
3bd6a82e 273<section class="tsd-panel tsd-member"><a id="workerNodes" class="tsd-anchor"></a>
15d6dfaf 274<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 275<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 276<div class="tsd-comment tsd-typography"><p>Pool worker nodes.</p>
15d6dfaf 277</div>
278<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 279<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#workerNodes">workerNodes</a></p>
280<ul>
fb8fbcfd 281<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L62">src/pools/abstract-pool.ts:62</a></li></ul></aside></section></section>
6c525543 282<section class="tsd-panel-group tsd-member-group">
283<h2>Accessors</h2>
3bd6a82e 284<section class="tsd-panel tsd-member tsd-is-protected"><a id="busy" class="tsd-anchor"></a>
15d6dfaf 285<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 286<ul class="tsd-signatures tsd-is-protected">
6c525543 287<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>
288<li class="tsd-description">
289<div class="tsd-comment tsd-typography"><p>Whether the pool is busy or not.</p>
290<p>The pool busyness boolean status.</p>
291</div>
15d6dfaf 292<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
293<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 294<ul>
fb8fbcfd 295<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L624">src/pools/abstract-pool.ts:624</a></li></ul></aside></li></ul></section>
3bd6a82e 296<section class="tsd-panel tsd-member tsd-is-protected"><a id="full" class="tsd-anchor"></a>
15d6dfaf 297<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 298<ul class="tsd-signatures tsd-is-protected">
6c525543 299<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>
300<li class="tsd-description">
301<div class="tsd-comment tsd-typography"><p>Whether the pool is full or not.</p>
302<p>The pool filling boolean status.</p>
303</div>
15d6dfaf 304<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
305<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 306<ul>
fb8fbcfd 307<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L615">src/pools/abstract-pool.ts:615</a></li></ul></aside></li></ul></section>
a2742ce7 308<section class="tsd-panel tsd-member"><a id="info" class="tsd-anchor"></a>
15d6dfaf 309<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 310<ul class="tsd-signatures">
311<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 312<li class="tsd-description">
a2742ce7 313<div class="tsd-comment tsd-typography"><p>Pool information.</p>
6c525543 314</div>
15d6dfaf 315<h4 class="tsd-returns-title">Returns <a href="../interfaces/PoolInfo.html" class="tsd-signature-type tsd-kind-interface">PoolInfo</a></h4>
316<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a2742ce7 317<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#info">info</a></p>
6c525543 318<ul>
fb8fbcfd 319<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L308">src/pools/abstract-pool.ts:308</a></li></ul></aside></li></ul></section>
a2742ce7 320<section class="tsd-panel tsd-member tsd-is-protected"><a id="maxSize" class="tsd-anchor"></a>
15d6dfaf 321<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 322<ul class="tsd-signatures tsd-is-protected">
323<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 324<li class="tsd-description">
f04db52f 325<div class="tsd-comment tsd-typography"><p>The pool maximum size.</p>
6c525543 326</div>
15d6dfaf 327<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
328<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 329<ul>
fb8fbcfd 330<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L504">src/pools/abstract-pool.ts:504</a></li></ul></aside></li></ul></section>
a2742ce7 331<section class="tsd-panel tsd-member tsd-is-protected"><a id="minSize" class="tsd-anchor"></a>
15d6dfaf 332<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 333<ul class="tsd-signatures tsd-is-protected">
334<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 335<li class="tsd-description">
f04db52f 336<div class="tsd-comment tsd-typography"><p>The pool minimum size.</p>
2c94c3a5 337</div>
15d6dfaf 338<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
339<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
2c94c3a5 340<ul>
fb8fbcfd 341<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L499">src/pools/abstract-pool.ts:499</a></li></ul></aside></li></ul></section>
c914a50e 342<section class="tsd-panel tsd-member tsd-is-private"><a id="ready" class="tsd-anchor"></a>
343<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>
344<ul class="tsd-signatures tsd-is-private">
345<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>
346<li class="tsd-description">
f04db52f 347<div class="tsd-comment tsd-typography"><p>The pool readiness boolean status.</p>
348</div>
349<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
350<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
c914a50e 351<ul>
fb8fbcfd 352<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L451">src/pools/abstract-pool.ts:451</a></li></ul></aside></li></ul></section>
184d530f 353<section class="tsd-panel tsd-member tsd-is-protected"><a id="type" class="tsd-anchor"></a>
15d6dfaf 354<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 355<ul class="tsd-signatures tsd-is-protected">
a2742ce7 356<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 357<li class="tsd-description">
f04db52f 358<div class="tsd-comment tsd-typography"><p>The pool type.</p>
6c525543 359<p>If it is <code>&#39;dynamic&#39;</code>, it provides the <code>max</code> property.</p>
360</div>
15d6dfaf 361<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>
362<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 363<ul>
fb8fbcfd 364<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L489">src/pools/abstract-pool.ts:489</a></li></ul></aside></li></ul></section>
202bcb6b 365<section class="tsd-panel tsd-member tsd-is-private"><a id="utilization" class="tsd-anchor"></a>
366<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>
367<ul class="tsd-signatures tsd-is-private">
368<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>
369<li class="tsd-description">
f04db52f 370<div class="tsd-comment tsd-typography"><p>The approximate pool utilization.</p>
202bcb6b 371</div>
372<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The pool utilization.</p>
373
374<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
375<ul>
fb8fbcfd 376<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L468">src/pools/abstract-pool.ts:468</a></li></ul></aside></li></ul></section>
184d530f 377<section class="tsd-panel tsd-member tsd-is-protected"><a id="worker" class="tsd-anchor"></a>
15d6dfaf 378<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 379<ul class="tsd-signatures tsd-is-protected">
3c7c9bd1 380<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 381<li class="tsd-description">
f04db52f 382<div class="tsd-comment tsd-typography"><p>The worker type.</p>
184d530f 383</div>
3c7c9bd1 384<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 385<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
184d530f 386<ul>
fb8fbcfd 387<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L494">src/pools/abstract-pool.ts:494</a></li></ul></aside></li></ul></section></section>
6c525543 388<section class="tsd-panel-group tsd-member-group">
389<h2>Methods</h2>
7b88db4b 390<section class="tsd-panel tsd-member tsd-is-private"><a id="addWorkerNode" class="tsd-anchor"></a>
391<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>
392<ul class="tsd-signatures tsd-is-private">
393<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>
394<li class="tsd-description">
395<div class="tsd-comment tsd-typography"><p>Adds the given worker in the pool worker nodes.</p>
396</div>
397<div class="tsd-parameters">
398<h4 class="tsd-parameters-title">Parameters</h4>
399<ul class="tsd-parameter-list">
400<li>
401<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></h5>
402<div class="tsd-comment tsd-typography"><p>The worker.</p>
403</div>
404<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 405<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The added worker node key.</p>
7b88db4b 406
f04db52f 407<div class="tsd-comment tsd-typography">
408<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>
409</div><aside class="tsd-sources">
7b88db4b 410<ul>
fb8fbcfd 411<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1196">src/pools/abstract-pool.ts:1196</a></li></ul></aside></li></ul></section>
3bd6a82e 412<section class="tsd-panel tsd-member tsd-is-protected"><a id="afterTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 413<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 414<ul class="tsd-signatures tsd-is-protected">
f04db52f 415<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 416<li class="tsd-description">
417<div class="tsd-comment tsd-typography"><p>Hook executed after the worker task execution.
418Can be overridden.</p>
419</div>
420<div class="tsd-parameters">
421<h4 class="tsd-parameters-title">Parameters</h4>
422<ul class="tsd-parameter-list">
423<li>
f04db52f 424<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
425<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 426</div>
427<div class="tsd-comment tsd-typography"></div></li>
6c525543 428<li>
030eb5a3 429<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 430<div class="tsd-comment tsd-typography"><p>The received message.</p>
15d6dfaf 431</div>
432<div class="tsd-comment tsd-typography"></div></li></ul></div>
433<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
434<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 435<ul>
fb8fbcfd 436<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L795">src/pools/abstract-pool.ts:795</a></li></ul></aside></li></ul></section>
f04db52f 437<section class="tsd-panel tsd-member tsd-is-protected"><a id="afterWorkerNodeSetup" class="tsd-anchor"></a>
438<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 439<ul class="tsd-signatures tsd-is-protected">
f04db52f 440<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 441<li class="tsd-description">
f04db52f 442<div class="tsd-comment tsd-typography"><p>Method hooked up after a worker node has been newly created.
030eb5a3 443Can be overridden.</p>
6c525543 444</div>
445<div class="tsd-parameters">
446<h4 class="tsd-parameters-title">Parameters</h4>
447<ul class="tsd-parameter-list">
448<li>
f04db52f 449<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
450<div class="tsd-comment tsd-typography"><p>The newly created worker node key.</p>
15d6dfaf 451</div>
452<div class="tsd-comment tsd-typography"></div></li></ul></div>
453<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
454<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 455<ul>
fb8fbcfd 456<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1028">src/pools/abstract-pool.ts:1028</a></li></ul></aside></li></ul></section>
3bd6a82e 457<section class="tsd-panel tsd-member tsd-is-protected"><a id="beforeTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 458<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 459<ul class="tsd-signatures tsd-is-protected">
f05afd16 460<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 461<li class="tsd-description">
462<div class="tsd-comment tsd-typography"><p>Hook executed before the worker task execution.
463Can be overridden.</p>
464</div>
465<div class="tsd-parameters">
466<h4 class="tsd-parameters-title">Parameters</h4>
467<ul class="tsd-parameter-list">
468<li>
3bd6a82e 469<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
6c525543 470<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 471</div>
f05afd16 472<div class="tsd-comment tsd-typography"></div></li>
473<li>
474<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>
475<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
476</div>
15d6dfaf 477<div class="tsd-comment tsd-typography"></div></li></ul></div>
478<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
479<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 480<ul>
fb8fbcfd 481<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L774">src/pools/abstract-pool.ts:774</a></li></ul></aside></li></ul></section>
3bd6a82e 482<section class="tsd-panel tsd-member tsd-is-private"><a id="buildTasksQueueOptions" class="tsd-anchor"></a>
15d6dfaf 483<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 484<ul class="tsd-signatures tsd-is-private">
15d6dfaf 485<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 486<li class="tsd-description">
487<div class="tsd-parameters">
488<h4 class="tsd-parameters-title">Parameters</h4>
489<ul class="tsd-parameter-list">
490<li>
8d1797ad 491<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>
492<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 493<ul>
fb8fbcfd 494<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L602">src/pools/abstract-pool.ts:602</a></li></ul></aside></li></ul></section>
3bd6a82e 495<section class="tsd-panel tsd-member tsd-is-private"><a id="checkAndEmitEvents" class="tsd-anchor"></a>
15d6dfaf 496<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 497<ul class="tsd-signatures tsd-is-private">
15d6dfaf 498<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 499<li class="tsd-description">
500<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
501<ul>
fb8fbcfd 502<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1168">src/pools/abstract-pool.ts:1168</a></li></ul></aside></li></ul></section>
c914a50e 503<section class="tsd-panel tsd-member tsd-is-protected"><a id="checkDynamicPoolSize" class="tsd-anchor"></a>
504<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>
505<ul class="tsd-signatures tsd-is-protected">
506<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>
507<li class="tsd-description">
508<div class="tsd-parameters">
509<h4 class="tsd-parameters-title">Parameters</h4>
510<ul class="tsd-parameter-list">
511<li>
512<h5><span class="tsd-kind-parameter">min</span>: <span class="tsd-signature-type">number</span></h5></li>
513<li>
514<h5><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
515<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
516<ul>
fb8fbcfd 517<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L180">src/pools/abstract-pool.ts:180</a></li></ul></aside></li></ul></section>
3bd6a82e 518<section class="tsd-panel tsd-member tsd-is-private"><a id="checkFilePath" class="tsd-anchor"></a>
15d6dfaf 519<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 520<ul class="tsd-signatures tsd-is-private">
15d6dfaf 521<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 522<li class="tsd-description">
523<div class="tsd-parameters">
524<h4 class="tsd-parameters-title">Parameters</h4>
525<ul class="tsd-parameter-list">
526<li>
3bd6a82e 527<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
6c525543 528<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
529<ul>
fb8fbcfd 530<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L149">src/pools/abstract-pool.ts:149</a></li></ul></aside></li></ul></section>
47c9cec4 531<section class="tsd-panel tsd-member tsd-is-private"><a id="checkMessageWorkerId" class="tsd-anchor"></a>
532<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>
533<ul class="tsd-signatures tsd-is-private">
534<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>
535<li class="tsd-description">
7b88db4b 536<div class="tsd-comment tsd-typography"><p>Checks if the worker id sent in the received message from a worker is valid.</p>
537</div>
47c9cec4 538<div class="tsd-parameters">
539<h4 class="tsd-parameters-title">Parameters</h4>
540<ul class="tsd-parameter-list">
541<li>
7b88db4b 542<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>
543<div class="tsd-comment tsd-typography"><p>The received message.</p>
544</div>
545<div class="tsd-comment tsd-typography"></div></li></ul></div>
546<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
547<div class="tsd-comment tsd-typography">
548<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>
549</div><aside class="tsd-sources">
47c9cec4 550<ul>
fb8fbcfd 551<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L512">src/pools/abstract-pool.ts:512</a></li></ul></aside></li></ul></section>
3bd6a82e 552<section class="tsd-panel tsd-member tsd-is-private"><a id="checkNumberOfWorkers" class="tsd-anchor"></a>
15d6dfaf 553<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 554<ul class="tsd-signatures tsd-is-private">
15d6dfaf 555<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 556<li class="tsd-description">
557<div class="tsd-parameters">
558<h4 class="tsd-parameters-title">Parameters</h4>
559<ul class="tsd-parameter-list">
560<li>
3bd6a82e 561<h5><span class="tsd-kind-parameter">numberOfWorkers</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
6c525543 562<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
563<ul>
fb8fbcfd 564<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L162">src/pools/abstract-pool.ts:162</a></li></ul></aside></li></ul></section>
3bd6a82e 565<section class="tsd-panel tsd-member tsd-is-private"><a id="checkPoolOptions" class="tsd-anchor"></a>
15d6dfaf 566<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 567<ul class="tsd-signatures tsd-is-private">
15d6dfaf 568<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 569<li class="tsd-description">
570<div class="tsd-parameters">
571<h4 class="tsd-parameters-title">Parameters</h4>
572<ul class="tsd-parameter-list">
573<li>
8d1797ad 574<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 575<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
576<ul>
fb8fbcfd 577<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L206">src/pools/abstract-pool.ts:206</a></li></ul></aside></li></ul></section>
3bd6a82e 578<section class="tsd-panel tsd-member tsd-is-private"><a id="checkValidTasksQueueOptions" class="tsd-anchor"></a>
15d6dfaf 579<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 580<ul class="tsd-signatures tsd-is-private">
15d6dfaf 581<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 582<li class="tsd-description">
583<div class="tsd-parameters">
584<h4 class="tsd-parameters-title">Parameters</h4>
585<ul class="tsd-parameter-list">
586<li>
8d1797ad 587<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 588<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
589<ul>
fb8fbcfd 590<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L271">src/pools/abstract-pool.ts:271</a></li></ul></aside></li></ul></section>
3bd6a82e 591<section class="tsd-panel tsd-member tsd-is-private"><a id="checkValidWorkerChoiceStrategy" class="tsd-anchor"></a>
15d6dfaf 592<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 593<ul class="tsd-signatures tsd-is-private">
15d6dfaf 594<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 595<li class="tsd-description">
596<div class="tsd-parameters">
597<h4 class="tsd-parameters-title">Parameters</h4>
598<ul class="tsd-parameter-list">
599<li>
f05afd16 600<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 601<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
602<ul>
fb8fbcfd 603<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L233">src/pools/abstract-pool.ts:233</a></li></ul></aside></li></ul></section>
2c94c3a5 604<section class="tsd-panel tsd-member tsd-is-private"><a id="checkValidWorkerChoiceStrategyOptions" class="tsd-anchor"></a>
15d6dfaf 605<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 606<ul class="tsd-signatures tsd-is-private">
15d6dfaf 607<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 608<li class="tsd-description">
609<div class="tsd-parameters">
610<h4 class="tsd-parameters-title">Parameters</h4>
611<ul class="tsd-parameter-list">
612<li>
613<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>
614<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
615<ul>
fb8fbcfd 616<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L243">src/pools/abstract-pool.ts:243</a></li></ul></aside></li></ul></section>
6be0ab6d 617<section class="tsd-panel tsd-member tsd-is-private"><a id="chooseWorkerNode" class="tsd-anchor"></a>
618<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>
619<ul class="tsd-signatures tsd-is-private">
15d6dfaf 620<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 621<li class="tsd-description">
622<div class="tsd-comment tsd-typography"><p>Chooses a worker node for the next task.</p>
6be0ab6d 623<p>The default worker choice strategy uses a round robin algorithm to distribute the tasks.</p>
6c525543 624</div>
f04db52f 625<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The chosen worker node key</p>
15d6dfaf 626
627<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 628<ul>
fb8fbcfd 629<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L889">src/pools/abstract-pool.ts:889</a></li></ul></aside></li></ul></section>
f04db52f 630<section class="tsd-panel tsd-member tsd-is-protected"><a id="createAndSetupDynamicWorkerNode" class="tsd-anchor"></a>
631<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 632<ul class="tsd-signatures tsd-is-protected">
f04db52f 633<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 634<li class="tsd-description">
f04db52f 635<div class="tsd-comment tsd-typography"><p>Creates a new, completely set up dynamic worker node.</p>
6be0ab6d 636</div>
f04db52f 637<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 638
639<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
640<ul>
fb8fbcfd 641<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L975">src/pools/abstract-pool.ts:975</a></li></ul></aside></li></ul></section>
f04db52f 642<section class="tsd-panel tsd-member tsd-is-protected"><a id="createAndSetupWorkerNode" class="tsd-anchor"></a>
643<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 644<ul class="tsd-signatures tsd-is-protected">
f04db52f 645<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 646<li class="tsd-description">
f04db52f 647<div class="tsd-comment tsd-typography"><p>Creates a new, completely set up worker node.</p>
6c525543 648</div>
f04db52f 649<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>New, completely set up worker node key.</p>
15d6dfaf 650
651<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 652<ul>
fb8fbcfd 653<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L935">src/pools/abstract-pool.ts:935</a></li></ul></aside></li></ul></section>
3bd6a82e 654<section class="tsd-panel tsd-member tsd-is-protected"><a id="createWorker" class="tsd-anchor"></a>
15d6dfaf 655<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 656<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 657<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 658<li class="tsd-description">
6be0ab6d 659<div class="tsd-comment tsd-typography"><p>Creates a new worker.</p>
6c525543 660</div>
6be0ab6d 661<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></h4><p>Newly created worker.</p>
662
15d6dfaf 663<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 664<ul>
fb8fbcfd 665<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L928">src/pools/abstract-pool.ts:928</a></li></ul></aside></li></ul></section>
3bd6a82e 666<section class="tsd-panel tsd-member tsd-is-private"><a id="dequeueTask" class="tsd-anchor"></a>
15d6dfaf 667<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 668<ul class="tsd-signatures tsd-is-private">
15d6dfaf 669<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 670<li class="tsd-description">
671<div class="tsd-parameters">
672<h4 class="tsd-parameters-title">Parameters</h4>
673<ul class="tsd-parameter-list">
674<li>
3bd6a82e 675<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
8d1797ad 676<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 677<ul>
fb8fbcfd 678<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1238">src/pools/abstract-pool.ts:1238</a></li></ul></aside></li></ul></section>
3bd6a82e 679<section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a>
15d6dfaf 680<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 681<ul class="tsd-signatures">
15d6dfaf 682<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 683<li class="tsd-description">
f04db52f 684<div class="tsd-comment tsd-typography"><p>Terminates all workers in this pool.</p>
6c525543 685</div>
15d6dfaf 686<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>
687<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 688<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#destroy">destroy</a></p>
6c525543 689<ul>
fb8fbcfd 690<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L720">src/pools/abstract-pool.ts:720</a></li></ul></aside></li></ul></section>
f04db52f 691<section class="tsd-panel tsd-member tsd-is-protected"><a id="destroyWorkerNode" class="tsd-anchor"></a>
692<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 693<ul class="tsd-signatures tsd-is-protected">
f04db52f 694<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 695<li class="tsd-description">
f04db52f 696<div class="tsd-comment tsd-typography"><p>Terminates the worker node given its worker node key.</p>
6c525543 697</div>
698<div class="tsd-parameters">
699<h4 class="tsd-parameters-title">Parameters</h4>
700<ul class="tsd-parameter-list">
701<li>
f04db52f 702<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
703<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 704</div>
705<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 706<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 707<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 708<ul>
fb8fbcfd 709<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L750">src/pools/abstract-pool.ts:750</a></li></ul></aside></li></ul></section>
3bd6a82e 710<section class="tsd-panel tsd-member"><a id="enableTasksQueue" class="tsd-anchor"></a>
15d6dfaf 711<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 712<ul class="tsd-signatures">
15d6dfaf 713<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 714<li class="tsd-description">
715<div class="tsd-comment tsd-typography"><p>Enables/disables the worker tasks queue in this pool.</p>
716</div>
717<div class="tsd-parameters">
718<h4 class="tsd-parameters-title">Parameters</h4>
719<ul class="tsd-parameter-list">
720<li>
3bd6a82e 721<h5><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></h5>
6047493a 722<div class="tsd-comment tsd-typography"><p>Whether to enable or disable the worker tasks queue.</p>
15d6dfaf 723</div>
724<div class="tsd-comment tsd-typography"></div></li>
6047493a 725<li>
8d1797ad 726<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 727<div class="tsd-comment tsd-typography"><p>The worker tasks queue options.</p>
15d6dfaf 728</div>
729<div class="tsd-comment tsd-typography"></div></li></ul></div>
730<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
731<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 732<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#enableTasksQueue">enableTasksQueue</a></p>
6047493a 733<ul>
fb8fbcfd 734<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L580">src/pools/abstract-pool.ts:580</a></li></ul></aside></li></ul></section>
3bd6a82e 735<section class="tsd-panel tsd-member tsd-is-private"><a id="enqueueTask" class="tsd-anchor"></a>
15d6dfaf 736<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 737<ul class="tsd-signatures tsd-is-private">
15d6dfaf 738<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 739<li class="tsd-description">
740<div class="tsd-parameters">
741<h4 class="tsd-parameters-title">Parameters</h4>
742<ul class="tsd-parameter-list">
743<li>
3bd6a82e 744<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li>
6c525543 745<li>
8d1797ad 746<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 747<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
748<ul>
fb8fbcfd 749<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1234">src/pools/abstract-pool.ts:1234</a></li></ul></aside></li></ul></section>
3bd6a82e 750<section class="tsd-panel tsd-member"><a id="execute" class="tsd-anchor"></a>
15d6dfaf 751<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 752<ul class="tsd-signatures">
2447ee8c 753<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 754<li class="tsd-description">
1bb559f9 755<div class="tsd-comment tsd-typography"><p>Executes the specified function in the worker constructor with the task data input parameter.</p>
6c525543 756</div>
757<div class="tsd-parameters">
758<h4 class="tsd-parameters-title">Parameters</h4>
759<ul class="tsd-parameter-list">
760<li>
3bd6a82e 761<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 762<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 763</div>
764<div class="tsd-comment tsd-typography"></div></li>
2c94c3a5 765<li>
766<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 767<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>
768</div>
769<div class="tsd-comment tsd-typography"></div></li>
770<li>
771<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>
772<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 773</div>
774<div class="tsd-comment tsd-typography"></div></li></ul></div>
fab6d3b5 775<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 776
777<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 778<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#execute">execute</a></p>
6c525543 779<ul>
fb8fbcfd 780<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L661">src/pools/abstract-pool.ts:661</a></li></ul></aside></li></ul></section>
3bd6a82e 781<section class="tsd-panel tsd-member tsd-is-private"><a id="executeTask" class="tsd-anchor"></a>
15d6dfaf 782<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 783<ul class="tsd-signatures tsd-is-private">
15d6dfaf 784<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 785<li class="tsd-description">
f04db52f 786<div class="tsd-comment tsd-typography"><p>Executes the given task on the worker given its worker node key.</p>
7b88db4b 787</div>
6c525543 788<div class="tsd-parameters">
789<h4 class="tsd-parameters-title">Parameters</h4>
790<ul class="tsd-parameter-list">
791<li>
f04db52f 792<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
793<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
794</div>
795<div class="tsd-comment tsd-typography"></div></li>
6c525543 796<li>
7b88db4b 797<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>
798<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
799</div>
800<div class="tsd-comment tsd-typography"></div></li></ul></div>
801<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
802<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 803<ul>
fb8fbcfd 804<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1229">src/pools/abstract-pool.ts:1229</a></li></ul></aside></li></ul></section>
f04db52f 805<section class="tsd-panel tsd-member tsd-is-protected"><a id="flushTasksQueue" class="tsd-anchor"></a>
806<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>
807<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 808<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 809<li class="tsd-description">
810<div class="tsd-parameters">
811<h4 class="tsd-parameters-title">Parameters</h4>
812<ul class="tsd-parameter-list">
813<li>
3bd6a82e 814<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
6c525543 815<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
816<ul>
fb8fbcfd 817<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1246">src/pools/abstract-pool.ts:1246</a></li></ul></aside></li></ul></section>
3bd6a82e 818<section class="tsd-panel tsd-member tsd-is-private"><a id="flushTasksQueues" class="tsd-anchor"></a>
15d6dfaf 819<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 820<ul class="tsd-signatures tsd-is-private">
15d6dfaf 821<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 822<li class="tsd-description">
823<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
824<ul>
fb8fbcfd 825<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1256">src/pools/abstract-pool.ts:1256</a></li></ul></aside></li></ul></section>
f04db52f 826<section class="tsd-panel tsd-member tsd-is-protected"><a id="getWorkerInfo" class="tsd-anchor"></a>
827<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>
828<ul class="tsd-signatures tsd-is-protected">
912e1dfa 829<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>
830<li class="tsd-description">
f04db52f 831<div class="tsd-comment tsd-typography"><p>Gets the worker information given its worker node key.</p>
912e1dfa 832</div>
833<div class="tsd-parameters">
834<h4 class="tsd-parameters-title">Parameters</h4>
835<ul class="tsd-parameter-list">
836<li>
837<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
838<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
839</div>
840<div class="tsd-comment tsd-typography"></div></li></ul></div>
76b46937 841<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>
842
912e1dfa 843<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
844<ul>
fb8fbcfd 845<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1185">src/pools/abstract-pool.ts:1185</a></li></ul></aside></li></ul></section>
f04db52f 846<section class="tsd-panel tsd-member tsd-is-private"><a id="getWorkerNodeKeyByWorker" class="tsd-anchor"></a>
847<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>
848<ul class="tsd-signatures tsd-is-private">
849<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 850<li class="tsd-description">
f04db52f 851<div class="tsd-comment tsd-typography"><p>Gets the given worker its worker node key.</p>
76b46937 852</div>
853<div class="tsd-parameters">
854<h4 class="tsd-parameters-title">Parameters</h4>
855<ul class="tsd-parameter-list">
856<li>
857<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></h5>
858<div class="tsd-comment tsd-typography"><p>The worker.</p>
859</div>
860<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 861<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 862
f04db52f 863<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
76b46937 864<ul>
fb8fbcfd 865<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L531">src/pools/abstract-pool.ts:531</a></li></ul></aside></li></ul></section>
f04db52f 866<section class="tsd-panel tsd-member tsd-is-private"><a id="getWorkerNodeKeyByWorkerId" class="tsd-anchor"></a>
867<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>
868<ul class="tsd-signatures tsd-is-private">
869<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 870<li class="tsd-description">
f04db52f 871<div class="tsd-comment tsd-typography"><p>Gets the worker node key given its worker id.</p>
6c525543 872</div>
873<div class="tsd-parameters">
874<h4 class="tsd-parameters-title">Parameters</h4>
875<ul class="tsd-parameter-list">
876<li>
f04db52f 877<h5><span class="tsd-kind-parameter">workerId</span>: <span class="tsd-signature-type">number</span></h5>
878<div class="tsd-comment tsd-typography"><p>The worker id.</p>
15d6dfaf 879</div>
880<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 881<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 882
883<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 884<ul>
fb8fbcfd 885<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L543">src/pools/abstract-pool.ts:543</a></li></ul></aside></li></ul></section>
202bcb6b 886<section class="tsd-panel tsd-member tsd-is-private"><a id="handleTaskExecutionResponse" class="tsd-anchor"></a>
887<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>
888<ul class="tsd-signatures tsd-is-private">
889<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>
890<li class="tsd-description">
891<div class="tsd-parameters">
892<h4 class="tsd-parameters-title">Parameters</h4>
893<ul class="tsd-parameter-list">
894<li>
895<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>
896<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
897<ul>
fb8fbcfd 898<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1139">src/pools/abstract-pool.ts:1139</a></li></ul></aside></li></ul></section>
79f98bd9 899<section class="tsd-panel tsd-member tsd-is-private"><a id="handleWorkerReadyResponse" class="tsd-anchor"></a>
900<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 901<ul class="tsd-signatures tsd-is-private">
79f98bd9 902<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 903<li class="tsd-description">
904<div class="tsd-parameters">
905<h4 class="tsd-parameters-title">Parameters</h4>
906<ul class="tsd-parameter-list">
907<li>
908<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>
909<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
910<ul>
fb8fbcfd 911<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1127">src/pools/abstract-pool.ts:1127</a></li></ul></aside></li></ul></section>
3bd6a82e 912<section class="tsd-panel tsd-member tsd-is-protected"><a id="internalBusy" class="tsd-anchor"></a>
15d6dfaf 913<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 914<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 915<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 916<li class="tsd-description">
f4ff239c 917<div class="tsd-comment tsd-typography"><p>Whether worker nodes are executing concurrently their tasks quota or not.</p>
6be0ab6d 918</div>
919<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Worker nodes busyness boolean status.</p>
920
921<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 922<ul>
fb8fbcfd 923<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L631">src/pools/abstract-pool.ts:631</a></li></ul></aside></li></ul></section>
3bd6a82e 924<section class="tsd-panel tsd-member tsd-is-protected"><a id="isMain" class="tsd-anchor"></a>
15d6dfaf 925<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 926<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 927<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 928<li class="tsd-description">
929<div class="tsd-comment tsd-typography"><p>Should return whether the worker is the main worker or not.</p>
930</div>
15d6dfaf 931<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
932<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 933<ul>
fb8fbcfd 934<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L765">src/pools/abstract-pool.ts:765</a></li></ul></aside></li></ul></section>
013a4697 935<section class="tsd-panel tsd-member"><a id="listTaskFunctions" class="tsd-anchor"></a>
936<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>
937<ul class="tsd-signatures">
938<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>
939<li class="tsd-description">
940<div class="tsd-comment tsd-typography"><p>Lists the names of task function available in this pool.</p>
941</div>
942<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>
943
944<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
945<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#listTaskFunctions">listTaskFunctions</a></p>
946<ul>
fb8fbcfd 947<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L652">src/pools/abstract-pool.ts:652</a></li></ul></aside></li></ul></section>
912e1dfa 948<section class="tsd-panel tsd-member tsd-is-private"><a id="redistributeQueuedTasks" class="tsd-anchor"></a>
949<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>
950<ul class="tsd-signatures tsd-is-private">
7b88db4b 951<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 952<li class="tsd-description">
953<div class="tsd-parameters">
954<h4 class="tsd-parameters-title">Parameters</h4>
955<ul class="tsd-parameter-list">
956<li>
7b88db4b 957<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
912e1dfa 958<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
959<ul>
fb8fbcfd 960<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1062">src/pools/abstract-pool.ts:1062</a></li></ul></aside></li></ul></section>
76b46937 961<section class="tsd-panel tsd-member tsd-is-protected"><a id="registerWorkerMessageListener" class="tsd-anchor"></a>
962<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>
963<ul class="tsd-signatures tsd-is-protected">
f04db52f 964<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 965<li class="tsd-description">
f04db52f 966<div class="tsd-comment tsd-typography"><p>Registers a listener callback on the worker given its worker node key.</p>
6c525543 967</div>
fab6d3b5 968<section class="tsd-panel">
6c525543 969<h4>Type Parameters</h4>
fab6d3b5 970<ul class="tsd-type-parameter-list">
6c525543 971<li>
3bd6a82e 972<h4><span class="tsd-kind-type-parameter">Message</span></h4></li></ul></section>
6c525543 973<div class="tsd-parameters">
974<h4 class="tsd-parameters-title">Parameters</h4>
975<ul class="tsd-parameter-list">
976<li>
f04db52f 977<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
978<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 979</div>
980<div class="tsd-comment tsd-typography"></div></li>
6c525543 981<li>
3bd6a82e 982<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 983<div class="tsd-comment tsd-typography"><p>The message listener callback.</p>
984</div>
15d6dfaf 985<div class="tsd-comment tsd-typography"></div>
6c525543 986<ul class="tsd-parameters">
987<li class="tsd-parameter-signature">
3bd6a82e 988<ul class="tsd-signatures">
989<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 990<li class="tsd-description">
991<div class="tsd-parameters">
992<h4 class="tsd-parameters-title">Parameters</h4>
993<ul class="tsd-parameter-list">
994<li>
030eb5a3 995<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 996<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
15d6dfaf 997<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
998<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 999<ul>
fb8fbcfd 1000<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1015">src/pools/abstract-pool.ts:1015</a></li></ul></aside></li></ul></section>
3bd6a82e 1001<section class="tsd-panel tsd-member tsd-is-private"><a id="removeWorkerNode" class="tsd-anchor"></a>
15d6dfaf 1002<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 1003<ul class="tsd-signatures tsd-is-private">
15d6dfaf 1004<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 1005<li class="tsd-description">
1006<div class="tsd-comment tsd-typography"><p>Removes the given worker from the pool worker nodes.</p>
1007</div>
1008<div class="tsd-parameters">
1009<h4 class="tsd-parameters-title">Parameters</h4>
1010<ul class="tsd-parameter-list">
1011<li>
3bd6a82e 1012<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></h5>
6c525543 1013<div class="tsd-comment tsd-typography"><p>The worker.</p>
15d6dfaf 1014</div>
1015<div class="tsd-comment tsd-typography"></div></li></ul></div>
1016<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1017<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1018<ul>
fb8fbcfd 1019<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1215">src/pools/abstract-pool.ts:1215</a></li></ul></aside></li></ul></section>
013a4697 1020<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendKillMessageToWorker" class="tsd-anchor"></a>
1021<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>
1022<ul class="tsd-signatures tsd-is-protected">
1023<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>
1024<li class="tsd-description">
1025<div class="tsd-parameters">
1026<h4 class="tsd-parameters-title">Parameters</h4>
1027<ul class="tsd-parameter-list">
1028<li>
1029<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li>
1030<li>
1031<h5><span class="tsd-kind-parameter">workerId</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
1032<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">
1033<ul>
fb8fbcfd 1034<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L729">src/pools/abstract-pool.ts:729</a></li></ul></aside></li></ul></section>
76b46937 1035<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendStartupMessageToWorker" class="tsd-anchor"></a>
1036<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>
1037<ul class="tsd-signatures tsd-is-protected">
f04db52f 1038<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 1039<li class="tsd-description">
f04db52f 1040<div class="tsd-comment tsd-typography"><p>Sends the startup message to worker given its worker node key.</p>
76b46937 1041</div>
1042<div class="tsd-parameters">
1043<h4 class="tsd-parameters-title">Parameters</h4>
1044<ul class="tsd-parameter-list">
1045<li>
f04db52f 1046<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1047<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
76b46937 1048</div>
1049<div class="tsd-comment tsd-typography"></div></li></ul></div>
1050<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1051<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1052<ul>
fb8fbcfd 1053<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1042">src/pools/abstract-pool.ts:1042</a></li></ul></aside></li></ul></section>
013a4697 1054<section class="tsd-panel tsd-member tsd-is-private"><a id="sendStatisticsMessageToWorker" class="tsd-anchor"></a>
1055<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>
1056<ul class="tsd-signatures tsd-is-private">
1057<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>
1058<li class="tsd-description">
1059<div class="tsd-comment tsd-typography"><p>Sends the statistics message to worker given its worker node key.</p>
1060</div>
1061<div class="tsd-parameters">
1062<h4 class="tsd-parameters-title">Parameters</h4>
1063<ul class="tsd-parameter-list">
1064<li>
1065<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1066<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
1067</div>
1068<div class="tsd-comment tsd-typography"></div></li></ul></div>
1069<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1070<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1071<ul>
fb8fbcfd 1072<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1049">src/pools/abstract-pool.ts:1049</a></li></ul></aside></li></ul></section>
3bd6a82e 1073<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendToWorker" class="tsd-anchor"></a>
15d6dfaf 1074<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 1075<ul class="tsd-signatures tsd-is-protected">
2447ee8c 1076<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 1077<li class="tsd-description">
f04db52f 1078<div class="tsd-comment tsd-typography"><p>Sends a message to worker given its worker node key.</p>
6c525543 1079</div>
1080<div class="tsd-parameters">
1081<h4 class="tsd-parameters-title">Parameters</h4>
1082<ul class="tsd-parameter-list">
1083<li>
f04db52f 1084<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1085<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
15d6dfaf 1086</div>
1087<div class="tsd-comment tsd-typography"></div></li>
6c525543 1088<li>
030eb5a3 1089<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 1090<div class="tsd-comment tsd-typography"><p>The message.</p>
15d6dfaf 1091</div>
2447ee8c 1092<div class="tsd-comment tsd-typography"></div></li>
1093<li>
1094<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>
1095<div class="tsd-comment tsd-typography"><p>The optional array of transferable objects.</p>
1096</div>
15d6dfaf 1097<div class="tsd-comment tsd-typography"></div></li></ul></div>
1098<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1099<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1100<ul>
fb8fbcfd 1101<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L917">src/pools/abstract-pool.ts:917</a></li></ul></aside></li></ul></section>
3bd6a82e 1102<section class="tsd-panel tsd-member"><a id="setTasksQueueOptions" class="tsd-anchor"></a>
15d6dfaf 1103<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 1104<ul class="tsd-signatures">
15d6dfaf 1105<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 1106<li class="tsd-description">
1107<div class="tsd-comment tsd-typography"><p>Sets the worker tasks queue options in this pool.</p>
1108</div>
1109<div class="tsd-parameters">
1110<h4 class="tsd-parameters-title">Parameters</h4>
1111<ul class="tsd-parameter-list">
1112<li>
8d1797ad 1113<h5><span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5>
6047493a 1114<div class="tsd-comment tsd-typography"><p>The worker tasks queue options.</p>
15d6dfaf 1115</div>
1116<div class="tsd-comment tsd-typography"></div></li></ul></div>
1117<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1118<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 1119<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#setTasksQueueOptions">setTasksQueueOptions</a></p>
6047493a 1120<ul>
fb8fbcfd 1121<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L592">src/pools/abstract-pool.ts:592</a></li></ul></aside></li></ul></section>
3bd6a82e 1122<section class="tsd-panel tsd-member"><a id="setWorkerChoiceStrategy" class="tsd-anchor"></a>
15d6dfaf 1123<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 1124<ul class="tsd-signatures">
15d6dfaf 1125<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 1126<li class="tsd-description">
1127<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy in this pool.</p>
1128</div>
1129<div class="tsd-parameters">
1130<h4 class="tsd-parameters-title">Parameters</h4>
1131<ul class="tsd-parameter-list">
1132<li>
f05afd16 1133<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 1134<div class="tsd-comment tsd-typography"><p>The worker choice strategy.</p>
15d6dfaf 1135</div>
1136<div class="tsd-comment tsd-typography"></div></li>
a8aeac44 1137<li>
8d1797ad 1138<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 1139<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
15d6dfaf 1140</div>
1141<div class="tsd-comment tsd-typography"></div></li></ul></div>
1142<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1143<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 1144<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#setWorkerChoiceStrategy">setWorkerChoiceStrategy</a></p>
6c525543 1145<ul>
fb8fbcfd 1146<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L550">src/pools/abstract-pool.ts:550</a></li></ul></aside></li></ul></section>
3bd6a82e 1147<section class="tsd-panel tsd-member"><a id="setWorkerChoiceStrategyOptions" class="tsd-anchor"></a>
15d6dfaf 1148<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 1149<ul class="tsd-signatures">
15d6dfaf 1150<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 1151<li class="tsd-description">
1152<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy options in this pool.</p>
1153</div>
1154<div class="tsd-parameters">
1155<h4 class="tsd-parameters-title">Parameters</h4>
1156<ul class="tsd-parameter-list">
1157<li>
8d1797ad 1158<h5><span class="tsd-kind-parameter">workerChoiceStrategyOptions</span>: <a href="../interfaces/WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></h5>
6047493a 1159<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
15d6dfaf 1160</div>
1161<div class="tsd-comment tsd-typography"></div></li></ul></div>
1162<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1163<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 1164<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#setWorkerChoiceStrategyOptions">setWorkerChoiceStrategyOptions</a></p>
6047493a 1165<ul>
fb8fbcfd 1166<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L569">src/pools/abstract-pool.ts:569</a></li></ul></aside></li></ul></section>
3bd6a82e 1167<section class="tsd-panel tsd-member tsd-is-protected"><a id="setupHook" class="tsd-anchor"></a>
15d6dfaf 1168<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 1169<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 1170<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 1171<li class="tsd-description">
030eb5a3 1172<div class="tsd-comment tsd-typography"><p>Setup hook to execute code before worker nodes are created in the abstract constructor.
1173Can be overridden.</p>
6c525543 1174</div>
15d6dfaf 1175<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1176<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1177<ul>
fb8fbcfd 1178<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L758">src/pools/abstract-pool.ts:758</a></li></ul></aside></li></ul></section>
6be0ab6d 1179<section class="tsd-panel tsd-member tsd-is-private"><a id="shallCreateDynamicWorker" class="tsd-anchor"></a>
1180<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>
1181<ul class="tsd-signatures tsd-is-private">
1182<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>
1183<li class="tsd-description">
1184<div class="tsd-comment tsd-typography"><p>Conditions for dynamic worker creation.</p>
1185</div>
1186<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether to create a dynamic worker or not.</p>
1187
1188<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1189<ul>
fb8fbcfd 1190<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L906">src/pools/abstract-pool.ts:906</a></li></ul></aside></li></ul></section>
177be4a6 1191<section class="tsd-panel tsd-member tsd-is-private"><a id="startPool" class="tsd-anchor"></a>
1192<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>
1193<ul class="tsd-signatures tsd-is-private">
1194<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>
1195<li class="tsd-description">
1196<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1197<ul>
fb8fbcfd 1198<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L295">src/pools/abstract-pool.ts:295</a></li></ul></aside></li></ul></section>
3bd6a82e 1199<section class="tsd-panel tsd-member tsd-is-private"><a id="tasksQueueSize" class="tsd-anchor"></a>
15d6dfaf 1200<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 1201<ul class="tsd-signatures tsd-is-private">
15d6dfaf 1202<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 1203<li class="tsd-description">
1204<div class="tsd-parameters">
1205<h4 class="tsd-parameters-title">Parameters</h4>
1206<ul class="tsd-parameter-list">
1207<li>
3bd6a82e 1208<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
6c525543 1209<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
1210<ul>
fb8fbcfd 1211<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1242">src/pools/abstract-pool.ts:1242</a></li></ul></aside></li></ul></section>
f05afd16 1212<section class="tsd-panel tsd-member tsd-is-private"><a id="updateEluWorkerUsage" class="tsd-anchor"></a>
1213<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 1214<ul class="tsd-signatures tsd-is-private">
f05afd16 1215<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 1216<li class="tsd-description">
1217<div class="tsd-parameters">
1218<h4 class="tsd-parameters-title">Parameters</h4>
1219<ul class="tsd-parameter-list">
1220<li>
f05afd16 1221<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 1222<li>
030eb5a3 1223<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 1224<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1225<ul>
fb8fbcfd 1226<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L850">src/pools/abstract-pool.ts:850</a></li></ul></aside></li></ul></section>
f05afd16 1227<section class="tsd-panel tsd-member tsd-is-private"><a id="updateRunTimeWorkerUsage" class="tsd-anchor"></a>
1228<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 1229<ul class="tsd-signatures tsd-is-private">
f05afd16 1230<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 1231<li class="tsd-description">
1232<div class="tsd-parameters">
1233<h4 class="tsd-parameters-title">Parameters</h4>
1234<ul class="tsd-parameter-list">
1235<li>
f05afd16 1236<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 1237<li>
030eb5a3 1238<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 1239<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1240<ul>
fb8fbcfd 1241<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L824">src/pools/abstract-pool.ts:824</a></li></ul></aside></li></ul></section>
aac8863d 1242<section class="tsd-panel tsd-member tsd-is-private"><a id="updateTaskStatisticsWorkerUsage" class="tsd-anchor"></a>
1243<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>
1244<ul class="tsd-signatures tsd-is-private">
1245<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>
1246<li class="tsd-description">
1247<div class="tsd-parameters">
1248<h4 class="tsd-parameters-title">Parameters</h4>
1249<ul class="tsd-parameter-list">
1250<li>
1251<h5><span class="tsd-kind-parameter">workerUsage</span>: <a href="../interfaces/WorkerUsage.html" class="tsd-signature-type tsd-kind-interface">WorkerUsage</a></h5></li>
1252<li>
030eb5a3 1253<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 1254<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1255<ul>
fb8fbcfd 1256<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L811">src/pools/abstract-pool.ts:811</a></li></ul></aside></li></ul></section>
f05afd16 1257<section class="tsd-panel tsd-member tsd-is-private"><a id="updateWaitTimeWorkerUsage" class="tsd-anchor"></a>
1258<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 1259<ul class="tsd-signatures tsd-is-private">
f05afd16 1260<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 1261<li class="tsd-description">
1262<div class="tsd-parameters">
1263<h4 class="tsd-parameters-title">Parameters</h4>
1264<ul class="tsd-parameter-list">
1265<li>
f05afd16 1266<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 1267<li>
f05afd16 1268<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 1269<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1270<ul>
fb8fbcfd 1271<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L836">src/pools/abstract-pool.ts:836</a></li></ul></aside></li></ul></section>
3bd6a82e 1272<section class="tsd-panel tsd-member tsd-is-protected"><a id="workerListener" class="tsd-anchor"></a>
15d6dfaf 1273<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 1274<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 1275<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 1276<li class="tsd-description">
f04db52f 1277<div class="tsd-comment tsd-typography"><p>This method is the listener registered for each worker message.</p>
6c525543 1278</div>
fab6d3b5 1279<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>
1280
6c525543 1281<ul class="tsd-parameters">
1282<li class="tsd-parameter-signature">
3bd6a82e 1283<ul class="tsd-signatures">
1284<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 1285<li class="tsd-description">
f04db52f 1286<div class="tsd-comment tsd-typography"><p>This method is the listener registered for each worker message.</p>
6c525543 1287</div>
1288<div class="tsd-parameters">
1289<h4 class="tsd-parameters-title">Parameters</h4>
1290<ul class="tsd-parameter-list">
1291<li>
030eb5a3 1292<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 1293<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 1294
1295<div class="tsd-comment tsd-typography"></div></li></ul></li></ul>
1296<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1297<ul>
fb8fbcfd 1298<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2115798/src/pools/abstract-pool.ts#L1111">src/pools/abstract-pool.ts:1111</a></li></ul></aside></li></ul></section></section></div>
6c525543 1299<div class="col-sidebar">
1300<div class="page-menu">
1301<div class="tsd-navigation settings">
1302<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
15d6dfaf 1303<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 1304<div class="tsd-accordion-details">
1305<div class="tsd-filter-visibility">
1306<h4 class="uppercase">Member Visibility</h4><form>
1307<ul id="tsd-filter-options">
1308<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>
1309<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>
1310<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>
1311<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>
1312<div class="tsd-theme-toggle">
3bd6a82e 1313<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 1314<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 1315<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 1316<div class="tsd-accordion-details">
1317<ul>
15d6dfaf 1318<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>
1319<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>
1320<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>
1321<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>
1322<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>
1323<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 1324<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 1325<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 1326<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 1327<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>
1328<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>
1329<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>
1330<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>
1331<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>
1332<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>
1333<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 1334<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 1335<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 1336<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 1337<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 1338<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 1339<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 1340<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 1341<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>
1342<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>
1343<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 1344<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 1345<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 1346<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 1347<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>
1348<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>
1349<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>
1350<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>
1351<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 1352<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 1353<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>
1354<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 1355<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>
1356<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>
1357<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 1358<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 1359<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>
1360<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>
1361<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>
1362<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 1363<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 1364<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 1365<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>
1366<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>
1367<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 1368<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 1369<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 1370<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>
1371<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 1372<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 1373<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 1374<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 1375<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 1376<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 1377<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 1378<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 1379<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>
1380<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>
1381<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>
1382<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 1383<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 1384<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 1385<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 1386<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 1387<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>
1388<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 1389<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 1390<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 1391<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 1392<div class="site-menu">
fb8fbcfd 1393<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.28</span></a>
6c525543 1394<ul class="tsd-small-nested-navigation">
15d6dfaf 1395<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>
1396<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>
1397<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>
1398<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>
1399<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>
1400<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>
1401<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>
1402<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>
1403<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>
1404<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>
1405<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>
1406<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>
1407<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 1408<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 1409<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>
1410<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>
1411<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 1412<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 1413<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>
1414<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>
1415<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 1416<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>
1417<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>
1418<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>
1419<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 1420<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 1421<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 1422<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 1423<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 1424<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 1425<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 1426<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 1427<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 1428<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 1429<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 1430<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 1431<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 1432<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 1433<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 1434<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>
1435<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 1436<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 1437<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 1438<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>
1439<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>
1440<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>
1441<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 1442<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>
1443<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 1444<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 1445<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 1446<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 1447<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>
1448<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 1449<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 1450<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>
1451<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>
1452<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 1453<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>
1454<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 1455<div class="tsd-generator">
1456<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
1457<div class="overlay"></div></body></html>