build(deps-dev): apply updates
[poolifier.git] / docs / classes / AbstractPool.html
CommitLineData
83924e2a 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 - v3.0.5</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><script async src="../assets/navigation.js" id="tsd-nav-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="..">
cb4889b4 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"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
6c525543 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>
83924e2a 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v3.0.5</a></div>
cb4889b4 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"><use href="#icon-menu"></use></svg></a></div></div></header>
6c525543 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>
83924e2a 52<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L66">src/pools/abstract-pool.ts:66</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">
cb4889b4 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"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary>
6c525543 57<div class="tsd-accordion-details">
58<section class="tsd-index-section">
59<h3 class="tsd-index-heading">Constructors</h3>
cb4889b4 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"><use href="#icon-512"></use></svg><span>constructor</span></a>
6c525543 61</div></section>
62<section class="tsd-index-section">
63<h3 class="tsd-index-heading">Properties</h3>
cb4889b4 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"><use href="#icon-1024"></use></svg><span>emitter?</span></a>
15d6dfaf 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>
00471704 66<a href="AbstractPool.html#max" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max?</span></a>
15d6dfaf 67<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>
68<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>
69<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 70<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>
31542ddf 71<a href="AbstractPool.html#started" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>started</span></a>
44b95861 72<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>
dbf662af 73<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 74<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>
75<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 76</div></section>
77<section class="tsd-index-section">
78<h3 class="tsd-index-heading">Accessors</h3>
cb4889b4 79<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"><use href="#icon-262144"></use></svg><span>busy</span></a>
15d6dfaf 80<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>
81<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>
82<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>
83<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 84<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 85<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 86<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 87<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 88</div></section>
89<section class="tsd-index-section">
90<h3 class="tsd-index-heading">Methods</h3>
dbf662af
DB
91<div class="tsd-index-list"><a href="AbstractPool.html#addTaskFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Task<wbr/>Function</span></a>
92<a href="AbstractPool.html#addWorkerNode" class="tsd-index-link 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>
7b88db4b 93<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 94<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 95<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>
96<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>
00471704 97<a href="AbstractPool.html#checkAndEmitDynamicWorkerCreationEvents" 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/>Dynamic<wbr/>Worker<wbr/>Creation<wbr/>Events</span></a>
98<a href="AbstractPool.html#checkAndEmitTaskExecutionEvents" 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/>Task<wbr/>Execution<wbr/>Events</span></a>
99<a href="AbstractPool.html#checkAndEmitTaskQueuingEvents" 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/>Task<wbr/>Queuing<wbr/>Events</span></a>
47c9cec4 100<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 101<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>
102<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>
15d6dfaf 103<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 104<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 105<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>
106<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 107<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>
dbf662af 108<a href="AbstractPool.html#deleteTaskFunctionWorkerUsages" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Task<wbr/>Function<wbr/>Worker<wbr/>Usages</span></a>
15d6dfaf 109<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>
51e49c70 110<a href="AbstractPool.html#deregisterWorkerMessageListener" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>deregister<wbr/>Worker<wbr/>Message<wbr/>Listener</span></a>
15d6dfaf 111<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 112<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 113<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>
114<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>
115<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>
116<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>
fc09c6dc 117<a href="AbstractPool.html#flagWorkerNodeAsNotReady" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flag<wbr/>Worker<wbr/>Node<wbr/>As<wbr/>Not<wbr/>Ready</span></a>
f04db52f 118<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 119<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 120<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>
121<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>
122<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>
80048093
DB
123<a href="AbstractPool.html#handleBackPressureEvent" 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/>Back<wbr/>Pressure<wbr/>Event</span></a>
124<a href="AbstractPool.html#handleEmptyQueueEvent" 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/>Empty<wbr/>Queue<wbr/>Event</span></a>
202bcb6b 125<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 126<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>
c22b117f 127<a href="AbstractPool.html#hasBackPressure" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Back<wbr/>Pressure</span></a>
dbf662af 128<a href="AbstractPool.html#hasTaskFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Task<wbr/>Function</span></a>
c22b117f 129<a href="AbstractPool.html#hasWorkerNodeBackPressure" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span></a>
48c6ba05 130<a href="AbstractPool.html#initializeEventEmitter" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>initialize<wbr/>Event<wbr/>Emitter</span></a>
15d6dfaf 131<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>
132<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>
dbf662af 133<a href="AbstractPool.html#listTaskFunctionNames" 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/>Function<wbr/>Names</span></a>
912e1dfa 134<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>
51e49c70 135<a href="AbstractPool.html#registerOnceWorkerMessageListener" 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/>Once<wbr/>Worker<wbr/>Message<wbr/>Listener</span></a>
76b46937 136<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>
dbf662af 137<a href="AbstractPool.html#removeTaskFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Task<wbr/>Function</span></a>
15d6dfaf 138<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 139<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 140<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 141<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>
dbf662af
DB
142<a href="AbstractPool.html#sendTaskFunctionOperationToWorker" 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/>Task<wbr/>Function<wbr/>Operation<wbr/>To<wbr/>Worker</span></a>
143<a href="AbstractPool.html#sendTaskFunctionOperationToWorkers" 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/>Task<wbr/>Function<wbr/>Operation<wbr/>To<wbr/>Workers</span></a>
15d6dfaf 144<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>
dbf662af 145<a href="AbstractPool.html#setDefaultTaskFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Task<wbr/>Function</span></a>
717e9363 146<a href="AbstractPool.html#setTaskStealing" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Task<wbr/>Stealing</span></a>
15d6dfaf 147<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>
c8a9d171 148<a href="AbstractPool.html#setTasksQueueSize" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Tasks<wbr/>Queue<wbr/>Size</span></a>
717e9363 149<a href="AbstractPool.html#setTasksStealingOnBackPressure" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Tasks<wbr/>Stealing<wbr/>On<wbr/>Back<wbr/>Pressure</span></a>
15d6dfaf 150<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>
151<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 152<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 153<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>
7ab352a6 154<a href="AbstractPool.html#shallExecuteTask" 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/>Execute<wbr/>Task</span></a>
c22b117f 155<a href="AbstractPool.html#shallUpdateTaskFunctionWorkerUsage" 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/>Update<wbr/>Task<wbr/>Function<wbr/>Worker<wbr/>Usage</span></a>
0b4e655c 156<a href="AbstractPool.html#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>start</span></a>
15d6dfaf 157<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>
717e9363 158<a href="AbstractPool.html#unsetTaskStealing" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unset<wbr/>Task<wbr/>Stealing</span></a>
159<a href="AbstractPool.html#unsetTasksStealingOnBackPressure" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unset<wbr/>Tasks<wbr/>Stealing<wbr/>On<wbr/>Back<wbr/>Pressure</span></a>
f05afd16 160<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>
161<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 162<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>
7ab352a6 163<a href="AbstractPool.html#updateTaskStolenStatisticsWorkerUsage" 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/>Stolen<wbr/>Statistics<wbr/>Worker<wbr/>Usage</span></a>
f05afd16 164<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>
d5c35d0e 165<a href="AbstractPool.html#workerMessageListener" 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/>Message<wbr/>Listener</span></a>
6c525543 166</div></section></div></details></section></section>
167<section class="tsd-panel-group tsd-member-group">
168<h2>Constructors</h2>
3bd6a82e 169<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
cb4889b4 170<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 171<ul class="tsd-signatures">
15d6dfaf 172<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 173<li class="tsd-description">
174<div class="tsd-comment tsd-typography"><p>Constructs a new poolifier pool.</p>
175</div>
fab6d3b5 176<section class="tsd-panel">
6c525543 177<h4>Type Parameters</h4>
fab6d3b5 178<ul class="tsd-type-parameter-list">
6c525543 179<li>
a97f9c80 180<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 181<li>
3bd6a82e 182<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4></li>
6c525543 183<li>
3bd6a82e 184<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section>
6c525543 185<div class="tsd-parameters">
186<h4 class="tsd-parameters-title">Parameters</h4>
187<ul class="tsd-parameter-list">
188<li>
3bd6a82e 189<h5><span class="tsd-kind-parameter">numberOfWorkers</span>: <span class="tsd-signature-type">number</span></h5>
6c525543 190<div class="tsd-comment tsd-typography"><p>Number of workers that this pool should manage.</p>
cb4889b4 191</div>
192<div class="tsd-comment tsd-typography"></div></li>
6c525543 193<li>
3bd6a82e 194<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
f63918da 195<div class="tsd-comment tsd-typography"><p>Path to the worker file.</p>
cb4889b4 196</div>
197<div class="tsd-comment tsd-typography"></div></li>
6c525543 198<li>
8d1797ad 199<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 200<div class="tsd-comment tsd-typography"><p>Options for the pool.</p>
cb4889b4 201</div>
202<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 203<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>
204<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 205<ul>
83924e2a 206<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L128">src/pools/abstract-pool.ts:128</a></li></ul></aside></li></ul></section></section>
6c525543 207<section class="tsd-panel-group tsd-member-group">
208<h2>Properties</h2>
3bd6a82e 209<section class="tsd-panel tsd-member"><a id="emitter" class="tsd-anchor"></a>
48c6ba05 210<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</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>
66fc6ae4 211<div class="tsd-signature"><span class="tsd-kind-property">emitter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">EventEmitterAsyncResource</span></div>
48c6ba05
DB
212<div class="tsd-comment tsd-typography"><p>Event emitter integrated with async resource on which events can be listened to.
213The async tracking tooling identifier is <code>poolifier:&lt;PoolType&gt;-&lt;WorkerType&gt;-pool</code>.</p>
6c525543 214<p>Events that can currently be listened to:</p>
215<ul>
85c03385 216<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>
7ab352a6 217<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 concurrently their tasks quota.</li>
a13e50c3 218<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>
a84c4698 219<li><code>&#39;destroy&#39;</code>: Emitted when the pool is destroyed.</li>
ccb7d1a7 220<li><code>&#39;error&#39;</code>: Emitted when an uncaught error occurs.</li>
221<li><code>&#39;taskError&#39;</code>: Emitted when an error occurs while executing a task.</li>
31542ddf 222<li><code>&#39;backPressure&#39;</code>: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size &gt;= maximum queue size).</li>
6c525543 223</ul>
15d6dfaf 224</div>
225<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 226<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#emitter">emitter</a></p>
227<ul>
83924e2a 228<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L75">src/pools/abstract-pool.ts:75</a></li></ul></aside></section>
184d530f 229<section class="tsd-panel tsd-member tsd-is-protected"><a id="filePath" class="tsd-anchor"></a>
15d6dfaf 230<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 231<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 232<div class="tsd-comment tsd-typography"><p>Path to the worker file.</p>
15d6dfaf 233</div>
234<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 235<ul>
83924e2a 236<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L130">src/pools/abstract-pool.ts:130</a></li></ul></aside></section>
00471704 237<section class="tsd-panel tsd-member tsd-is-protected"><a id="max" class="tsd-anchor"></a>
238<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>max</span><a href="#max" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
239<div class="tsd-signature"><span class="tsd-kind-property">max</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
240<div class="tsd-comment tsd-typography"><p>Dynamic pool maximum size property placeholder.</p>
241</div>
242<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
243<ul>
83924e2a 244<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L80">src/pools/abstract-pool.ts:80</a></li></ul></aside></section>
184d530f 245<section class="tsd-panel tsd-member tsd-is-protected"><a id="numberOfWorkers" class="tsd-anchor"></a>
15d6dfaf 246<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 247<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 248<div class="tsd-comment tsd-typography"><p>Number of workers that this pool should manage.</p>
15d6dfaf 249</div>
250<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 251<ul>
83924e2a 252<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L129">src/pools/abstract-pool.ts:129</a></li></ul></aside></section>
184d530f 253<section class="tsd-panel tsd-member tsd-is-protected"><a id="opts" class="tsd-anchor"></a>
15d6dfaf 254<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 255<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 256<div class="tsd-comment tsd-typography"><p>Options for the pool.</p>
15d6dfaf 257</div>
258<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 259<ul>
83924e2a 260<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L131">src/pools/abstract-pool.ts:131</a></li></ul></aside></section>
3bd6a82e 261<section class="tsd-panel tsd-member tsd-is-protected"><a id="promiseResponseMap" class="tsd-anchor"></a>
15d6dfaf 262<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 263<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>
0b4e655c 264<div class="tsd-comment tsd-typography"><p>The task execution response promise map:</p>
6c525543 265<ul>
266<li><code>key</code>: The message id of each submitted task.</li>
267<li><code>value</code>: An object that contains the worker, the execution response promise resolve and reject callbacks.</li>
268</ul>
269<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 270</div>
271<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 272<ul>
83924e2a 273<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L89">src/pools/abstract-pool.ts:89</a></li></ul></aside></section>
202bcb6b 274<section class="tsd-panel tsd-member tsd-is-private"><a id="startTimestamp" class="tsd-anchor"></a>
275<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>
276<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>
277<div class="tsd-comment tsd-typography"><p>The start timestamp of the pool.</p>
278</div>
279<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
280<ul>
83924e2a 281<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L119">src/pools/abstract-pool.ts:119</a></li></ul></aside></section>
31542ddf 282<section class="tsd-panel tsd-member tsd-is-private"><a id="started" class="tsd-anchor"></a>
283<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>started</span><a href="#started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
284<div class="tsd-signature"><span class="tsd-kind-property">started</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
285<div class="tsd-comment tsd-typography"><p>Whether the pool is started or not.</p>
286</div>
287<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
288<ul>
83924e2a 289<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L111">src/pools/abstract-pool.ts:111</a></li></ul></aside></section>
44b95861 290<section class="tsd-panel tsd-member tsd-is-private"><a id="starting" class="tsd-anchor"></a>
0b4e655c 291<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</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>
44b95861 292<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>
293<div class="tsd-comment tsd-typography"><p>Whether the pool is starting or not.</p>
294</div>
295<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
296<ul>
83924e2a 297<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L115">src/pools/abstract-pool.ts:115</a></li></ul></aside></section>
dbf662af
DB
298<section class="tsd-panel tsd-member tsd-is-private"><a id="taskFunctions" class="tsd-anchor"></a>
299<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</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>
300<div class="tsd-signature"><span class="tsd-kind-property">task<wbr/>Functions</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="../types/TaskFunction.html" class="tsd-signature-type tsd-kind-type-alias">TaskFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div>
301<div class="tsd-comment tsd-typography"><p>The task functions added at runtime map:</p>
302<ul>
303<li><code>key</code>: The task function name.</li>
304<li><code>value</code>: The task function itself.</li>
305</ul>
306</div>
307<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
308<ul>
83924e2a 309<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L106">src/pools/abstract-pool.ts:106</a></li></ul></aside></section>
3bd6a82e 310<section class="tsd-panel tsd-member tsd-is-protected"><a id="workerChoiceStrategyContext" class="tsd-anchor"></a>
15d6dfaf 311<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 312<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 313<div class="tsd-comment tsd-typography"><p>Worker choice strategy context referencing a worker choice algorithm implementation.</p>
15d6dfaf 314</div>
315<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 316<ul>
83924e2a 317<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L95">src/pools/abstract-pool.ts:95</a></li></ul></aside></section>
3bd6a82e 318<section class="tsd-panel tsd-member"><a id="workerNodes" class="tsd-anchor"></a>
c22b117f 319<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <code class="tsd-tag ts-flagInternal">Internal</code> <span>worker<wbr/>Nodes</span><a href="#workerNodes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
a6b5c73c 320<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 321<div class="tsd-comment tsd-typography"><p>Pool worker nodes.</p>
15d6dfaf 322</div>
323<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 324<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#workerNodes">workerNodes</a></p>
325<ul>
83924e2a 326<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L72">src/pools/abstract-pool.ts:72</a></li></ul></aside></section></section>
6c525543 327<section class="tsd-panel-group tsd-member-group">
328<h2>Accessors</h2>
3bd6a82e 329<section class="tsd-panel tsd-member tsd-is-protected"><a id="busy" class="tsd-anchor"></a>
15d6dfaf 330<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 331<ul class="tsd-signatures tsd-is-protected">
6c525543 332<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>
333<li class="tsd-description">
334<div class="tsd-comment tsd-typography"><p>Whether the pool is busy or not.</p>
335<p>The pool busyness boolean status.</p>
336</div>
15d6dfaf 337<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
338<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 339<ul>
83924e2a 340<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L669">src/pools/abstract-pool.ts:669</a></li></ul></aside></li></ul></section>
3bd6a82e 341<section class="tsd-panel tsd-member tsd-is-protected"><a id="full" class="tsd-anchor"></a>
15d6dfaf 342<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 343<ul class="tsd-signatures tsd-is-protected">
6c525543 344<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>
345<li class="tsd-description">
346<div class="tsd-comment tsd-typography"><p>Whether the pool is full or not.</p>
347<p>The pool filling boolean status.</p>
348</div>
15d6dfaf 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">
6c525543 351<ul>
83924e2a 352<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L660">src/pools/abstract-pool.ts:660</a></li></ul></aside></li></ul></section>
a2742ce7 353<section class="tsd-panel tsd-member"><a id="info" class="tsd-anchor"></a>
15d6dfaf 354<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 355<ul class="tsd-signatures">
356<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 357<li class="tsd-description">
a2742ce7 358<div class="tsd-comment tsd-typography"><p>Pool information.</p>
6c525543 359</div>
15d6dfaf 360<h4 class="tsd-returns-title">Returns <a href="../interfaces/PoolInfo.html" class="tsd-signature-type tsd-kind-interface">PoolInfo</a></h4>
361<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a2742ce7 362<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#info">info</a></p>
6c525543 363<ul>
83924e2a 364<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L273">src/pools/abstract-pool.ts:273</a></li></ul></aside></li></ul></section>
a2742ce7 365<section class="tsd-panel tsd-member tsd-is-protected"><a id="maxSize" class="tsd-anchor"></a>
00471704 366<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>max<wbr/>Size</span><a href="#maxSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
a2742ce7 367<ul class="tsd-signatures tsd-is-protected">
368<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 369<li class="tsd-description">
f04db52f 370<div class="tsd-comment tsd-typography"><p>The pool maximum size.</p>
6c525543 371</div>
15d6dfaf 372<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
373<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 374<ul>
83924e2a 375<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L486">src/pools/abstract-pool.ts:486</a></li></ul></aside></li></ul></section>
a2742ce7 376<section class="tsd-panel tsd-member tsd-is-protected"><a id="minSize" class="tsd-anchor"></a>
00471704 377<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>min<wbr/>Size</span><a href="#minSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
a2742ce7 378<ul class="tsd-signatures tsd-is-protected">
379<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 380<li class="tsd-description">
f04db52f 381<div class="tsd-comment tsd-typography"><p>The pool minimum size.</p>
2c94c3a5 382</div>
15d6dfaf 383<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
384<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
2c94c3a5 385<ul>
83924e2a 386<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L479">src/pools/abstract-pool.ts:479</a></li></ul></aside></li></ul></section>
c914a50e 387<section class="tsd-panel tsd-member tsd-is-private"><a id="ready" class="tsd-anchor"></a>
388<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>
389<ul class="tsd-signatures tsd-is-private">
390<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>
391<li class="tsd-description">
f04db52f 392<div class="tsd-comment tsd-typography"><p>The pool readiness boolean status.</p>
393</div>
394<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
395<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
c914a50e 396<ul>
83924e2a 397<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L431">src/pools/abstract-pool.ts:431</a></li></ul></aside></li></ul></section>
184d530f 398<section class="tsd-panel tsd-member tsd-is-protected"><a id="type" class="tsd-anchor"></a>
15d6dfaf 399<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 400<ul class="tsd-signatures tsd-is-protected">
a2742ce7 401<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 402<li class="tsd-description">
f04db52f 403<div class="tsd-comment tsd-typography"><p>The pool type.</p>
6c525543 404<p>If it is <code>&#39;dynamic&#39;</code>, it provides the <code>max</code> property.</p>
405</div>
15d6dfaf 406<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>
407<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 408<ul>
83924e2a 409<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L469">src/pools/abstract-pool.ts:469</a></li></ul></aside></li></ul></section>
202bcb6b 410<section class="tsd-panel tsd-member tsd-is-private"><a id="utilization" class="tsd-anchor"></a>
411<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>
412<ul class="tsd-signatures tsd-is-private">
413<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>
414<li class="tsd-description">
f04db52f 415<div class="tsd-comment tsd-typography"><p>The approximate pool utilization.</p>
202bcb6b 416</div>
417<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The pool utilization.</p>
418
419<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
420<ul>
83924e2a 421<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L448">src/pools/abstract-pool.ts:448</a></li></ul></aside></li></ul></section>
184d530f 422<section class="tsd-panel tsd-member tsd-is-protected"><a id="worker" class="tsd-anchor"></a>
15d6dfaf 423<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 424<ul class="tsd-signatures tsd-is-protected">
3c7c9bd1 425<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 426<li class="tsd-description">
f04db52f 427<div class="tsd-comment tsd-typography"><p>The worker type.</p>
184d530f 428</div>
3c7c9bd1 429<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 430<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
184d530f 431<ul>
83924e2a 432<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L474">src/pools/abstract-pool.ts:474</a></li></ul></aside></li></ul></section></section>
6c525543 433<section class="tsd-panel-group tsd-member-group">
434<h2>Methods</h2>
dbf662af
DB
435<section class="tsd-panel tsd-member"><a id="addTaskFunction" class="tsd-anchor"></a>
436<h3 class="tsd-anchor-link"><span>add<wbr/>Task<wbr/>Function</span><a href="#addTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
437<ul class="tsd-signatures">
438<li class="tsd-signature tsd-anchor-link" id="addTaskFunction.addTaskFunction-1"><span class="tsd-kind-call-signature">add<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">fn</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">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#addTaskFunction.addTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
439<li class="tsd-description">
440<div class="tsd-comment tsd-typography"><p>Adds a task function to this pool.
441If a task function with the same name already exists, it will be overwritten.</p>
442</div>
443<div class="tsd-parameters">
444<h4 class="tsd-parameters-title">Parameters</h4>
445<ul class="tsd-parameter-list">
446<li>
447<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
448<div class="tsd-comment tsd-typography"><p>The name of the task function.</p>
449</div>
450<div class="tsd-comment tsd-typography"></div></li>
451<li>
452<h5><span class="tsd-kind-parameter">fn</span>: <a href="../types/TaskFunction.html" class="tsd-signature-type tsd-kind-type-alias">TaskFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span></h5>
453<div class="tsd-comment tsd-typography"><p>The task function.</p>
454</div>
455<div class="tsd-comment tsd-typography"></div></li></ul></div>
456<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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p><code>true</code> if the task function was added, <code>false</code> otherwise.</p>
457
458<div class="tsd-comment tsd-typography">
459<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror</a> If the <code>name</code> parameter is not a string or an empty string.</p>
460
461<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror</a> If the <code>fn</code> parameter is not a function.</p>
462</div><aside class="tsd-sources">
463<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#addTaskFunction">addTaskFunction</a></p>
464<ul>
83924e2a 465<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L805">src/pools/abstract-pool.ts:805</a></li></ul></aside></li></ul></section>
7b88db4b 466<section class="tsd-panel tsd-member tsd-is-private"><a id="addWorkerNode" class="tsd-anchor"></a>
467<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>
468<ul class="tsd-signatures tsd-is-private">
469<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>
470<li class="tsd-description">
471<div class="tsd-comment tsd-typography"><p>Adds the given worker in the pool worker nodes.</p>
472</div>
473<div class="tsd-parameters">
474<h4 class="tsd-parameters-title">Parameters</h4>
475<ul class="tsd-parameter-list">
476<li>
477<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></h5>
478<div class="tsd-comment tsd-typography"><p>The worker.</p>
cb4889b4 479</div>
480<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 481<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The added worker node key.</p>
7b88db4b 482
f04db52f 483<div class="tsd-comment tsd-typography">
484<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>
485</div><aside class="tsd-sources">
7b88db4b 486<ul>
83924e2a 487<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1619">src/pools/abstract-pool.ts:1619</a></li></ul></aside></li></ul></section>
3bd6a82e 488<section class="tsd-panel tsd-member tsd-is-protected"><a id="afterTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 489<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 490<ul class="tsd-signatures tsd-is-protected">
f04db52f 491<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 492<li class="tsd-description">
493<div class="tsd-comment tsd-typography"><p>Hook executed after the worker task execution.
494Can be overridden.</p>
495</div>
496<div class="tsd-parameters">
497<h4 class="tsd-parameters-title">Parameters</h4>
498<ul class="tsd-parameter-list">
499<li>
f04db52f 500<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
501<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 502</div>
503<div class="tsd-comment tsd-typography"></div></li>
6c525543 504<li>
030eb5a3 505<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 506<div class="tsd-comment tsd-typography"><p>The received message.</p>
cb4889b4 507</div>
508<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 509<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
510<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 511<ul>
83924e2a 512<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1043">src/pools/abstract-pool.ts:1043</a></li></ul></aside></li></ul></section>
f04db52f 513<section class="tsd-panel tsd-member tsd-is-protected"><a id="afterWorkerNodeSetup" class="tsd-anchor"></a>
514<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 515<ul class="tsd-signatures tsd-is-protected">
f04db52f 516<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 517<li class="tsd-description">
f04db52f 518<div class="tsd-comment tsd-typography"><p>Method hooked up after a worker node has been newly created.
030eb5a3 519Can be overridden.</p>
6c525543 520</div>
521<div class="tsd-parameters">
522<h4 class="tsd-parameters-title">Parameters</h4>
523<ul class="tsd-parameter-list">
524<li>
f04db52f 525<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
526<div class="tsd-comment tsd-typography"><p>The newly created worker node key.</p>
cb4889b4 527</div>
528<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 529<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
530<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 531<ul>
83924e2a 532<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1356">src/pools/abstract-pool.ts:1356</a></li></ul></aside></li></ul></section>
3bd6a82e 533<section class="tsd-panel tsd-member tsd-is-protected"><a id="beforeTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 534<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 535<ul class="tsd-signatures tsd-is-protected">
f05afd16 536<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 537<li class="tsd-description">
538<div class="tsd-comment tsd-typography"><p>Hook executed before the worker task execution.
539Can be overridden.</p>
540</div>
541<div class="tsd-parameters">
542<h4 class="tsd-parameters-title">Parameters</h4>
543<ul class="tsd-parameter-list">
544<li>
3bd6a82e 545<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
6c525543 546<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 547</div>
548<div class="tsd-comment tsd-typography"></div></li>
f05afd16 549<li>
550<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>
551<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
cb4889b4 552</div>
553<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 554<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
555<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 556<ul>
83924e2a 557<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1013">src/pools/abstract-pool.ts:1013</a></li></ul></aside></li></ul></section>
3bd6a82e 558<section class="tsd-panel tsd-member tsd-is-private"><a id="buildTasksQueueOptions" class="tsd-anchor"></a>
15d6dfaf 559<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 560<ul class="tsd-signatures tsd-is-private">
15d6dfaf 561<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 562<li class="tsd-description">
563<div class="tsd-parameters">
564<h4 class="tsd-parameters-title">Parameters</h4>
565<ul class="tsd-parameter-list">
566<li>
8d1797ad 567<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>
568<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 569<ul>
83924e2a 570<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L599">src/pools/abstract-pool.ts:599</a></li></ul></aside></li></ul></section>
00471704 571<section class="tsd-panel tsd-member tsd-is-private"><a id="checkAndEmitDynamicWorkerCreationEvents" class="tsd-anchor"></a>
572<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>And<wbr/>Emit<wbr/>Dynamic<wbr/>Worker<wbr/>Creation<wbr/>Events</span><a href="#checkAndEmitDynamicWorkerCreationEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
573<ul class="tsd-signatures tsd-is-private">
574<li class="tsd-signature tsd-anchor-link" id="checkAndEmitDynamicWorkerCreationEvents.checkAndEmitDynamicWorkerCreationEvents-1"><span class="tsd-kind-call-signature">check<wbr/>And<wbr/>Emit<wbr/>Dynamic<wbr/>Worker<wbr/>Creation<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="#checkAndEmitDynamicWorkerCreationEvents.checkAndEmitDynamicWorkerCreationEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
575<li class="tsd-description">
576<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
577<ul>
83924e2a 578<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1594">src/pools/abstract-pool.ts:1594</a></li></ul></aside></li></ul></section>
00471704 579<section class="tsd-panel tsd-member tsd-is-private"><a id="checkAndEmitTaskExecutionEvents" class="tsd-anchor"></a>
580<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>And<wbr/>Emit<wbr/>Task<wbr/>Execution<wbr/>Events</span><a href="#checkAndEmitTaskExecutionEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
581<ul class="tsd-signatures tsd-is-private">
582<li class="tsd-signature tsd-anchor-link" id="checkAndEmitTaskExecutionEvents.checkAndEmitTaskExecutionEvents-1"><span class="tsd-kind-call-signature">check<wbr/>And<wbr/>Emit<wbr/>Task<wbr/>Execution<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="#checkAndEmitTaskExecutionEvents.checkAndEmitTaskExecutionEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
583<li class="tsd-description">
584<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
585<ul>
83924e2a 586<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1582">src/pools/abstract-pool.ts:1582</a></li></ul></aside></li></ul></section>
00471704 587<section class="tsd-panel tsd-member tsd-is-private"><a id="checkAndEmitTaskQueuingEvents" class="tsd-anchor"></a>
588<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>And<wbr/>Emit<wbr/>Task<wbr/>Queuing<wbr/>Events</span><a href="#checkAndEmitTaskQueuingEvents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 589<ul class="tsd-signatures tsd-is-private">
00471704 590<li class="tsd-signature tsd-anchor-link" id="checkAndEmitTaskQueuingEvents.checkAndEmitTaskQueuingEvents-1"><span class="tsd-kind-call-signature">check<wbr/>And<wbr/>Emit<wbr/>Task<wbr/>Queuing<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="#checkAndEmitTaskQueuingEvents.checkAndEmitTaskQueuingEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 591<li class="tsd-description">
592<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
593<ul>
83924e2a 594<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1588">src/pools/abstract-pool.ts:1588</a></li></ul></aside></li></ul></section>
47c9cec4 595<section class="tsd-panel tsd-member tsd-is-private"><a id="checkMessageWorkerId" class="tsd-anchor"></a>
596<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>
597<ul class="tsd-signatures tsd-is-private">
598<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>
599<li class="tsd-description">
7b88db4b 600<div class="tsd-comment tsd-typography"><p>Checks if the worker id sent in the received message from a worker is valid.</p>
601</div>
47c9cec4 602<div class="tsd-parameters">
603<h4 class="tsd-parameters-title">Parameters</h4>
604<ul class="tsd-parameter-list">
605<li>
51e49c70 606<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 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>
7b88db4b 607<div class="tsd-comment tsd-typography"><p>The received message.</p>
cb4889b4 608</div>
609<div class="tsd-comment tsd-typography"></div></li></ul></div>
7b88db4b 610<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
611<div class="tsd-comment tsd-typography">
612<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>
613</div><aside class="tsd-sources">
47c9cec4 614<ul>
83924e2a 615<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L496">src/pools/abstract-pool.ts:496</a></li></ul></aside></li></ul></section>
3bd6a82e 616<section class="tsd-panel tsd-member tsd-is-private"><a id="checkNumberOfWorkers" class="tsd-anchor"></a>
15d6dfaf 617<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 618<ul class="tsd-signatures tsd-is-private">
15d6dfaf 619<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 620<li class="tsd-description">
621<div class="tsd-parameters">
622<h4 class="tsd-parameters-title">Parameters</h4>
623<ul class="tsd-parameter-list">
624<li>
3bd6a82e 625<h5><span class="tsd-kind-parameter">numberOfWorkers</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
6c525543 626<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
627<ul>
83924e2a 628<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L172">src/pools/abstract-pool.ts:172</a></li></ul></aside></li></ul></section>
3bd6a82e 629<section class="tsd-panel tsd-member tsd-is-private"><a id="checkPoolOptions" class="tsd-anchor"></a>
15d6dfaf 630<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 631<ul class="tsd-signatures tsd-is-private">
15d6dfaf 632<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 633<li class="tsd-description">
634<div class="tsd-parameters">
635<h4 class="tsd-parameters-title">Parameters</h4>
636<ul class="tsd-parameter-list">
637<li>
8d1797ad 638<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 639<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
640<ul>
83924e2a 641<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L190">src/pools/abstract-pool.ts:190</a></li></ul></aside></li></ul></section>
2c94c3a5 642<section class="tsd-panel tsd-member tsd-is-private"><a id="checkValidWorkerChoiceStrategyOptions" class="tsd-anchor"></a>
15d6dfaf 643<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 644<ul class="tsd-signatures tsd-is-private">
15d6dfaf 645<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 646<li class="tsd-description">
647<div class="tsd-parameters">
648<h4 class="tsd-parameters-title">Parameters</h4>
649<ul class="tsd-parameter-list">
650<li>
651<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>
652<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
653<ul>
83924e2a 654<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L219">src/pools/abstract-pool.ts:219</a></li></ul></aside></li></ul></section>
6be0ab6d 655<section class="tsd-panel tsd-member tsd-is-private"><a id="chooseWorkerNode" class="tsd-anchor"></a>
656<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>
657<ul class="tsd-signatures tsd-is-private">
15d6dfaf 658<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 659<li class="tsd-description">
660<div class="tsd-comment tsd-typography"><p>Chooses a worker node for the next task.</p>
6be0ab6d 661<p>The default worker choice strategy uses a round robin algorithm to distribute the tasks.</p>
6c525543 662</div>
f04db52f 663<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The chosen worker node key</p>
15d6dfaf 664
665<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 666<ul>
83924e2a 667<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1170">src/pools/abstract-pool.ts:1170</a></li></ul></aside></li></ul></section>
f04db52f 668<section class="tsd-panel tsd-member tsd-is-protected"><a id="createAndSetupDynamicWorkerNode" class="tsd-anchor"></a>
669<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 670<ul class="tsd-signatures tsd-is-protected">
f04db52f 671<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 672<li class="tsd-description">
f04db52f 673<div class="tsd-comment tsd-typography"><p>Creates a new, completely set up dynamic worker node.</p>
6be0ab6d 674</div>
f04db52f 675<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 676
677<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
678<ul>
83924e2a 679<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1260">src/pools/abstract-pool.ts:1260</a></li></ul></aside></li></ul></section>
f04db52f 680<section class="tsd-panel tsd-member tsd-is-protected"><a id="createAndSetupWorkerNode" class="tsd-anchor"></a>
681<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 682<ul class="tsd-signatures tsd-is-protected">
f04db52f 683<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 684<li class="tsd-description">
f04db52f 685<div class="tsd-comment tsd-typography"><p>Creates a new, completely set up worker node.</p>
6c525543 686</div>
f04db52f 687<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>New, completely set up worker node key.</p>
15d6dfaf 688
689<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 690<ul>
83924e2a 691<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1216">src/pools/abstract-pool.ts:1216</a></li></ul></aside></li></ul></section>
3bd6a82e 692<section class="tsd-panel tsd-member tsd-is-protected"><a id="createWorker" class="tsd-anchor"></a>
15d6dfaf 693<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 694<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 695<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 696<li class="tsd-description">
6be0ab6d 697<div class="tsd-comment tsd-typography"><p>Creates a new worker.</p>
6c525543 698</div>
6be0ab6d 699<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></h4><p>Newly created worker.</p>
700
15d6dfaf 701<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 702<ul>
83924e2a 703<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1209">src/pools/abstract-pool.ts:1209</a></li></ul></aside></li></ul></section>
dbf662af
DB
704<section class="tsd-panel tsd-member tsd-is-private"><a id="deleteTaskFunctionWorkerUsages" class="tsd-anchor"></a>
705<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>delete<wbr/>Task<wbr/>Function<wbr/>Worker<wbr/>Usages</span><a href="#deleteTaskFunctionWorkerUsages" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
706<ul class="tsd-signatures tsd-is-private">
707<li class="tsd-signature tsd-anchor-link" id="deleteTaskFunctionWorkerUsages.deleteTaskFunctionWorkerUsages-1"><span class="tsd-kind-call-signature">delete<wbr/>Task<wbr/>Function<wbr/>Worker<wbr/>Usages</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#deleteTaskFunctionWorkerUsages.deleteTaskFunctionWorkerUsages-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
708<li class="tsd-description">
709<div class="tsd-parameters">
710<h4 class="tsd-parameters-title">Parameters</h4>
711<ul class="tsd-parameter-list">
712<li>
713<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
714<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
715<ul>
83924e2a 716<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L864">src/pools/abstract-pool.ts:864</a></li></ul></aside></li></ul></section>
3bd6a82e 717<section class="tsd-panel tsd-member tsd-is-private"><a id="dequeueTask" class="tsd-anchor"></a>
15d6dfaf 718<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 719<ul class="tsd-signatures tsd-is-private">
15d6dfaf 720<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 721<li class="tsd-description">
722<div class="tsd-parameters">
723<h4 class="tsd-parameters-title">Parameters</h4>
724<ul class="tsd-parameter-list">
725<li>
3bd6a82e 726<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
8d1797ad 727<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 728<ul>
83924e2a 729<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1688">src/pools/abstract-pool.ts:1688</a></li></ul></aside></li></ul></section>
51e49c70
DB
730<section class="tsd-panel tsd-member tsd-is-protected"><a id="deregisterWorkerMessageListener" class="tsd-anchor"></a>
731<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>deregister<wbr/>Worker<wbr/>Message<wbr/>Listener</span><a href="#deregisterWorkerMessageListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
732<ul class="tsd-signatures tsd-is-protected">
733<li class="tsd-signature tsd-anchor-link" id="deregisterWorkerMessageListener.deregisterWorkerMessageListener-1"><span class="tsd-kind-call-signature">deregister<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="#deregisterWorkerMessageListener.deregisterWorkerMessageListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
734<li class="tsd-description">
735<div class="tsd-comment tsd-typography"><p>Deregisters a listener callback on the worker given its worker node key.</p>
736</div>
737<section class="tsd-panel">
738<h4>Type Parameters</h4>
739<ul class="tsd-type-parameter-list">
740<li>
741<h4><span class="tsd-kind-type-parameter">Message</span></h4></li></ul></section>
742<div class="tsd-parameters">
743<h4 class="tsd-parameters-title">Parameters</h4>
744<ul class="tsd-parameter-list">
745<li>
746<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
747<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
748</div>
749<div class="tsd-comment tsd-typography"></div></li>
750<li>
751<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>
752<div class="tsd-comment tsd-typography"><p>The message listener callback.</p>
753</div>
754<div class="tsd-comment tsd-typography"></div>
755<ul class="tsd-parameters">
756<li class="tsd-parameter-signature">
757<ul class="tsd-signatures">
758<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>
759<li class="tsd-description">
760<div class="tsd-parameters">
761<h4 class="tsd-parameters-title">Parameters</h4>
762<ul class="tsd-parameter-list">
763<li>
764<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>
765<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
766<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
767<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
768<ul>
83924e2a 769<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1343">src/pools/abstract-pool.ts:1343</a></li></ul></aside></li></ul></section>
3bd6a82e 770<section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a>
15d6dfaf 771<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 772<ul class="tsd-signatures">
15d6dfaf 773<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 774<li class="tsd-description">
f04db52f 775<div class="tsd-comment tsd-typography"><p>Terminates all workers in this pool.</p>
6c525543 776</div>
15d6dfaf 777<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>
778<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 779<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#destroy">destroy</a></p>
6c525543 780<ul>
83924e2a 781<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L949">src/pools/abstract-pool.ts:949</a></li></ul></aside></li></ul></section>
f04db52f 782<section class="tsd-panel tsd-member tsd-is-protected"><a id="destroyWorkerNode" class="tsd-anchor"></a>
783<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 784<ul class="tsd-signatures tsd-is-protected">
f04db52f 785<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 786<li class="tsd-description">
f04db52f 787<div class="tsd-comment tsd-typography"><p>Terminates the worker node given its worker node key.</p>
6c525543 788</div>
789<div class="tsd-parameters">
790<h4 class="tsd-parameters-title">Parameters</h4>
791<ul class="tsd-parameter-list">
792<li>
f04db52f 793<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
794<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 795</div>
796<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 797<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 798<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 799<ul>
83924e2a 800<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L989">src/pools/abstract-pool.ts:989</a></li></ul></aside></li></ul></section>
3bd6a82e 801<section class="tsd-panel tsd-member"><a id="enableTasksQueue" class="tsd-anchor"></a>
15d6dfaf 802<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 803<ul class="tsd-signatures">
15d6dfaf 804<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 805<li class="tsd-description">
31542ddf 806<div class="tsd-comment tsd-typography"><p>Enables/disables the worker node tasks queue in this pool.</p>
6047493a 807</div>
808<div class="tsd-parameters">
809<h4 class="tsd-parameters-title">Parameters</h4>
810<ul class="tsd-parameter-list">
811<li>
3bd6a82e 812<h5><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></h5>
31542ddf 813<div class="tsd-comment tsd-typography"><p>Whether to enable or disable the worker node tasks queue.</p>
cb4889b4 814</div>
815<div class="tsd-comment tsd-typography"></div></li>
6047493a 816<li>
8d1797ad 817<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5>
31542ddf 818<div class="tsd-comment tsd-typography"><p>The worker node tasks queue options.</p>
cb4889b4 819</div>
820<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 821<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
822<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 823<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#enableTasksQueue">enableTasksQueue</a></p>
6047493a 824<ul>
83924e2a 825<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L564">src/pools/abstract-pool.ts:564</a></li></ul></aside></li></ul></section>
3bd6a82e 826<section class="tsd-panel tsd-member tsd-is-private"><a id="enqueueTask" class="tsd-anchor"></a>
15d6dfaf 827<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 828<ul class="tsd-signatures tsd-is-private">
15d6dfaf 829<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 830<li class="tsd-description">
831<div class="tsd-parameters">
832<h4 class="tsd-parameters-title">Parameters</h4>
833<ul class="tsd-parameter-list">
834<li>
3bd6a82e 835<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li>
6c525543 836<li>
8d1797ad 837<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 838<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
839<ul>
83924e2a 840<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1682">src/pools/abstract-pool.ts:1682</a></li></ul></aside></li></ul></section>
3bd6a82e 841<section class="tsd-panel tsd-member"><a id="execute" class="tsd-anchor"></a>
15d6dfaf 842<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 843<ul class="tsd-signatures">
2447ee8c 844<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 845<li class="tsd-description">
1bb559f9 846<div class="tsd-comment tsd-typography"><p>Executes the specified function in the worker constructor with the task data input parameter.</p>
6c525543 847</div>
848<div class="tsd-parameters">
849<h4 class="tsd-parameters-title">Parameters</h4>
850<ul class="tsd-parameter-list">
851<li>
3bd6a82e 852<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 853<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>
cb4889b4 854</div>
855<div class="tsd-comment tsd-typography"></div></li>
2c94c3a5 856<li>
857<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 858<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>
cb4889b4 859</div>
860<div class="tsd-comment tsd-typography"></div></li>
2447ee8c 861<li>
862<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>
863<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>
cb4889b4 864</div>
865<div class="tsd-comment tsd-typography"></div></li></ul></div>
fab6d3b5 866<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 867
868<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 869<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#execute">execute</a></p>
6c525543 870<ul>
83924e2a 871<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L879">src/pools/abstract-pool.ts:879</a></li></ul></aside></li></ul></section>
3bd6a82e 872<section class="tsd-panel tsd-member tsd-is-private"><a id="executeTask" class="tsd-anchor"></a>
15d6dfaf 873<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 874<ul class="tsd-signatures tsd-is-private">
15d6dfaf 875<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 876<li class="tsd-description">
f04db52f 877<div class="tsd-comment tsd-typography"><p>Executes the given task on the worker given its worker node key.</p>
7b88db4b 878</div>
6c525543 879<div class="tsd-parameters">
880<h4 class="tsd-parameters-title">Parameters</h4>
881<ul class="tsd-parameter-list">
882<li>
f04db52f 883<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
884<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 885</div>
886<div class="tsd-comment tsd-typography"></div></li>
6c525543 887<li>
7b88db4b 888<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>
889<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
cb4889b4 890</div>
891<div class="tsd-comment tsd-typography"></div></li></ul></div>
7b88db4b 892<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
893<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 894<ul>
83924e2a 895<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1676">src/pools/abstract-pool.ts:1676</a></li></ul></aside></li></ul></section>
fc09c6dc
DB
896<section class="tsd-panel tsd-member tsd-is-protected"><a id="flagWorkerNodeAsNotReady" class="tsd-anchor"></a>
897<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>flag<wbr/>Worker<wbr/>Node<wbr/>As<wbr/>Not<wbr/>Ready</span><a href="#flagWorkerNodeAsNotReady" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
898<ul class="tsd-signatures tsd-is-protected">
899<li class="tsd-signature tsd-anchor-link" id="flagWorkerNodeAsNotReady.flagWorkerNodeAsNotReady-1"><span class="tsd-kind-call-signature">flag<wbr/>Worker<wbr/>Node<wbr/>As<wbr/>Not<wbr/>Ready</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="#flagWorkerNodeAsNotReady.flagWorkerNodeAsNotReady-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
900<li class="tsd-description">
901<div class="tsd-parameters">
902<h4 class="tsd-parameters-title">Parameters</h4>
903<ul class="tsd-parameter-list">
904<li>
905<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
906<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
907<ul>
83924e2a 908<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1649">src/pools/abstract-pool.ts:1649</a></li></ul></aside></li></ul></section>
f04db52f 909<section class="tsd-panel tsd-member tsd-is-protected"><a id="flushTasksQueue" class="tsd-anchor"></a>
910<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>
911<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 912<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 913<li class="tsd-description">
914<div class="tsd-parameters">
915<h4 class="tsd-parameters-title">Parameters</h4>
916<ul class="tsd-parameter-list">
917<li>
3bd6a82e 918<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
6c525543 919<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
920<ul>
83924e2a 921<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1696">src/pools/abstract-pool.ts:1696</a></li></ul></aside></li></ul></section>
3bd6a82e 922<section class="tsd-panel tsd-member tsd-is-private"><a id="flushTasksQueues" class="tsd-anchor"></a>
15d6dfaf 923<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 924<ul class="tsd-signatures tsd-is-private">
15d6dfaf 925<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 926<li class="tsd-description">
927<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
928<ul>
83924e2a 929<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1706">src/pools/abstract-pool.ts:1706</a></li></ul></aside></li></ul></section>
f04db52f 930<section class="tsd-panel tsd-member tsd-is-protected"><a id="getWorkerInfo" class="tsd-anchor"></a>
931<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>
932<ul class="tsd-signatures tsd-is-protected">
95d287d1 933<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>
912e1dfa 934<li class="tsd-description">
f04db52f 935<div class="tsd-comment tsd-typography"><p>Gets the worker information given its worker node key.</p>
912e1dfa 936</div>
937<div class="tsd-parameters">
938<h4 class="tsd-parameters-title">Parameters</h4>
939<ul class="tsd-parameter-list">
940<li>
941<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
942<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 943</div>
944<div class="tsd-comment tsd-typography"></div></li></ul></div>
95d287d1 945<h4 class="tsd-returns-title">Returns <a href="../interfaces/WorkerInfo.html" class="tsd-signature-type tsd-kind-interface">WorkerInfo</a></h4><p>The worker information.</p>
76b46937 946
912e1dfa 947<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
948<ul>
83924e2a 949<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1608">src/pools/abstract-pool.ts:1608</a></li></ul></aside></li></ul></section>
f04db52f 950<section class="tsd-panel tsd-member tsd-is-private"><a id="getWorkerNodeKeyByWorker" class="tsd-anchor"></a>
951<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>
952<ul class="tsd-signatures tsd-is-private">
953<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 954<li class="tsd-description">
f04db52f 955<div class="tsd-comment tsd-typography"><p>Gets the given worker its worker node key.</p>
76b46937 956</div>
957<div class="tsd-parameters">
958<h4 class="tsd-parameters-title">Parameters</h4>
959<ul class="tsd-parameter-list">
960<li>
961<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></h5>
962<div class="tsd-comment tsd-typography"><p>The worker.</p>
cb4889b4 963</div>
964<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 965<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 966
f04db52f 967<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
76b46937 968<ul>
83924e2a 969<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L512">src/pools/abstract-pool.ts:512</a></li></ul></aside></li></ul></section>
f04db52f 970<section class="tsd-panel tsd-member tsd-is-private"><a id="getWorkerNodeKeyByWorkerId" class="tsd-anchor"></a>
971<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>
972<ul class="tsd-signatures tsd-is-private">
973<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 974<li class="tsd-description">
f04db52f 975<div class="tsd-comment tsd-typography"><p>Gets the worker node key given its worker id.</p>
6c525543 976</div>
977<div class="tsd-parameters">
978<h4 class="tsd-parameters-title">Parameters</h4>
979<ul class="tsd-parameter-list">
980<li>
dbf662af 981<h5><span class="tsd-kind-parameter">workerId</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
f04db52f 982<div class="tsd-comment tsd-typography"><p>The worker id.</p>
cb4889b4 983</div>
984<div class="tsd-comment tsd-typography"></div></li></ul></div>
f04db52f 985<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 986
987<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 988<ul>
83924e2a 989<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L524">src/pools/abstract-pool.ts:524</a></li></ul></aside></li></ul></section>
80048093
DB
990<section class="tsd-panel tsd-member tsd-is-private"><a id="handleBackPressureEvent" class="tsd-anchor"></a>
991<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>handle<wbr/>Back<wbr/>Pressure<wbr/>Event</span><a href="#handleBackPressureEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
992<ul class="tsd-signatures tsd-is-private">
993<li class="tsd-signature tsd-anchor-link" id="handleBackPressureEvent.handleBackPressureEvent-1"><span class="tsd-kind-call-signature">handle<wbr/>Back<wbr/>Pressure<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#handleBackPressureEvent.handleBackPressureEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
994<li class="tsd-description">
995<div class="tsd-parameters">
996<h4 class="tsd-parameters-title">Parameters</h4>
997<ul class="tsd-parameter-list">
998<li>
87f3b549 999<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type ">CustomEvent</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/WorkerNodeEventDetail.html" class="tsd-signature-type tsd-kind-interface">WorkerNodeEventDetail</a><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
80048093
DB
1000<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1001<ul>
83924e2a 1002<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1478">src/pools/abstract-pool.ts:1478</a></li></ul></aside></li></ul></section>
80048093
DB
1003<section class="tsd-panel tsd-member tsd-is-private"><a id="handleEmptyQueueEvent" class="tsd-anchor"></a>
1004<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>handle<wbr/>Empty<wbr/>Queue<wbr/>Event</span><a href="#handleEmptyQueueEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1005<ul class="tsd-signatures tsd-is-private">
1006<li class="tsd-signature tsd-anchor-link" id="handleEmptyQueueEvent.handleEmptyQueueEvent-1"><span class="tsd-kind-call-signature">handle<wbr/>Empty<wbr/>Queue<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#handleEmptyQueueEvent.handleEmptyQueueEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1007<li class="tsd-description">
1008<div class="tsd-parameters">
1009<h4 class="tsd-parameters-title">Parameters</h4>
1010<ul class="tsd-parameter-list">
1011<li>
87f3b549 1012<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type ">CustomEvent</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/WorkerNodeEventDetail.html" class="tsd-signature-type tsd-kind-interface">WorkerNodeEventDetail</a><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
80048093
DB
1013<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1014<ul>
83924e2a 1015<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1446">src/pools/abstract-pool.ts:1446</a></li></ul></aside></li></ul></section>
202bcb6b 1016<section class="tsd-panel tsd-member tsd-is-private"><a id="handleTaskExecutionResponse" class="tsd-anchor"></a>
1017<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>
1018<ul class="tsd-signatures tsd-is-private">
1019<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>
1020<li class="tsd-description">
1021<div class="tsd-parameters">
1022<h4 class="tsd-parameters-title">Parameters</h4>
1023<ul class="tsd-parameter-list">
1024<li>
1025<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>
1026<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1027<ul>
83924e2a 1028<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1554">src/pools/abstract-pool.ts:1554</a></li></ul></aside></li></ul></section>
79f98bd9 1029<section class="tsd-panel tsd-member tsd-is-private"><a id="handleWorkerReadyResponse" class="tsd-anchor"></a>
1030<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 1031<ul class="tsd-signatures tsd-is-private">
79f98bd9 1032<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 1033<li class="tsd-description">
1034<div class="tsd-parameters">
1035<h4 class="tsd-parameters-title">Parameters</h4>
1036<ul class="tsd-parameter-list">
1037<li>
1038<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>
1039<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1040<ul>
83924e2a 1041<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1534">src/pools/abstract-pool.ts:1534</a></li></ul></aside></li></ul></section>
c22b117f 1042<section class="tsd-panel tsd-member tsd-is-private"><a id="hasBackPressure" class="tsd-anchor"></a>
1043<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>has<wbr/>Back<wbr/>Pressure</span><a href="#hasBackPressure" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1044<ul class="tsd-signatures tsd-is-private">
1045<li class="tsd-signature tsd-anchor-link" id="hasBackPressure.hasBackPressure-1"><span class="tsd-kind-call-signature">has<wbr/>Back<wbr/>Pressure</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="#hasBackPressure.hasBackPressure-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1046<li class="tsd-description">
1047<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
1048<ul>
83924e2a 1049<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1661">src/pools/abstract-pool.ts:1661</a></li></ul></aside></li></ul></section>
dbf662af
DB
1050<section class="tsd-panel tsd-member"><a id="hasTaskFunction" class="tsd-anchor"></a>
1051<h3 class="tsd-anchor-link"><span>has<wbr/>Task<wbr/>Function</span><a href="#hasTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1052<ul class="tsd-signatures">
1053<li class="tsd-signature tsd-anchor-link" id="hasTaskFunction.hasTaskFunction-1"><span class="tsd-kind-call-signature">has<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasTaskFunction.hasTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1054<li class="tsd-description">
1055<div class="tsd-comment tsd-typography"><p>Whether the specified task function exists in this pool.</p>
1056</div>
1057<div class="tsd-parameters">
1058<h4 class="tsd-parameters-title">Parameters</h4>
1059<ul class="tsd-parameter-list">
1060<li>
1061<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
1062<div class="tsd-comment tsd-typography"><p>The name of the task function.</p>
1063</div>
1064<div class="tsd-comment tsd-typography"></div></li></ul></div>
1065<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the task function exists, <code>false</code> otherwise.</p>
1066
1067<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1068<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#hasTaskFunction">hasTaskFunction</a></p>
1069<ul>
83924e2a 1070<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L792">src/pools/abstract-pool.ts:792</a></li></ul></aside></li></ul></section>
c22b117f 1071<section class="tsd-panel tsd-member"><a id="hasWorkerNodeBackPressure" class="tsd-anchor"></a>
1072<h3 class="tsd-anchor-link"><span>has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span><a href="#hasWorkerNodeBackPressure" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1073<ul class="tsd-signatures">
1074<li class="tsd-signature tsd-anchor-link" id="hasWorkerNodeBackPressure.hasWorkerNodeBackPressure-1"><span class="tsd-kind-call-signature">has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasWorkerNodeBackPressure.hasWorkerNodeBackPressure-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1075<li class="tsd-description"><code class="tsd-tag ts-flagInternal">Internal</code>
1076<div class="tsd-comment tsd-typography"><p>Whether the worker node has back pressure (i.e. its tasks queue is full).</p>
1077</div>
1078<div class="tsd-parameters">
1079<h4 class="tsd-parameters-title">Parameters</h4>
1080<ul class="tsd-parameter-list">
1081<li>
1082<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1083<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 1084</div>
1085<div class="tsd-comment tsd-typography"></div></li></ul></div>
c22b117f 1086<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the worker node has back pressure, <code>false</code> otherwise.</p>
1087
1088<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1089<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#hasWorkerNodeBackPressure">hasWorkerNodeBackPressure</a></p>
1090<ul>
83924e2a 1091<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1654">src/pools/abstract-pool.ts:1654</a></li></ul></aside></li></ul></section>
48c6ba05
DB
1092<section class="tsd-panel tsd-member tsd-is-private"><a id="initializeEventEmitter" class="tsd-anchor"></a>
1093<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>initialize<wbr/>Event<wbr/>Emitter</span><a href="#initializeEventEmitter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1094<ul class="tsd-signatures tsd-is-private">
1095<li class="tsd-signature tsd-anchor-link" id="initializeEventEmitter.initializeEventEmitter-1"><span class="tsd-kind-call-signature">initialize<wbr/>Event<wbr/>Emitter</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="#initializeEventEmitter.initializeEventEmitter-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1096<li class="tsd-description">
1097<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1098<ul>
83924e2a 1099<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L266">src/pools/abstract-pool.ts:266</a></li></ul></aside></li></ul></section>
3bd6a82e 1100<section class="tsd-panel tsd-member tsd-is-protected"><a id="internalBusy" class="tsd-anchor"></a>
15d6dfaf 1101<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 1102<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 1103<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 1104<li class="tsd-description">
f4ff239c 1105<div class="tsd-comment tsd-typography"><p>Whether worker nodes are executing concurrently their tasks quota or not.</p>
6be0ab6d 1106</div>
1107<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Worker nodes busyness boolean status.</p>
1108
1109<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1110<ul>
83924e2a 1111<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L676">src/pools/abstract-pool.ts:676</a></li></ul></aside></li></ul></section>
3bd6a82e 1112<section class="tsd-panel tsd-member tsd-is-protected"><a id="isMain" class="tsd-anchor"></a>
15d6dfaf 1113<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 1114<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 1115<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 1116<li class="tsd-description">
1117<div class="tsd-comment tsd-typography"><p>Should return whether the worker is the main worker or not.</p>
1118</div>
15d6dfaf 1119<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
1120<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1121<ul>
83924e2a 1122<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1004">src/pools/abstract-pool.ts:1004</a></li></ul></aside></li></ul></section>
dbf662af
DB
1123<section class="tsd-panel tsd-member"><a id="listTaskFunctionNames" class="tsd-anchor"></a>
1124<h3 class="tsd-anchor-link"><span>list<wbr/>Task<wbr/>Function<wbr/>Names</span><a href="#listTaskFunctionNames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
013a4697 1125<ul class="tsd-signatures">
dbf662af 1126<li class="tsd-signature tsd-anchor-link" id="listTaskFunctionNames.listTaskFunctionNames-1"><span class="tsd-kind-call-signature">list<wbr/>Task<wbr/>Function<wbr/>Names</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="#listTaskFunctionNames.listTaskFunctionNames-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
013a4697 1127<li class="tsd-description">
1128<div class="tsd-comment tsd-typography"><p>Lists the names of task function available in this pool.</p>
1129</div>
1130<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>
1131
1132<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
dbf662af 1133<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#listTaskFunctionNames">listTaskFunctionNames</a></p>
013a4697 1134<ul>
83924e2a 1135<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L844">src/pools/abstract-pool.ts:844</a></li></ul></aside></li></ul></section>
912e1dfa 1136<section class="tsd-panel tsd-member tsd-is-private"><a id="redistributeQueuedTasks" class="tsd-anchor"></a>
1137<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>
1138<ul class="tsd-signatures tsd-is-private">
7b88db4b 1139<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 1140<li class="tsd-description">
1141<div class="tsd-parameters">
1142<h4 class="tsd-parameters-title">Parameters</h4>
1143<ul class="tsd-parameter-list">
1144<li>
7b88db4b 1145<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
912e1dfa 1146<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1147<ul>
83924e2a 1148<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1406">src/pools/abstract-pool.ts:1406</a></li></ul></aside></li></ul></section>
51e49c70
DB
1149<section class="tsd-panel tsd-member tsd-is-protected"><a id="registerOnceWorkerMessageListener" class="tsd-anchor"></a>
1150<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>register<wbr/>Once<wbr/>Worker<wbr/>Message<wbr/>Listener</span><a href="#registerOnceWorkerMessageListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1151<ul class="tsd-signatures tsd-is-protected">
1152<li class="tsd-signature tsd-anchor-link" id="registerOnceWorkerMessageListener.registerOnceWorkerMessageListener-1"><span class="tsd-kind-call-signature">register<wbr/>Once<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="#registerOnceWorkerMessageListener.registerOnceWorkerMessageListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1153<li class="tsd-description">
1154<div class="tsd-comment tsd-typography"><p>Registers once a listener callback on the worker given its worker node key.</p>
1155</div>
1156<section class="tsd-panel">
1157<h4>Type Parameters</h4>
1158<ul class="tsd-type-parameter-list">
1159<li>
1160<h4><span class="tsd-kind-type-parameter">Message</span></h4></li></ul></section>
1161<div class="tsd-parameters">
1162<h4 class="tsd-parameters-title">Parameters</h4>
1163<ul class="tsd-parameter-list">
1164<li>
1165<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1166<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
1167</div>
1168<div class="tsd-comment tsd-typography"></div></li>
1169<li>
1170<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>
1171<div class="tsd-comment tsd-typography"><p>The message listener callback.</p>
1172</div>
1173<div class="tsd-comment tsd-typography"></div>
1174<ul class="tsd-parameters">
1175<li class="tsd-parameter-signature">
1176<ul class="tsd-signatures">
1177<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>
1178<li class="tsd-description">
1179<div class="tsd-parameters">
1180<h4 class="tsd-parameters-title">Parameters</h4>
1181<ul class="tsd-parameter-list">
1182<li>
1183<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>
1184<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
1185<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1186<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1187<ul>
83924e2a 1188<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1330">src/pools/abstract-pool.ts:1330</a></li></ul></aside></li></ul></section>
76b46937 1189<section class="tsd-panel tsd-member tsd-is-protected"><a id="registerWorkerMessageListener" class="tsd-anchor"></a>
1190<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>
1191<ul class="tsd-signatures tsd-is-protected">
f04db52f 1192<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 1193<li class="tsd-description">
f04db52f 1194<div class="tsd-comment tsd-typography"><p>Registers a listener callback on the worker given its worker node key.</p>
6c525543 1195</div>
fab6d3b5 1196<section class="tsd-panel">
6c525543 1197<h4>Type Parameters</h4>
fab6d3b5 1198<ul class="tsd-type-parameter-list">
6c525543 1199<li>
3bd6a82e 1200<h4><span class="tsd-kind-type-parameter">Message</span></h4></li></ul></section>
6c525543 1201<div class="tsd-parameters">
1202<h4 class="tsd-parameters-title">Parameters</h4>
1203<ul class="tsd-parameter-list">
1204<li>
f04db52f 1205<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1206<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 1207</div>
1208<div class="tsd-comment tsd-typography"></div></li>
6c525543 1209<li>
3bd6a82e 1210<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 1211<div class="tsd-comment tsd-typography"><p>The message listener callback.</p>
1212</div>
cb4889b4 1213<div class="tsd-comment tsd-typography"></div>
6c525543 1214<ul class="tsd-parameters">
1215<li class="tsd-parameter-signature">
3bd6a82e 1216<ul class="tsd-signatures">
1217<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 1218<li class="tsd-description">
1219<div class="tsd-parameters">
1220<h4 class="tsd-parameters-title">Parameters</h4>
1221<ul class="tsd-parameter-list">
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">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 1224<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
15d6dfaf 1225<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1226<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1227<ul>
83924e2a 1228<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1317">src/pools/abstract-pool.ts:1317</a></li></ul></aside></li></ul></section>
dbf662af
DB
1229<section class="tsd-panel tsd-member"><a id="removeTaskFunction" class="tsd-anchor"></a>
1230<h3 class="tsd-anchor-link"><span>remove<wbr/>Task<wbr/>Function</span><a href="#removeTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1231<ul class="tsd-signatures">
1232<li class="tsd-signature tsd-anchor-link" id="removeTaskFunction.removeTaskFunction-1"><span class="tsd-kind-call-signature">remove<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#removeTaskFunction.removeTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1233<li class="tsd-description">
1234<div class="tsd-comment tsd-typography"><p>Removes a task function from this pool.</p>
1235</div>
1236<div class="tsd-parameters">
1237<h4 class="tsd-parameters-title">Parameters</h4>
1238<ul class="tsd-parameter-list">
1239<li>
1240<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
1241<div class="tsd-comment tsd-typography"><p>The name of the task function.</p>
1242</div>
1243<div class="tsd-comment tsd-typography"></div></li></ul></div>
1244<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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p><code>true</code> if the task function was removed, <code>false</code> otherwise.</p>
1245
1246<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1247<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#removeTaskFunction">removeTaskFunction</a></p>
1248<ul>
83924e2a 1249<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L828">src/pools/abstract-pool.ts:828</a></li></ul></aside></li></ul></section>
3bd6a82e 1250<section class="tsd-panel tsd-member tsd-is-private"><a id="removeWorkerNode" class="tsd-anchor"></a>
15d6dfaf 1251<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 1252<ul class="tsd-signatures tsd-is-private">
15d6dfaf 1253<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 1254<li class="tsd-description">
1255<div class="tsd-comment tsd-typography"><p>Removes the given worker from the pool worker nodes.</p>
1256</div>
1257<div class="tsd-parameters">
1258<h4 class="tsd-parameters-title">Parameters</h4>
1259<ul class="tsd-parameter-list">
1260<li>
3bd6a82e 1261<h5><span class="tsd-kind-parameter">worker</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></h5>
6c525543 1262<div class="tsd-comment tsd-typography"><p>The worker.</p>
cb4889b4 1263</div>
1264<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 1265<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1266<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1267<ul>
83924e2a 1268<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1641">src/pools/abstract-pool.ts:1641</a></li></ul></aside></li></ul></section>
013a4697 1269<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendKillMessageToWorker" class="tsd-anchor"></a>
1270<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>
1271<ul class="tsd-signatures tsd-is-protected">
dbf662af 1272<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-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>
013a4697 1273<li class="tsd-description">
1274<div class="tsd-parameters">
1275<h4 class="tsd-parameters-title">Parameters</h4>
1276<ul class="tsd-parameter-list">
1277<li>
dbf662af 1278<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
013a4697 1279<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">
1280<ul>
83924e2a 1281<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L960">src/pools/abstract-pool.ts:960</a></li></ul></aside></li></ul></section>
76b46937 1282<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendStartupMessageToWorker" class="tsd-anchor"></a>
1283<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>
1284<ul class="tsd-signatures tsd-is-protected">
f04db52f 1285<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 1286<li class="tsd-description">
f04db52f 1287<div class="tsd-comment tsd-typography"><p>Sends the startup message to worker given its worker node key.</p>
76b46937 1288</div>
1289<div class="tsd-parameters">
1290<h4 class="tsd-parameters-title">Parameters</h4>
1291<ul class="tsd-parameter-list">
1292<li>
f04db52f 1293<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1294<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 1295</div>
1296<div class="tsd-comment tsd-typography"></div></li></ul></div>
76b46937 1297<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1298<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1299<ul>
83924e2a 1300<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1387">src/pools/abstract-pool.ts:1387</a></li></ul></aside></li></ul></section>
013a4697 1301<section class="tsd-panel tsd-member tsd-is-private"><a id="sendStatisticsMessageToWorker" class="tsd-anchor"></a>
1302<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>
1303<ul class="tsd-signatures tsd-is-private">
1304<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>
1305<li class="tsd-description">
1306<div class="tsd-comment tsd-typography"><p>Sends the statistics message to worker given its worker node key.</p>
1307</div>
1308<div class="tsd-parameters">
1309<h4 class="tsd-parameters-title">Parameters</h4>
1310<ul class="tsd-parameter-list">
1311<li>
1312<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1313<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 1314</div>
1315<div class="tsd-comment tsd-typography"></div></li></ul></div>
013a4697 1316<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1317<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1318<ul>
83924e2a 1319<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1394">src/pools/abstract-pool.ts:1394</a></li></ul></aside></li></ul></section>
dbf662af
DB
1320<section class="tsd-panel tsd-member tsd-is-private"><a id="sendTaskFunctionOperationToWorker" class="tsd-anchor"></a>
1321<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>send<wbr/>Task<wbr/>Function<wbr/>Operation<wbr/>To<wbr/>Worker</span><a href="#sendTaskFunctionOperationToWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1322<ul class="tsd-signatures tsd-is-private">
1323<li class="tsd-signature tsd-anchor-link" id="sendTaskFunctionOperationToWorker.sendTaskFunctionOperationToWorker-1"><span class="tsd-kind-call-signature">send<wbr/>Task<wbr/>Function<wbr/>Operation<wbr/>To<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendTaskFunctionOperationToWorker.sendTaskFunctionOperationToWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1324<li class="tsd-description">
1325<div class="tsd-parameters">
1326<h4 class="tsd-parameters-title">Parameters</h4>
1327<ul class="tsd-parameter-list">
1328<li>
1329<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li>
1330<li>
1331<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></li></ul></div>
1332<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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
1333<ul>
83924e2a 1334<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L695">src/pools/abstract-pool.ts:695</a></li></ul></aside></li></ul></section>
dbf662af
DB
1335<section class="tsd-panel tsd-member tsd-is-private"><a id="sendTaskFunctionOperationToWorkers" class="tsd-anchor"></a>
1336<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>send<wbr/>Task<wbr/>Function<wbr/>Operation<wbr/>To<wbr/>Workers</span><a href="#sendTaskFunctionOperationToWorkers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1337<ul class="tsd-signatures tsd-is-private">
1338<li class="tsd-signature tsd-anchor-link" id="sendTaskFunctionOperationToWorkers.sendTaskFunctionOperationToWorkers-1"><span class="tsd-kind-call-signature">send<wbr/>Task<wbr/>Function<wbr/>Operation<wbr/>To<wbr/>Workers</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 ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendTaskFunctionOperationToWorkers.sendTaskFunctionOperationToWorkers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1339<li class="tsd-description">
1340<div class="tsd-parameters">
1341<h4 class="tsd-parameters-title">Parameters</h4>
1342<ul class="tsd-parameter-list">
1343<li>
1344<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></li></ul></div>
1345<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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
1346<ul>
83924e2a 1347<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L736">src/pools/abstract-pool.ts:736</a></li></ul></aside></li></ul></section>
3bd6a82e 1348<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendToWorker" class="tsd-anchor"></a>
15d6dfaf 1349<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 1350<ul class="tsd-signatures tsd-is-protected">
2447ee8c 1351<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 1352<li class="tsd-description">
f04db52f 1353<div class="tsd-comment tsd-typography"><p>Sends a message to worker given its worker node key.</p>
6c525543 1354</div>
1355<div class="tsd-parameters">
1356<h4 class="tsd-parameters-title">Parameters</h4>
1357<ul class="tsd-parameter-list">
1358<li>
f04db52f 1359<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1360<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 1361</div>
1362<div class="tsd-comment tsd-typography"></div></li>
6c525543 1363<li>
030eb5a3 1364<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 1365<div class="tsd-comment tsd-typography"><p>The message.</p>
cb4889b4 1366</div>
1367<div class="tsd-comment tsd-typography"></div></li>
2447ee8c 1368<li>
1369<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>
1370<div class="tsd-comment tsd-typography"><p>The optional array of transferable objects.</p>
cb4889b4 1371</div>
1372<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 1373<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1374<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1375<ul>
83924e2a 1376<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1198">src/pools/abstract-pool.ts:1198</a></li></ul></aside></li></ul></section>
dbf662af
DB
1377<section class="tsd-panel tsd-member"><a id="setDefaultTaskFunction" class="tsd-anchor"></a>
1378<h3 class="tsd-anchor-link"><span>set<wbr/>Default<wbr/>Task<wbr/>Function</span><a href="#setDefaultTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1379<ul class="tsd-signatures">
1380<li class="tsd-signature tsd-anchor-link" id="setDefaultTaskFunction.setDefaultTaskFunction-1"><span class="tsd-kind-call-signature">set<wbr/>Default<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><a href="#setDefaultTaskFunction.setDefaultTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1381<li class="tsd-description">
1382<div class="tsd-comment tsd-typography"><p>Sets the default task function in this pool.</p>
1383</div>
1384<div class="tsd-parameters">
1385<h4 class="tsd-parameters-title">Parameters</h4>
1386<ul class="tsd-parameter-list">
1387<li>
1388<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
1389<div class="tsd-comment tsd-typography"><p>The name of the task function.</p>
1390</div>
1391<div class="tsd-comment tsd-typography"></div></li></ul></div>
1392<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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p><code>true</code> if the default task function was set, <code>false</code> otherwise.</p>
1393
1394<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1395<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#setDefaultTaskFunction">setDefaultTaskFunction</a></p>
1396<ul>
83924e2a 1397<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L857">src/pools/abstract-pool.ts:857</a></li></ul></aside></li></ul></section>
717e9363 1398<section class="tsd-panel tsd-member tsd-is-private"><a id="setTaskStealing" class="tsd-anchor"></a>
1399<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>set<wbr/>Task<wbr/>Stealing</span><a href="#setTaskStealing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1400<ul class="tsd-signatures tsd-is-private">
1401<li class="tsd-signature tsd-anchor-link" id="setTaskStealing.setTaskStealing-1"><span class="tsd-kind-call-signature">set<wbr/>Task<wbr/>Stealing</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="#setTaskStealing.setTaskStealing-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1402<li class="tsd-description">
1403<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1404<ul>
83924e2a 1405<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L619">src/pools/abstract-pool.ts:619</a></li></ul></aside></li></ul></section>
3bd6a82e 1406<section class="tsd-panel tsd-member"><a id="setTasksQueueOptions" class="tsd-anchor"></a>
15d6dfaf 1407<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 1408<ul class="tsd-signatures">
15d6dfaf 1409<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 1410<li class="tsd-description">
31542ddf 1411<div class="tsd-comment tsd-typography"><p>Sets the worker node tasks queue options in this pool.</p>
6047493a 1412</div>
1413<div class="tsd-parameters">
1414<h4 class="tsd-parameters-title">Parameters</h4>
1415<ul class="tsd-parameter-list">
1416<li>
8d1797ad 1417<h5><span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5>
31542ddf 1418<div class="tsd-comment tsd-typography"><p>The worker node tasks queue options.</p>
cb4889b4 1419</div>
1420<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 1421<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1422<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 1423<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#setTasksQueueOptions">setTasksQueueOptions</a></p>
6047493a 1424<ul>
83924e2a 1425<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L578">src/pools/abstract-pool.ts:578</a></li></ul></aside></li></ul></section>
c8a9d171 1426<section class="tsd-panel tsd-member tsd-is-private"><a id="setTasksQueueSize" class="tsd-anchor"></a>
1427<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>set<wbr/>Tasks<wbr/>Queue<wbr/>Size</span><a href="#setTasksQueueSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1428<ul class="tsd-signatures tsd-is-private">
1429<li class="tsd-signature tsd-anchor-link" id="setTasksQueueSize.setTasksQueueSize-1"><span class="tsd-kind-call-signature">set<wbr/>Tasks<wbr/>Queue<wbr/>Size</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">size</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setTasksQueueSize.setTasksQueueSize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1430<li class="tsd-description">
1431<div class="tsd-parameters">
1432<h4 class="tsd-parameters-title">Parameters</h4>
1433<ul class="tsd-parameter-list">
1434<li>
1435<h5><span class="tsd-kind-parameter">size</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
1436<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1437<ul>
83924e2a 1438<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L613">src/pools/abstract-pool.ts:613</a></li></ul></aside></li></ul></section>
717e9363 1439<section class="tsd-panel tsd-member tsd-is-private"><a id="setTasksStealingOnBackPressure" class="tsd-anchor"></a>
1440<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>set<wbr/>Tasks<wbr/>Stealing<wbr/>On<wbr/>Back<wbr/>Pressure</span><a href="#setTasksStealingOnBackPressure" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1441<ul class="tsd-signatures tsd-is-private">
1442<li class="tsd-signature tsd-anchor-link" id="setTasksStealingOnBackPressure.setTasksStealingOnBackPressure-1"><span class="tsd-kind-call-signature">set<wbr/>Tasks<wbr/>Stealing<wbr/>On<wbr/>Back<wbr/>Pressure</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="#setTasksStealingOnBackPressure.setTasksStealingOnBackPressure-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1443<li class="tsd-description">
1444<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1445<ul>
83924e2a 1446<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L637">src/pools/abstract-pool.ts:637</a></li></ul></aside></li></ul></section>
3bd6a82e 1447<section class="tsd-panel tsd-member"><a id="setWorkerChoiceStrategy" class="tsd-anchor"></a>
15d6dfaf 1448<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 1449<ul class="tsd-signatures">
15d6dfaf 1450<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 1451<li class="tsd-description">
1452<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy in this pool.</p>
1453</div>
1454<div class="tsd-parameters">
1455<h4 class="tsd-parameters-title">Parameters</h4>
1456<ul class="tsd-parameter-list">
1457<li>
f05afd16 1458<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 1459<div class="tsd-comment tsd-typography"><p>The worker choice strategy.</p>
cb4889b4 1460</div>
1461<div class="tsd-comment tsd-typography"></div></li>
a8aeac44 1462<li>
8d1797ad 1463<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 1464<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
cb4889b4 1465</div>
1466<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 1467<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1468<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 1469<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#setWorkerChoiceStrategy">setWorkerChoiceStrategy</a></p>
6c525543 1470<ul>
83924e2a 1471<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L531">src/pools/abstract-pool.ts:531</a></li></ul></aside></li></ul></section>
3bd6a82e 1472<section class="tsd-panel tsd-member"><a id="setWorkerChoiceStrategyOptions" class="tsd-anchor"></a>
15d6dfaf 1473<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 1474<ul class="tsd-signatures">
15d6dfaf 1475<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 1476<li class="tsd-description">
1477<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy options in this pool.</p>
1478</div>
1479<div class="tsd-parameters">
1480<h4 class="tsd-parameters-title">Parameters</h4>
1481<ul class="tsd-parameter-list">
1482<li>
8d1797ad 1483<h5><span class="tsd-kind-parameter">workerChoiceStrategyOptions</span>: <a href="../interfaces/WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></h5>
6047493a 1484<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
cb4889b4 1485</div>
1486<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 1487<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1488<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3bd6a82e 1489<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#setWorkerChoiceStrategyOptions">setWorkerChoiceStrategyOptions</a></p>
6047493a 1490<ul>
83924e2a 1491<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L550">src/pools/abstract-pool.ts:550</a></li></ul></aside></li></ul></section>
3bd6a82e 1492<section class="tsd-panel tsd-member tsd-is-protected"><a id="setupHook" class="tsd-anchor"></a>
15d6dfaf 1493<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 1494<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 1495<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 1496<li class="tsd-description">
030eb5a3 1497<div class="tsd-comment tsd-typography"><p>Setup hook to execute code before worker nodes are created in the abstract constructor.
1498Can be overridden.</p>
6c525543 1499</div>
15d6dfaf 1500<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1501<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1502<ul>
83924e2a 1503<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L997">src/pools/abstract-pool.ts:997</a></li></ul></aside></li></ul></section>
6be0ab6d 1504<section class="tsd-panel tsd-member tsd-is-private"><a id="shallCreateDynamicWorker" class="tsd-anchor"></a>
1505<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>
1506<ul class="tsd-signatures tsd-is-private">
1507<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>
1508<li class="tsd-description">
1509<div class="tsd-comment tsd-typography"><p>Conditions for dynamic worker creation.</p>
1510</div>
1511<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether to create a dynamic worker or not.</p>
1512
1513<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1514<ul>
83924e2a 1515<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1187">src/pools/abstract-pool.ts:1187</a></li></ul></aside></li></ul></section>
7ab352a6 1516<section class="tsd-panel tsd-member tsd-is-private"><a id="shallExecuteTask" class="tsd-anchor"></a>
1517<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>shall<wbr/>Execute<wbr/>Task</span><a href="#shallExecuteTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1518<ul class="tsd-signatures tsd-is-private">
1519<li class="tsd-signature tsd-anchor-link" id="shallExecuteTask.shallExecuteTask-1"><span class="tsd-kind-call-signature">shall<wbr/>Execute<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">boolean</span><a href="#shallExecuteTask.shallExecuteTask-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1520<li class="tsd-description">
1521<div class="tsd-parameters">
1522<h4 class="tsd-parameters-title">Parameters</h4>
1523<ul class="tsd-parameter-list">
1524<li>
1525<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
1526<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
1527<ul>
83924e2a 1528<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L870">src/pools/abstract-pool.ts:870</a></li></ul></aside></li></ul></section>
c22b117f 1529<section class="tsd-panel tsd-member tsd-is-private"><a id="shallUpdateTaskFunctionWorkerUsage" class="tsd-anchor"></a>
1530<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>shall<wbr/>Update<wbr/>Task<wbr/>Function<wbr/>Worker<wbr/>Usage</span><a href="#shallUpdateTaskFunctionWorkerUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1531<ul class="tsd-signatures tsd-is-private">
1532<li class="tsd-signature tsd-anchor-link" id="shallUpdateTaskFunctionWorkerUsage.shallUpdateTaskFunctionWorkerUsage-1"><span class="tsd-kind-call-signature">shall<wbr/>Update<wbr/>Task<wbr/>Function<wbr/>Worker<wbr/>Usage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#shallUpdateTaskFunctionWorkerUsage.shallUpdateTaskFunctionWorkerUsage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1533<li class="tsd-description">
1534<div class="tsd-comment tsd-typography"><p>Whether the worker node shall update its task function worker usage or not.</p>
1535</div>
1536<div class="tsd-parameters">
1537<h4 class="tsd-parameters-title">Parameters</h4>
1538<ul class="tsd-parameter-list">
1539<li>
1540<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
1541<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 1542</div>
1543<div class="tsd-comment tsd-typography"></div></li></ul></div>
c22b117f 1544<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p><code>true</code> if the worker node shall update its task function worker usage, <code>false</code> otherwise.</p>
1545
1546<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1547<ul>
83924e2a 1548<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1076">src/pools/abstract-pool.ts:1076</a></li></ul></aside></li></ul></section>
0b4e655c 1549<section class="tsd-panel tsd-member"><a id="start" class="tsd-anchor"></a>
1550<h3 class="tsd-anchor-link"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1551<ul class="tsd-signatures">
1552<li class="tsd-signature tsd-anchor-link" id="start.start-1"><span class="tsd-kind-call-signature">start</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="#start.start-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
177be4a6 1553<li class="tsd-description">
0b4e655c 1554<div class="tsd-comment tsd-typography"><p>Starts the minimum number of workers in this pool.</p>
1555</div>
1556<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1557<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1558<p>Implementation of <a href="../interfaces/IPool.html">IPool</a>.<a href="../interfaces/IPool.html#start">start</a></p>
177be4a6 1559<ul>
83924e2a 1560<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L933">src/pools/abstract-pool.ts:933</a></li></ul></aside></li></ul></section>
3bd6a82e 1561<section class="tsd-panel tsd-member tsd-is-private"><a id="tasksQueueSize" class="tsd-anchor"></a>
15d6dfaf 1562<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 1563<ul class="tsd-signatures tsd-is-private">
15d6dfaf 1564<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 1565<li class="tsd-description">
1566<div class="tsd-parameters">
1567<h4 class="tsd-parameters-title">Parameters</h4>
1568<ul class="tsd-parameter-list">
1569<li>
3bd6a82e 1570<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
6c525543 1571<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
1572<ul>
83924e2a 1573<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1692">src/pools/abstract-pool.ts:1692</a></li></ul></aside></li></ul></section>
717e9363 1574<section class="tsd-panel tsd-member tsd-is-private"><a id="unsetTaskStealing" class="tsd-anchor"></a>
1575<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>unset<wbr/>Task<wbr/>Stealing</span><a href="#unsetTaskStealing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1576<ul class="tsd-signatures tsd-is-private">
1577<li class="tsd-signature tsd-anchor-link" id="unsetTaskStealing.unsetTaskStealing-1"><span class="tsd-kind-call-signature">unset<wbr/>Task<wbr/>Stealing</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="#unsetTaskStealing.unsetTaskStealing-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1578<li class="tsd-description">
1579<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1580<ul>
83924e2a 1581<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L628">src/pools/abstract-pool.ts:628</a></li></ul></aside></li></ul></section>
717e9363 1582<section class="tsd-panel tsd-member tsd-is-private"><a id="unsetTasksStealingOnBackPressure" class="tsd-anchor"></a>
1583<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>unset<wbr/>Tasks<wbr/>Stealing<wbr/>On<wbr/>Back<wbr/>Pressure</span><a href="#unsetTasksStealingOnBackPressure" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1584<ul class="tsd-signatures tsd-is-private">
1585<li class="tsd-signature tsd-anchor-link" id="unsetTasksStealingOnBackPressure.unsetTasksStealingOnBackPressure-1"><span class="tsd-kind-call-signature">unset<wbr/>Tasks<wbr/>Stealing<wbr/>On<wbr/>Back<wbr/>Pressure</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="#unsetTasksStealingOnBackPressure.unsetTasksStealingOnBackPressure-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1586<li class="tsd-description">
1587<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1588<ul>
83924e2a 1589<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L646">src/pools/abstract-pool.ts:646</a></li></ul></aside></li></ul></section>
f05afd16 1590<section class="tsd-panel tsd-member tsd-is-private"><a id="updateEluWorkerUsage" class="tsd-anchor"></a>
1591<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 1592<ul class="tsd-signatures tsd-is-private">
f05afd16 1593<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 1594<li class="tsd-description">
1595<div class="tsd-parameters">
1596<h4 class="tsd-parameters-title">Parameters</h4>
1597<ul class="tsd-parameter-list">
1598<li>
f05afd16 1599<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 1600<li>
030eb5a3 1601<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 1602<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1603<ul>
83924e2a 1604<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1130">src/pools/abstract-pool.ts:1130</a></li></ul></aside></li></ul></section>
f05afd16 1605<section class="tsd-panel tsd-member tsd-is-private"><a id="updateRunTimeWorkerUsage" class="tsd-anchor"></a>
1606<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 1607<ul class="tsd-signatures tsd-is-private">
f05afd16 1608<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 1609<li class="tsd-description">
1610<div class="tsd-parameters">
1611<h4 class="tsd-parameters-title">Parameters</h4>
1612<ul class="tsd-parameter-list">
1613<li>
f05afd16 1614<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 1615<li>
030eb5a3 1616<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 1617<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1618<ul>
83924e2a 1619<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1103">src/pools/abstract-pool.ts:1103</a></li></ul></aside></li></ul></section>
aac8863d 1620<section class="tsd-panel tsd-member tsd-is-private"><a id="updateTaskStatisticsWorkerUsage" class="tsd-anchor"></a>
1621<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>
1622<ul class="tsd-signatures tsd-is-private">
1623<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>
1624<li class="tsd-description">
1625<div class="tsd-parameters">
1626<h4 class="tsd-parameters-title">Parameters</h4>
1627<ul class="tsd-parameter-list">
1628<li>
1629<h5><span class="tsd-kind-parameter">workerUsage</span>: <a href="../interfaces/WorkerUsage.html" class="tsd-signature-type tsd-kind-interface">WorkerUsage</a></h5></li>
1630<li>
030eb5a3 1631<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 1632<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1633<ul>
83924e2a 1634<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1085">src/pools/abstract-pool.ts:1085</a></li></ul></aside></li></ul></section>
7ab352a6 1635<section class="tsd-panel tsd-member tsd-is-private"><a id="updateTaskStolenStatisticsWorkerUsage" class="tsd-anchor"></a>
1636<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>update<wbr/>Task<wbr/>Stolen<wbr/>Statistics<wbr/>Worker<wbr/>Usage</span><a href="#updateTaskStolenStatisticsWorkerUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
1637<ul class="tsd-signatures tsd-is-private">
1638<li class="tsd-signature tsd-anchor-link" id="updateTaskStolenStatisticsWorkerUsage.updateTaskStolenStatisticsWorkerUsage-1"><span class="tsd-kind-call-signature">update<wbr/>Task<wbr/>Stolen<wbr/>Statistics<wbr/>Worker<wbr/>Usage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span>, <span class="tsd-kind-parameter">taskName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#updateTaskStolenStatisticsWorkerUsage.updateTaskStolenStatisticsWorkerUsage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
1639<li class="tsd-description">
1640<div class="tsd-parameters">
1641<h4 class="tsd-parameters-title">Parameters</h4>
1642<ul class="tsd-parameter-list">
1643<li>
1644<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li>
1645<li>
1646<h5><span class="tsd-kind-parameter">taskName</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
1647<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1648<ul>
83924e2a 1649<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1427">src/pools/abstract-pool.ts:1427</a></li></ul></aside></li></ul></section>
f05afd16 1650<section class="tsd-panel tsd-member tsd-is-private"><a id="updateWaitTimeWorkerUsage" class="tsd-anchor"></a>
1651<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 1652<ul class="tsd-signatures tsd-is-private">
f05afd16 1653<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 1654<li class="tsd-description">
1655<div class="tsd-parameters">
1656<h4 class="tsd-parameters-title">Parameters</h4>
1657<ul class="tsd-parameter-list">
1658<li>
f05afd16 1659<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 1660<li>
f05afd16 1661<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 1662<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1663<ul>
83924e2a 1664<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1117">src/pools/abstract-pool.ts:1117</a></li></ul></aside></li></ul></section>
d5c35d0e
DB
1665<section class="tsd-panel tsd-member tsd-is-protected"><a id="workerMessageListener" class="tsd-anchor"></a>
1666<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>worker<wbr/>Message<wbr/>Listener</span><a href="#workerMessageListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 1667<ul class="tsd-signatures tsd-is-protected">
d5c35d0e 1668<li class="tsd-signature tsd-anchor-link" id="workerMessageListener.workerMessageListener-1"><span class="tsd-kind-call-signature">worker<wbr/>Message<wbr/>Listener</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="#workerMessageListener.workerMessageListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 1669<li class="tsd-description">
d5c35d0e 1670<div class="tsd-comment tsd-typography"><p>This method is the message listener registered on each worker.</p>
6c525543 1671</div>
1672<div class="tsd-parameters">
1673<h4 class="tsd-parameters-title">Parameters</h4>
1674<ul class="tsd-parameter-list">
1675<li>
030eb5a3 1676<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>
d5c35d0e 1677<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
15d6dfaf 1678<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1679<ul>
83924e2a 1680<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5aa31a7/src/pools/abstract-pool.ts#L1518">src/pools/abstract-pool.ts:1518</a></li></ul></aside></li></ul></section></section></div>
6c525543 1681<div class="col-sidebar">
1682<div class="page-menu">
1683<div class="tsd-navigation settings">
1684<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
cb4889b4 1685<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary>
6c525543 1686<div class="tsd-accordion-details">
1687<div class="tsd-filter-visibility">
1688<h4 class="uppercase">Member Visibility</h4><form>
1689<ul id="tsd-filter-options">
d5c35d0e
DB
1690<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>
1691<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>
1692<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>
1693<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>
6c525543 1694<div class="tsd-theme-toggle">
3bd6a82e 1695<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 1696<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 1697<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 1698<div class="tsd-accordion-details">
1699<ul>
15d6dfaf 1700<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>
1701<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>
1702<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>
00471704 1703<li><a href="#max" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max</span></a></li>
15d6dfaf 1704<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>
1705<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>
1706<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 1707<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>
31542ddf 1708<li><a href="#started" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>started</span></a></li>
44b95861 1709<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>
dbf662af 1710<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 1711<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>
1712<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>
1713<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>
1714<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>
1715<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>
1716<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>
1717<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 1718<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 1719<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 1720<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 1721<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>
dbf662af 1722<li><a href="#addTaskFunction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Task<wbr/>Function</span></a></li>
7b88db4b 1723<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 1724<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 1725<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 1726<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>
1727<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>
00471704 1728<li><a href="#checkAndEmitDynamicWorkerCreationEvents" 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/>Dynamic<wbr/>Worker<wbr/>Creation<wbr/>Events</span></a></li>
1729<li><a href="#checkAndEmitTaskExecutionEvents" 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/>Task<wbr/>Execution<wbr/>Events</span></a></li>
1730<li><a href="#checkAndEmitTaskQueuingEvents" 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/>Task<wbr/>Queuing<wbr/>Events</span></a></li>
47c9cec4 1731<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 1732<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>
1733<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>
15d6dfaf 1734<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 1735<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 1736<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>
1737<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 1738<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>
dbf662af 1739<li><a href="#deleteTaskFunctionWorkerUsages" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Task<wbr/>Function<wbr/>Worker<wbr/>Usages</span></a></li>
15d6dfaf 1740<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>
51e49c70 1741<li><a href="#deregisterWorkerMessageListener" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>deregister<wbr/>Worker<wbr/>Message<wbr/>Listener</span></a></li>
15d6dfaf 1742<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 1743<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 1744<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>
1745<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>
1746<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>
1747<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>
fc09c6dc 1748<li><a href="#flagWorkerNodeAsNotReady" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flag<wbr/>Worker<wbr/>Node<wbr/>As<wbr/>Not<wbr/>Ready</span></a></li>
f04db52f 1749<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 1750<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 1751<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>
1752<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>
1753<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>
80048093
DB
1754<li><a href="#handleBackPressureEvent" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Back<wbr/>Pressure<wbr/>Event</span></a></li>
1755<li><a href="#handleEmptyQueueEvent" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Empty<wbr/>Queue<wbr/>Event</span></a></li>
202bcb6b 1756<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 1757<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>
c22b117f 1758<li><a href="#hasBackPressure" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Back<wbr/>Pressure</span></a></li>
dbf662af 1759<li><a href="#hasTaskFunction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Task<wbr/>Function</span></a></li>
c22b117f 1760<li><a href="#hasWorkerNodeBackPressure" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span></a></li>
48c6ba05 1761<li><a href="#initializeEventEmitter" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>initialize<wbr/>Event<wbr/>Emitter</span></a></li>
15d6dfaf 1762<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>
1763<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>
dbf662af 1764<li><a href="#listTaskFunctionNames" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Task<wbr/>Function<wbr/>Names</span></a></li>
912e1dfa 1765<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>
51e49c70 1766<li><a href="#registerOnceWorkerMessageListener" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Once<wbr/>Worker<wbr/>Message<wbr/>Listener</span></a></li>
76b46937 1767<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>
dbf662af 1768<li><a href="#removeTaskFunction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Task<wbr/>Function</span></a></li>
15d6dfaf 1769<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 1770<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 1771<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 1772<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>
dbf662af
DB
1773<li><a href="#sendTaskFunctionOperationToWorker" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Task<wbr/>Function<wbr/>Operation<wbr/>To<wbr/>Worker</span></a></li>
1774<li><a href="#sendTaskFunctionOperationToWorkers" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Task<wbr/>Function<wbr/>Operation<wbr/>To<wbr/>Workers</span></a></li>
15d6dfaf 1775<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>
dbf662af 1776<li><a href="#setDefaultTaskFunction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Task<wbr/>Function</span></a></li>
717e9363 1777<li><a href="#setTaskStealing" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Task<wbr/>Stealing</span></a></li>
15d6dfaf 1778<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>
c8a9d171 1779<li><a href="#setTasksQueueSize" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Tasks<wbr/>Queue<wbr/>Size</span></a></li>
717e9363 1780<li><a href="#setTasksStealingOnBackPressure" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Tasks<wbr/>Stealing<wbr/>On<wbr/>Back<wbr/>Pressure</span></a></li>
15d6dfaf 1781<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>
1782<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 1783<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 1784<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>
7ab352a6 1785<li><a href="#shallExecuteTask" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>shall<wbr/>Execute<wbr/>Task</span></a></li>
c22b117f 1786<li><a href="#shallUpdateTaskFunctionWorkerUsage" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>shall<wbr/>Update<wbr/>Task<wbr/>Function<wbr/>Worker<wbr/>Usage</span></a></li>
0b4e655c 1787<li><a href="#start" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>start</span></a></li>
15d6dfaf 1788<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>
717e9363 1789<li><a href="#unsetTaskStealing" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unset<wbr/>Task<wbr/>Stealing</span></a></li>
1790<li><a href="#unsetTasksStealingOnBackPressure" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unset<wbr/>Tasks<wbr/>Stealing<wbr/>On<wbr/>Back<wbr/>Pressure</span></a></li>
f05afd16 1791<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>
1792<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 1793<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>
7ab352a6 1794<li><a href="#updateTaskStolenStatisticsWorkerUsage" 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/>Stolen<wbr/>Statistics<wbr/>Worker<wbr/>Usage</span></a></li>
f05afd16 1795<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>
d5c35d0e 1796<li><a href="#workerMessageListener" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>worker<wbr/>Message<wbr/>Listener</span></a></li></ul></div></details></div>
6c525543 1797<div class="site-menu">
83924e2a 1798<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>poolifier - v3.0.5</span></a>
cb4889b4 1799<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
1800<li><a href="AbstractPool.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AbstractPool</a></li>
1801<li><a href="AbstractWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AbstractWorker</a></li>
1802<li><a href="CircularArray.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>CircularArray</a></li>
1803<li><a href="ClusterWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ClusterWorker</a></li>
1804<li><a href="Deque.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Deque</a></li>
1805<li><a href="DynamicClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>DynamicClusterPool</a></li>
1806<li><a href="DynamicThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>DynamicThreadPool</a></li>
1807<li><a href="FixedClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>FixedClusterPool</a></li>
1808<li><a href="FixedThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>FixedThreadPool</a></li>
1809<li><a href="Node.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Node</a></li>
cb4889b4 1810<li><a href="ThreadWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ThreadWorker</a></li>
1811<li><a href="WorkerChoiceStrategyContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>WorkerChoiceStrategyContext</a></li>
1812<li><a href="../interfaces/ClusterPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ClusterPoolOptions</a></li>
1813<li><a href="../interfaces/EventLoopUtilizationMeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EventLoopUtilizationMeasurementStatistics</a></li>
1814<li><a href="../interfaces/IPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IPool</a></li>
1815<li><a href="../interfaces/IWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IWorker</a></li>
1816<li><a href="../interfaces/IWorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IWorkerChoiceStrategy</a></li>
1817<li><a href="../interfaces/IWorkerNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IWorkerNode</a></li>
1818<li><a href="../interfaces/MeasurementOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MeasurementOptions</a></li>
1819<li><a href="../interfaces/MeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MeasurementStatistics</a></li>
48c6ba05 1820<li><a href="../interfaces/MeasurementStatisticsRequirements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MeasurementStatisticsRequirements</a></li>
cb4889b4 1821<li>Loading...</li></ul></nav></div></div></div>
6c525543 1822<div class="tsd-generator">
323daa7f 1823<p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
d5c35d0e 1824<div class="overlay"></div><svg style="display: none"><g id="icon-1"><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><g id="icon-2"><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><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><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g><g id="icon-16"><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><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><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><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><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><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><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><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><g id="icon-4096"><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><g id="icon-8192"><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><g id="icon-16384"><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><g id="icon-32768"><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><g id="icon-65536"><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><g id="icon-131072"><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><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><g id="icon-524288"><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><g id="icon-1048576"><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><g id="icon-2097152"><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><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)"></path></g><g id="icon-chevronDown"><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)"></path></g><g id="icon-chevronSmall"><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></g><g id="icon-menu"><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></g><g id="icon-search"><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></g><g id="icon-anchor"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><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></g></svg></body></html>