docs: generate documentation
[poolifier.git] / docs / classes / FixedThreadPool.html
CommitLineData
d93988cd 1<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FixedThreadPool | poolifier - v2.7.4</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">
a76fac14
JB
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>
41015374
JB
5<div class="field">
6<div id="tsd-toolbar-links"></div></div>
a76fac14
JB
7<ul class="results">
8<li class="state loading">Preparing search index...</li>
d93988cd 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.7.4</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>
a76fac14 11<div class="container container-main">
ec06e4dd 12<div class="col-content">
a76fac14
JB
13<div class="tsd-page-title">
14<ul class="tsd-breadcrumb">
15<li><a href="../index.html">poolifier</a></li>
16<li><a href="FixedThreadPool.html">FixedThreadPool</a></li></ul>
17<h1>Class FixedThreadPool&lt;Data, Response&gt;</h1></div>
18<section class="tsd-panel tsd-comment">
19<div class="tsd-comment tsd-typography"><p>A thread pool with a fixed number of threads.</p>
15d6dfaf 20</div>
21<div class="tsd-comment tsd-typography">
22<h4>Author</h4><p><a href="https://github.com/pioardi">Alessandro Pio Ardizio</a></p>
a76fac14 23
15d6dfaf 24<h4>Since</h4><p>0.0.1</p>
a76fac14 25</div></section>
fab6d3b5 26<section class="tsd-panel">
a76fac14 27<h4>Type Parameters</h4>
fab6d3b5 28<ul class="tsd-type-parameter-list">
a76fac14 29<li>
3bd6a82e 30<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 31<div class="tsd-comment tsd-typography"><p>Type of data sent to the worker. This can only be structured-cloneable data.</p>
15d6dfaf 32</div>
33<div class="tsd-comment tsd-typography"></div></li>
a76fac14 34<li>
3bd6a82e 35<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 36<div class="tsd-comment tsd-typography"><p>Type of execution response. This can only be structured-cloneable data.</p>
15d6dfaf 37</div>
38<div class="tsd-comment tsd-typography"></div></li></ul></section>
a76fac14
JB
39<section class="tsd-panel tsd-hierarchy">
40<h4>Hierarchy</h4>
41<ul class="tsd-hierarchy">
030eb5a3 42<li><a href="AbstractPool.html" class="tsd-signature-type tsd-kind-class">AbstractPool</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span>
a76fac14
JB
43<ul class="tsd-hierarchy">
44<li><span class="target">FixedThreadPool</span>
45<ul class="tsd-hierarchy">
8d1797ad 46<li><a href="DynamicThreadPool.html" class="tsd-signature-type tsd-kind-class">DynamicThreadPool</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
a76fac14 47<ul>
d93988cd 48<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L35">src/pools/thread/fixed.ts:35</a></li></ul></aside>
a76fac14
JB
49<section class="tsd-panel-group tsd-index-group">
50<section class="tsd-panel tsd-index-panel">
51<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
cb4889b4 52<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary>
a76fac14
JB
53<div class="tsd-accordion-details">
54<section class="tsd-index-section">
55<h3 class="tsd-index-heading">Constructors</h3>
cb4889b4 56<div class="tsd-index-list"><a href="FixedThreadPool.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
a76fac14
JB
57</div></section>
58<section class="tsd-index-section">
59<h3 class="tsd-index-heading">Properties</h3>
cb4889b4 60<div class="tsd-index-list"><a href="FixedThreadPool.html#emitter" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>emitter?</span></a>
15d6dfaf 61<a href="FixedThreadPool.html#filePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>file<wbr/>Path</span></a>
00471704 62<a href="FixedThreadPool.html#max" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max?</span></a>
15d6dfaf 63<a href="FixedThreadPool.html#numberOfWorkers" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>number<wbr/>Of<wbr/>Workers</span></a>
64<a href="FixedThreadPool.html#opts" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>opts</span></a>
65<a href="FixedThreadPool.html#promiseResponseMap" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>promise<wbr/>Response<wbr/>Map</span></a>
66<a href="FixedThreadPool.html#workerChoiceStrategyContext" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span></a>
67<a href="FixedThreadPool.html#workerNodes" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Nodes</span></a>
a76fac14
JB
68</div></section>
69<section class="tsd-index-section">
70<h3 class="tsd-index-heading">Accessors</h3>
cb4889b4 71<div class="tsd-index-list"><a href="FixedThreadPool.html#busy" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>busy</span></a>
15d6dfaf 72<a href="FixedThreadPool.html#full" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>full</span></a>
73<a href="FixedThreadPool.html#info" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>info</span></a>
00471704 74<a href="FixedThreadPool.html#maxSize" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>max<wbr/>Size</span></a>
75<a href="FixedThreadPool.html#minSize" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>min<wbr/>Size</span></a>
c914a50e 76<a href="FixedThreadPool.html#ready" class="tsd-index-link tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>ready</span></a>
15d6dfaf 77<a href="FixedThreadPool.html#type" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>type</span></a>
202bcb6b 78<a href="FixedThreadPool.html#utilization" class="tsd-index-link tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>utilization</span></a>
15d6dfaf 79<a href="FixedThreadPool.html#worker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>worker</span></a>
a76fac14
JB
80</div></section>
81<section class="tsd-index-section">
82<h3 class="tsd-index-heading">Methods</h3>
dbf662af
DB
83<div class="tsd-index-list"><a href="FixedThreadPool.html#addTaskFunction" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Task<wbr/>Function</span></a>
84<a href="FixedThreadPool.html#afterTaskExecutionHook" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>after<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a>
f04db52f 85<a href="FixedThreadPool.html#afterWorkerNodeSetup" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>after<wbr/>Worker<wbr/>Node<wbr/>Setup</span></a>
15d6dfaf 86<a href="FixedThreadPool.html#beforeTaskExecutionHook" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>before<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a>
f04db52f 87<a href="FixedThreadPool.html#createAndSetupDynamicWorkerNode" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>And<wbr/>Setup<wbr/>Dynamic<wbr/>Worker<wbr/>Node</span></a>
88<a href="FixedThreadPool.html#createAndSetupWorkerNode" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>And<wbr/>Setup<wbr/>Worker<wbr/>Node</span></a>
15d6dfaf 89<a href="FixedThreadPool.html#createWorker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Worker</span></a>
51e49c70 90<a href="FixedThreadPool.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 91<a href="FixedThreadPool.html#destroy" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a>
f04db52f 92<a href="FixedThreadPool.html#destroyWorkerNode" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy<wbr/>Worker<wbr/>Node</span></a>
15d6dfaf 93<a href="FixedThreadPool.html#enableTasksQueue" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enable<wbr/>Tasks<wbr/>Queue</span></a>
94<a href="FixedThreadPool.html#execute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>execute</span></a>
f04db52f 95<a href="FixedThreadPool.html#flushTasksQueue" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flush<wbr/>Tasks<wbr/>Queue</span></a>
96<a href="FixedThreadPool.html#getWorkerInfo" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Worker<wbr/>Info</span></a>
dbf662af 97<a href="FixedThreadPool.html#hasTaskFunction" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Task<wbr/>Function</span></a>
c22b117f 98<a href="FixedThreadPool.html#hasWorkerNodeBackPressure" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span></a>
15d6dfaf 99<a href="FixedThreadPool.html#internalBusy" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>internal<wbr/>Busy</span></a>
100<a href="FixedThreadPool.html#isMain" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Main</span></a>
dbf662af 101<a href="FixedThreadPool.html#listTaskFunctionNames" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Task<wbr/>Function<wbr/>Names</span></a>
51e49c70 102<a href="FixedThreadPool.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 103<a href="FixedThreadPool.html#registerWorkerMessageListener" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Worker<wbr/>Message<wbr/>Listener</span></a>
dbf662af 104<a href="FixedThreadPool.html#removeTaskFunction" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Task<wbr/>Function</span></a>
013a4697 105<a href="FixedThreadPool.html#sendKillMessageToWorker" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Kill<wbr/>Message<wbr/>To<wbr/>Worker</span></a>
76b46937 106<a href="FixedThreadPool.html#sendStartupMessageToWorker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Startup<wbr/>Message<wbr/>To<wbr/>Worker</span></a>
15d6dfaf 107<a href="FixedThreadPool.html#sendToWorker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>To<wbr/>Worker</span></a>
dbf662af 108<a href="FixedThreadPool.html#setDefaultTaskFunction" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Task<wbr/>Function</span></a>
15d6dfaf 109<a href="FixedThreadPool.html#setTasksQueueOptions" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Tasks<wbr/>Queue<wbr/>Options</span></a>
110<a href="FixedThreadPool.html#setWorkerChoiceStrategy" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span></a>
111<a href="FixedThreadPool.html#setWorkerChoiceStrategyOptions" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a>
112<a href="FixedThreadPool.html#setupHook" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>setup<wbr/>Hook</span></a>
0b4e655c 113<a href="FixedThreadPool.html#start" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>start</span></a>
15d6dfaf 114<a href="FixedThreadPool.html#workerListener" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>worker<wbr/>Listener</span></a>
a76fac14
JB
115</div></section></div></details></section></section>
116<section class="tsd-panel-group tsd-member-group">
117<h2>Constructors</h2>
3bd6a82e 118<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
cb4889b4 119<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 120<ul class="tsd-signatures">
15d6dfaf 121<li class="tsd-signature tsd-anchor-link" id="constructor.new_FixedThreadPool"><span class="tsd-kind-constructor-signature">new <wbr/>Fixed<wbr/>Thread<wbr/>Pool</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">numberOfThreads</span>, <span class="tsd-kind-parameter">filePath</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FixedThreadPool.html" class="tsd-signature-type tsd-kind-class">FixedThreadPool</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_FixedThreadPool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14
JB
122<li class="tsd-description">
123<div class="tsd-comment tsd-typography"><p>Constructs a new poolifier fixed thread pool.</p>
124</div>
fab6d3b5 125<section class="tsd-panel">
a76fac14 126<h4>Type Parameters</h4>
fab6d3b5 127<ul class="tsd-type-parameter-list">
a76fac14 128<li>
3bd6a82e 129<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4></li>
a76fac14 130<li>
3bd6a82e 131<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section>
a76fac14
JB
132<div class="tsd-parameters">
133<h4 class="tsd-parameters-title">Parameters</h4>
134<ul class="tsd-parameter-list">
135<li>
3bd6a82e 136<h5><span class="tsd-kind-parameter">numberOfThreads</span>: <span class="tsd-signature-type">number</span></h5>
a76fac14 137<div class="tsd-comment tsd-typography"><p>Number of threads for this pool.</p>
cb4889b4 138</div>
139<div class="tsd-comment tsd-typography"></div></li>
a76fac14 140<li>
3bd6a82e 141<h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5>
a76fac14 142<div class="tsd-comment tsd-typography"><p>Path to an implementation of a <code>ThreadWorker</code> file, which can be relative or absolute.</p>
cb4889b4 143</div>
144<div class="tsd-comment tsd-typography"></div></li>
a76fac14 145<li>
f45a3823 146<h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/ThreadPoolOptions.html" class="tsd-signature-type tsd-kind-interface">ThreadPoolOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
a76fac14 147<div class="tsd-comment tsd-typography"><p>Options for this fixed thread pool.</p>
cb4889b4 148</div>
149<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 150<h4 class="tsd-returns-title">Returns <a href="FixedThreadPool.html" class="tsd-signature-type tsd-kind-class">FixedThreadPool</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span></h4>
151<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 152<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#constructor">constructor</a></p>
a76fac14 153<ul>
d93988cd 154<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L46">src/pools/thread/fixed.ts:46</a></li></ul></aside></li></ul></section></section>
a76fac14
JB
155<section class="tsd-panel-group tsd-member-group">
156<h2>Properties</h2>
3bd6a82e 157<section class="tsd-panel tsd-member tsd-is-inherited"><a id="emitter" class="tsd-anchor"></a>
48c6ba05
DB
158<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>
159<div class="tsd-signature"><span class="tsd-kind-property">emitter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">__module</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">EventEmitterAsyncResource</span></div>
160<div class="tsd-comment tsd-typography"><p>Event emitter integrated with async resource on which events can be listened to.
161The async tracking tooling identifier is <code>poolifier:&lt;PoolType&gt;-&lt;WorkerType&gt;-pool</code>.</p>
6c525543 162<p>Events that can currently be listened to:</p>
a76fac14 163<ul>
85c03385 164<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 165<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 166<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 167<li><code>&#39;destroy&#39;</code>: Emitted when the pool is destroyed.</li>
ccb7d1a7 168<li><code>&#39;error&#39;</code>: Emitted when an uncaught error occurs.</li>
169<li><code>&#39;taskError&#39;</code>: Emitted when an error occurs while executing a task.</li>
31542ddf 170<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 171</ul>
15d6dfaf 172</div>
173<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 174<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#emitter">emitter</a></p>
175<ul>
d93988cd 176<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L73">src/pools/abstract-pool.ts:73</a></li></ul></aside></section>
184d530f 177<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="filePath" class="tsd-anchor"></a>
15d6dfaf 178<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 179<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 180<div class="tsd-comment tsd-typography"><p>Path to the worker file.</p>
15d6dfaf 181</div>
182<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 183<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#filePath">filePath</a></p>
a76fac14 184<ul>
d93988cd 185<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L128">src/pools/abstract-pool.ts:128</a></li></ul></aside></section>
00471704 186<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="max" class="tsd-anchor"></a>
187<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>
188<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>
189<div class="tsd-comment tsd-typography"><p>Dynamic pool maximum size property placeholder.</p>
190</div>
191<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
192<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#max">max</a></p>
193<ul>
d93988cd 194<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L97">src/pools/abstract-pool.ts:97</a></li></ul></aside></section>
184d530f 195<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="numberOfWorkers" class="tsd-anchor"></a>
15d6dfaf 196<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 197<div class="tsd-signature"><span class="tsd-kind-property">number<wbr/>Of<wbr/>Workers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
cfc6e8df 198<div class="tsd-comment tsd-typography"><p>Number of workers that this pool should manage.</p>
15d6dfaf 199</div>
200<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 201<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#numberOfWorkers">numberOfWorkers</a></p>
a76fac14 202<ul>
d93988cd 203<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L127">src/pools/abstract-pool.ts:127</a></li></ul></aside></section>
184d530f 204<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="opts" class="tsd-anchor"></a>
15d6dfaf 205<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>opts</span><a href="#opts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
f45a3823 206<div class="tsd-signature"><span class="tsd-kind-property">opts</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/ThreadPoolOptions.html" class="tsd-signature-type tsd-kind-interface">ThreadPoolOptions</a><span class="tsd-signature-symbol"> = {}</span></div>
207<div class="tsd-comment tsd-typography"><p>Options for this fixed thread pool.</p>
15d6dfaf 208</div>
209<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 210<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#opts">opts</a></p>
a76fac14 211<ul>
d93988cd 212<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L49">src/pools/thread/fixed.ts:49</a></li></ul></aside></section>
3bd6a82e 213<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="promiseResponseMap" class="tsd-anchor"></a>
15d6dfaf 214<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 215<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 216<div class="tsd-comment tsd-typography"><p>The task execution response promise map:</p>
a76fac14 217<ul>
79458fb6 218<li><code>key</code>: The message id of each submitted task.</li>
21402562 219<li><code>value</code>: An object that contains the worker, the execution response promise resolve and reject callbacks.</li>
24c3fcb4 220</ul>
21402562 221<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 222</div>
223<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 224<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#promiseResponseMap">promiseResponseMap</a></p>
a76fac14 225<ul>
d93988cd 226<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L82">src/pools/abstract-pool.ts:82</a></li></ul></aside></section>
3bd6a82e 227<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="workerChoiceStrategyContext" class="tsd-anchor"></a>
15d6dfaf 228<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span><a href="#workerChoiceStrategyContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
030eb5a3 229<div class="tsd-signature"><span class="tsd-kind-property">worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span><span class="tsd-signature-symbol">:</span> <a href="WorkerChoiceStrategyContext.html" class="tsd-signature-type tsd-kind-class">WorkerChoiceStrategyContext</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span></div>
e604957d 230<div class="tsd-comment tsd-typography"><p>Worker choice strategy context referencing a worker choice algorithm implementation.</p>
15d6dfaf 231</div>
232<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 233<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#workerChoiceStrategyContext">workerChoiceStrategyContext</a></p>
a76fac14 234<ul>
d93988cd 235<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L88">src/pools/abstract-pool.ts:88</a></li></ul></aside></section>
3bd6a82e 236<section class="tsd-panel tsd-member tsd-is-inherited"><a id="workerNodes" class="tsd-anchor"></a>
c22b117f 237<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 238<div class="tsd-signature"><span class="tsd-kind-property">worker<wbr/>Nodes</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IWorkerNode.html" class="tsd-signature-type tsd-kind-interface">IWorkerNode</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
6c525543 239<div class="tsd-comment tsd-typography"><p>Pool worker nodes.</p>
15d6dfaf 240</div>
241<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 242<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#workerNodes">workerNodes</a></p>
a76fac14 243<ul>
d93988cd 244<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L70">src/pools/abstract-pool.ts:70</a></li></ul></aside></section></section>
a76fac14
JB
245<section class="tsd-panel-group tsd-member-group">
246<h2>Accessors</h2>
3bd6a82e 247<section class="tsd-panel tsd-member tsd-is-protected"><a id="busy" class="tsd-anchor"></a>
15d6dfaf 248<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>busy</span><a href="#busy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 249<ul class="tsd-signatures tsd-is-protected">
a76fac14
JB
250<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>
251<li class="tsd-description">
6c525543 252<div class="tsd-comment tsd-typography"><p>Whether the pool is busy or not.</p>
253<p>The pool busyness boolean status.</p>
254</div>
15d6dfaf 255<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
256<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
257<p>Overrides AbstractPool.busy</p>
258<ul>
d93988cd 259<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L154">src/pools/thread/fixed.ts:154</a></li></ul></aside></li></ul></section>
184d530f 260<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="full" class="tsd-anchor"></a>
15d6dfaf 261<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>full</span><a href="#full" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
184d530f 262<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
0770fe62 263<li class="tsd-signature" id="full.full-1"><span class="tsd-signature-symbol">get</span> full<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
a76fac14 264<li class="tsd-description">
6c525543 265<div class="tsd-comment tsd-typography"><p>Whether the pool is full or not.</p>
266<p>The pool filling boolean status.</p>
267</div>
15d6dfaf 268<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
269<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
184d530f 270<p>Inherited from AbstractPool.full</p>
0770fe62 271<ul>
d93988cd 272<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L651">src/pools/abstract-pool.ts:651</a></li></ul></aside></li></ul></section>
a2742ce7 273<section class="tsd-panel tsd-member tsd-is-inherited"><a id="info" class="tsd-anchor"></a>
15d6dfaf 274<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 275<ul class="tsd-signatures tsd-is-inherited">
276<li class="tsd-signature" id="info.info-1"><span class="tsd-signature-symbol">get</span> info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/PoolInfo.html" class="tsd-signature-type tsd-kind-interface">PoolInfo</a></li>
ffc8d144 277<li class="tsd-description">
a2742ce7 278<div class="tsd-comment tsd-typography"><p>Pool information.</p>
ffc8d144 279</div>
15d6dfaf 280<h4 class="tsd-returns-title">Returns <a href="../interfaces/PoolInfo.html" class="tsd-signature-type tsd-kind-interface">PoolInfo</a></h4>
281<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a2742ce7 282<p>Inherited from AbstractPool.info</p>
ffc8d144 283<ul>
d93988cd 284<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L271">src/pools/abstract-pool.ts:271</a></li></ul></aside></li></ul></section>
00471704 285<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="maxSize" class="tsd-anchor"></a>
15d6dfaf 286<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>max<wbr/>Size</span><a href="#maxSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
00471704 287<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
a2742ce7 288<li class="tsd-signature" id="maxSize.maxSize-1"><span class="tsd-signature-symbol">get</span> maxSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
0770fe62 289<li class="tsd-description">
f04db52f 290<div class="tsd-comment tsd-typography"><p>The pool maximum size.</p>
0770fe62 291</div>
15d6dfaf 292<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
293<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
00471704 294<p>Inherited from AbstractPool.maxSize</p>
a76fac14 295<ul>
d93988cd 296<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L484">src/pools/abstract-pool.ts:484</a></li></ul></aside></li></ul></section>
00471704 297<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="minSize" class="tsd-anchor"></a>
15d6dfaf 298<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>min<wbr/>Size</span><a href="#minSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
00471704 299<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
a2742ce7 300<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 301<li class="tsd-description">
f04db52f 302<div class="tsd-comment tsd-typography"><p>The pool minimum size.</p>
2c94c3a5 303</div>
15d6dfaf 304<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
305<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
00471704 306<p>Inherited from AbstractPool.minSize</p>
2c94c3a5 307<ul>
d93988cd 308<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L477">src/pools/abstract-pool.ts:477</a></li></ul></aside></li></ul></section>
c914a50e 309<section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="ready" class="tsd-anchor"></a>
310<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>
311<ul class="tsd-signatures tsd-is-private tsd-is-inherited">
312<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>
313<li class="tsd-description">
f04db52f 314<div class="tsd-comment tsd-typography"><p>The pool readiness boolean status.</p>
315</div>
316<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
317<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
c914a50e 318<p>Inherited from AbstractPool.ready</p>
319<ul>
d93988cd 320<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L429">src/pools/abstract-pool.ts:429</a></li></ul></aside></li></ul></section>
184d530f 321<section class="tsd-panel tsd-member tsd-is-protected"><a id="type" class="tsd-anchor"></a>
15d6dfaf 322<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
184d530f 323<ul class="tsd-signatures tsd-is-protected">
a2742ce7 324<li class="tsd-signature" id="type.type-1"><span class="tsd-signature-symbol">get</span> type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;fixed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dynamic&quot;</span></li>
a76fac14 325<li class="tsd-description">
f04db52f 326<div class="tsd-comment tsd-typography"><p>The pool type.</p>
6c525543 327<p>If it is <code>&#39;dynamic&#39;</code>, it provides the <code>max</code> property.</p>
328</div>
15d6dfaf 329<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>
330<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a76fac14
JB
331<p>Overrides AbstractPool.type</p>
332<ul>
d93988cd 333<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L144">src/pools/thread/fixed.ts:144</a></li></ul></aside></li></ul></section>
202bcb6b 334<section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited"><a id="utilization" class="tsd-anchor"></a>
335<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>
336<ul class="tsd-signatures tsd-is-private tsd-is-inherited">
337<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>
338<li class="tsd-description">
f04db52f 339<div class="tsd-comment tsd-typography"><p>The approximate pool utilization.</p>
202bcb6b 340</div>
341<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The pool utilization.</p>
342
343<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
344<p>Inherited from AbstractPool.utilization</p>
345<ul>
d93988cd 346<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L446">src/pools/abstract-pool.ts:446</a></li></ul></aside></li></ul></section>
184d530f 347<section class="tsd-panel tsd-member tsd-is-protected"><a id="worker" class="tsd-anchor"></a>
15d6dfaf 348<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>worker</span><a href="#worker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
184d530f 349<ul class="tsd-signatures tsd-is-protected">
3c7c9bd1 350<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 351<li class="tsd-description">
f04db52f 352<div class="tsd-comment tsd-typography"><p>The worker type.</p>
184d530f 353</div>
3c7c9bd1 354<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 355<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
184d530f 356<p>Overrides AbstractPool.worker</p>
357<ul>
d93988cd 358<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L149">src/pools/thread/fixed.ts:149</a></li></ul></aside></li></ul></section></section>
a76fac14
JB
359<section class="tsd-panel-group tsd-member-group">
360<h2>Methods</h2>
dbf662af
DB
361<section class="tsd-panel tsd-member tsd-is-inherited"><a id="addTaskFunction" class="tsd-anchor"></a>
362<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>
363<ul class="tsd-signatures tsd-is-inherited">
364<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>
365<li class="tsd-description">
366<div class="tsd-comment tsd-typography"><p>Adds a task function to this pool.
367If a task function with the same name already exists, it will be overwritten.</p>
368</div>
369<div class="tsd-parameters">
370<h4 class="tsd-parameters-title">Parameters</h4>
371<ul class="tsd-parameter-list">
372<li>
373<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
374<div class="tsd-comment tsd-typography"><p>The name of the task function.</p>
375</div>
376<div class="tsd-comment tsd-typography"></div></li>
377<li>
378<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>
379<div class="tsd-comment tsd-typography"><p>The task function.</p>
380</div>
381<div class="tsd-comment tsd-typography"></div></li></ul></div>
382<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>
383
384<div class="tsd-comment tsd-typography">
385<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>
386
387<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>
388</div><aside class="tsd-sources">
389<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#addTaskFunction">addTaskFunction</a></p>
390<ul>
d93988cd 391<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L796">src/pools/abstract-pool.ts:796</a></li></ul></aside></li></ul></section>
3bd6a82e 392<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="afterTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 393<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 394<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 395<li class="tsd-signature tsd-anchor-link" id="afterTaskExecutionHook.afterTaskExecutionHook-1"><span class="tsd-kind-call-signature">after<wbr/>Task<wbr/>Execution<wbr/>Hook</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#afterTaskExecutionHook.afterTaskExecutionHook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
ed1ecf09 396<li class="tsd-description">
18ba88e2 397<div class="tsd-comment tsd-typography"><p>Hook executed after the worker task execution.
ed1ecf09
JB
398Can be overridden.</p>
399</div>
400<div class="tsd-parameters">
401<h4 class="tsd-parameters-title">Parameters</h4>
402<ul class="tsd-parameter-list">
403<li>
f04db52f 404<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
405<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 406</div>
407<div class="tsd-comment tsd-typography"></div></li>
ed1ecf09 408<li>
030eb5a3 409<h5><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/MessageValue.html" class="tsd-signature-type tsd-kind-interface">MessageValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h5>
79458fb6 410<div class="tsd-comment tsd-typography"><p>The received message.</p>
cb4889b4 411</div>
412<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 413<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
414<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 415<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#afterTaskExecutionHook">afterTaskExecutionHook</a></p>
ed1ecf09 416<ul>
d93988cd 417<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L1035">src/pools/abstract-pool.ts:1035</a></li></ul></aside></li></ul></section>
f04db52f 418<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="afterWorkerNodeSetup" class="tsd-anchor"></a>
419<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>after<wbr/>Worker<wbr/>Node<wbr/>Setup</span><a href="#afterWorkerNodeSetup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
030eb5a3 420<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 421<li class="tsd-signature tsd-anchor-link" id="afterWorkerNodeSetup.afterWorkerNodeSetup-1"><span class="tsd-kind-call-signature">after<wbr/>Worker<wbr/>Node<wbr/>Setup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#afterWorkerNodeSetup.afterWorkerNodeSetup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 422<li class="tsd-description">
f04db52f 423<div class="tsd-comment tsd-typography"><p>Method hooked up after a worker node has been newly created.
030eb5a3 424Can be overridden.</p>
6c525543 425</div>
a76fac14
JB
426<div class="tsd-parameters">
427<h4 class="tsd-parameters-title">Parameters</h4>
428<ul class="tsd-parameter-list">
429<li>
f04db52f 430<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
431<div class="tsd-comment tsd-typography"><p>The newly created worker node key.</p>
cb4889b4 432</div>
433<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 434<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
435<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 436<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#afterWorkerNodeSetup">afterWorkerNodeSetup</a></p>
a76fac14 437<ul>
d93988cd 438<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L1346">src/pools/abstract-pool.ts:1346</a></li></ul></aside></li></ul></section>
3bd6a82e 439<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="beforeTaskExecutionHook" class="tsd-anchor"></a>
15d6dfaf 440<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 441<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f05afd16 442<li class="tsd-signature tsd-anchor-link" id="beforeTaskExecutionHook.beforeTaskExecutionHook-1"><span class="tsd-kind-call-signature">before<wbr/>Task<wbr/>Execution<wbr/>Hook</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span>, <span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#beforeTaskExecutionHook.beforeTaskExecutionHook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
ed1ecf09 443<li class="tsd-description">
18ba88e2 444<div class="tsd-comment tsd-typography"><p>Hook executed before the worker task execution.
ed1ecf09
JB
445Can be overridden.</p>
446</div>
447<div class="tsd-parameters">
448<h4 class="tsd-parameters-title">Parameters</h4>
449<ul class="tsd-parameter-list">
450<li>
3bd6a82e 451<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
ffc8d144 452<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 453</div>
454<div class="tsd-comment tsd-typography"></div></li>
f05afd16 455<li>
456<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>
457<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
cb4889b4 458</div>
459<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 460<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
461<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 462<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#beforeTaskExecutionHook">beforeTaskExecutionHook</a></p>
ed1ecf09 463<ul>
d93988cd 464<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L1005">src/pools/abstract-pool.ts:1005</a></li></ul></aside></li></ul></section>
f04db52f 465<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="createAndSetupDynamicWorkerNode" class="tsd-anchor"></a>
466<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>create<wbr/>And<wbr/>Setup<wbr/>Dynamic<wbr/>Worker<wbr/>Node</span><a href="#createAndSetupDynamicWorkerNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 467<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 468<li class="tsd-signature tsd-anchor-link" id="createAndSetupDynamicWorkerNode.createAndSetupDynamicWorkerNode-1"><span class="tsd-kind-call-signature">create<wbr/>And<wbr/>Setup<wbr/>Dynamic<wbr/>Worker<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#createAndSetupDynamicWorkerNode.createAndSetupDynamicWorkerNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 469<li class="tsd-description">
f04db52f 470<div class="tsd-comment tsd-typography"><p>Creates a new, completely set up dynamic worker node.</p>
a76fac14 471</div>
f04db52f 472<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>New, completely set up dynamic worker node key.</p>
15d6dfaf 473
474<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 475<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#createAndSetupDynamicWorkerNode">createAndSetupDynamicWorkerNode</a></p>
a76fac14 476<ul>
d93988cd 477<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L1252">src/pools/abstract-pool.ts:1252</a></li></ul></aside></li></ul></section>
f04db52f 478<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="createAndSetupWorkerNode" class="tsd-anchor"></a>
479<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 480<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 481<li class="tsd-signature tsd-anchor-link" id="createAndSetupWorkerNode.createAndSetupWorkerNode-1"><span class="tsd-kind-call-signature">create<wbr/>And<wbr/>Setup<wbr/>Worker<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#createAndSetupWorkerNode.createAndSetupWorkerNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 482<li class="tsd-description">
f04db52f 483<div class="tsd-comment tsd-typography"><p>Creates a new, completely set up worker node.</p>
a76fac14 484</div>
f04db52f 485<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>New, completely set up worker node key.</p>
15d6dfaf 486
487<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 488<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#createAndSetupWorkerNode">createAndSetupWorkerNode</a></p>
a76fac14 489<ul>
d93988cd 490<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L1208">src/pools/abstract-pool.ts:1208</a></li></ul></aside></li></ul></section>
3bd6a82e 491<section class="tsd-panel tsd-member tsd-is-protected"><a id="createWorker" class="tsd-anchor"></a>
15d6dfaf 492<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>create<wbr/>Worker</span><a href="#createWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 493<ul class="tsd-signatures tsd-is-protected">
030eb5a3 494<li class="tsd-signature tsd-anchor-link" id="createWorker.createWorker-1"><span class="tsd-kind-call-signature">create<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Worker</span><a href="#createWorker.createWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 495<li class="tsd-description">
6be0ab6d 496<div class="tsd-comment tsd-typography"><p>Creates a new worker.</p>
6c525543 497</div>
030eb5a3 498<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Worker</span></h4><p>Newly created worker.</p>
6be0ab6d 499
15d6dfaf 500<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 501<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#createWorker">createWorker</a></p>
a76fac14 502<ul>
d93988cd 503<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L136">src/pools/thread/fixed.ts:136</a></li></ul></aside></li></ul></section>
51e49c70
DB
504<section class="tsd-panel tsd-member tsd-is-protected"><a id="deregisterWorkerMessageListener" class="tsd-anchor"></a>
505<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</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>
506<ul class="tsd-signatures tsd-is-protected">
507<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>
508<li class="tsd-description">
509<div class="tsd-comment tsd-typography"><p>Deregisters a listener callback on the worker given its worker node key.</p>
510</div>
511<section class="tsd-panel">
512<h4>Type Parameters</h4>
513<ul class="tsd-type-parameter-list">
514<li>
515<h4><span class="tsd-kind-type-parameter">Message</span></h4></li></ul></section>
516<div class="tsd-parameters">
517<h4 class="tsd-parameters-title">Parameters</h4>
518<ul class="tsd-parameter-list">
519<li>
520<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
521<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
522</div>
523<div class="tsd-comment tsd-typography"></div></li>
524<li>
525<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>
526<div class="tsd-comment tsd-typography"><p>The message listener callback.</p>
527</div>
528<div class="tsd-comment tsd-typography"></div>
529<ul class="tsd-parameters">
530<li class="tsd-parameter-signature">
531<ul class="tsd-signatures">
532<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>
533<li class="tsd-description">
534<div class="tsd-parameters">
535<h4 class="tsd-parameters-title">Parameters</h4>
536<ul class="tsd-parameter-list">
537<li>
538<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>
539<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
540<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
541<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
542<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#deregisterWorkerMessageListener">deregisterWorkerMessageListener</a></p>
543<ul>
d93988cd 544<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L126">src/pools/thread/fixed.ts:126</a></li></ul></aside></li></ul></section>
3bd6a82e 545<section class="tsd-panel tsd-member tsd-is-inherited"><a id="destroy" class="tsd-anchor"></a>
15d6dfaf 546<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 547<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 548<li class="tsd-signature tsd-anchor-link" id="destroy.destroy-1"><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#destroy.destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 549<li class="tsd-description">
f04db52f 550<div class="tsd-comment tsd-typography"><p>Terminates all workers in this pool.</p>
6c525543 551</div>
15d6dfaf 552<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>
553<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 554<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#destroy">destroy</a></p>
a76fac14 555<ul>
d93988cd 556<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L940">src/pools/abstract-pool.ts:940</a></li></ul></aside></li></ul></section>
f04db52f 557<section class="tsd-panel tsd-member tsd-is-protected"><a id="destroyWorkerNode" class="tsd-anchor"></a>
558<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>destroy<wbr/>Worker<wbr/>Node</span><a href="#destroyWorkerNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 559<ul class="tsd-signatures tsd-is-protected">
f04db52f 560<li class="tsd-signature tsd-anchor-link" id="destroyWorkerNode.destroyWorkerNode-1"><span class="tsd-kind-call-signature">destroy<wbr/>Worker<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#destroyWorkerNode.destroyWorkerNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 561<li class="tsd-description">
f04db52f 562<div class="tsd-comment tsd-typography"><p>Terminates the worker node given its worker node key.</p>
6c525543 563</div>
a76fac14
JB
564<div class="tsd-parameters">
565<h4 class="tsd-parameters-title">Parameters</h4>
566<ul class="tsd-parameter-list">
567<li>
f04db52f 568<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
569<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 570</div>
571<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 572<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>
573<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 574<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#destroyWorkerNode">destroyWorkerNode</a></p>
a76fac14 575<ul>
d93988cd 576<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L60">src/pools/thread/fixed.ts:60</a></li></ul></aside></li></ul></section>
3bd6a82e 577<section class="tsd-panel tsd-member tsd-is-inherited"><a id="enableTasksQueue" class="tsd-anchor"></a>
15d6dfaf 578<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 579<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 580<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 581<li class="tsd-description">
31542ddf 582<div class="tsd-comment tsd-typography"><p>Enables/disables the worker node tasks queue in this pool.</p>
6047493a 583</div>
584<div class="tsd-parameters">
585<h4 class="tsd-parameters-title">Parameters</h4>
586<ul class="tsd-parameter-list">
587<li>
3bd6a82e 588<h5><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></h5>
31542ddf 589<div class="tsd-comment tsd-typography"><p>Whether to enable or disable the worker node tasks queue.</p>
cb4889b4 590</div>
591<div class="tsd-comment tsd-typography"></div></li>
6047493a 592<li>
8d1797ad 593<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 594<div class="tsd-comment tsd-typography"><p>The worker node tasks queue options.</p>
cb4889b4 595</div>
596<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 597<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
598<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6047493a 599<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#enableTasksQueue">enableTasksQueue</a></p>
600<ul>
d93988cd 601<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L565">src/pools/abstract-pool.ts:565</a></li></ul></aside></li></ul></section>
3bd6a82e 602<section class="tsd-panel tsd-member tsd-is-inherited"><a id="execute" class="tsd-anchor"></a>
15d6dfaf 603<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 604<ul class="tsd-signatures tsd-is-inherited">
2447ee8c 605<li class="tsd-signature tsd-anchor-link" id="execute.execute-1"><span class="tsd-kind-call-signature">execute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">transferList</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span><a href="#execute.execute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 606<li class="tsd-description">
1bb559f9 607<div class="tsd-comment tsd-typography"><p>Executes the specified function in the worker constructor with the task data input parameter.</p>
6c525543 608</div>
a76fac14
JB
609<div class="tsd-parameters">
610<h4 class="tsd-parameters-title">Parameters</h4>
611<ul class="tsd-parameter-list">
612<li>
3bd6a82e 613<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 614<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 615</div>
616<div class="tsd-comment tsd-typography"></div></li>
2c94c3a5 617<li>
618<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 619<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 620</div>
621<div class="tsd-comment tsd-typography"></div></li>
2447ee8c 622<li>
623<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>
624<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 625</div>
626<div class="tsd-comment tsd-typography"></div></li></ul></div>
fab6d3b5 627<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 628
629<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 630<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#execute">execute</a></p>
a76fac14 631<ul>
d93988cd 632<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L870">src/pools/abstract-pool.ts:870</a></li></ul></aside></li></ul></section>
f04db52f 633<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="flushTasksQueue" class="tsd-anchor"></a>
634<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>flush<wbr/>Tasks<wbr/>Queue</span><a href="#flushTasksQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
76b46937 635<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f04db52f 636<li class="tsd-signature tsd-anchor-link" id="flushTasksQueue.flushTasksQueue-1"><span class="tsd-kind-call-signature">flush<wbr/>Tasks<wbr/>Queue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#flushTasksQueue.flushTasksQueue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
76b46937 637<li class="tsd-description">
76b46937 638<div class="tsd-parameters">
639<h4 class="tsd-parameters-title">Parameters</h4>
640<ul class="tsd-parameter-list">
641<li>
f04db52f 642<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
643<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
644<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#flushTasksQueue">flushTasksQueue</a></p>
76b46937 645<ul>
d93988cd 646<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L1669">src/pools/abstract-pool.ts:1669</a></li></ul></aside></li></ul></section>
f04db52f 647<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="getWorkerInfo" class="tsd-anchor"></a>
648<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Worker<wbr/>Info</span><a href="#getWorkerInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
76b46937 649<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
95d287d1 650<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>
76b46937 651<li class="tsd-description">
f04db52f 652<div class="tsd-comment tsd-typography"><p>Gets the worker information given its worker node key.</p>
76b46937 653</div>
654<div class="tsd-parameters">
655<h4 class="tsd-parameters-title">Parameters</h4>
656<ul class="tsd-parameter-list">
657<li>
f04db52f 658<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
659<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 660</div>
661<div class="tsd-comment tsd-typography"></div></li></ul></div>
95d287d1 662<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 663
664<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
f04db52f 665<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#getWorkerInfo">getWorkerInfo</a></p>
76b46937 666<ul>
d93988cd 667<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L1585">src/pools/abstract-pool.ts:1585</a></li></ul></aside></li></ul></section>
dbf662af
DB
668<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hasTaskFunction" class="tsd-anchor"></a>
669<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>
670<ul class="tsd-signatures tsd-is-inherited">
671<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>
672<li class="tsd-description">
673<div class="tsd-comment tsd-typography"><p>Whether the specified task function exists in this pool.</p>
674</div>
675<div class="tsd-parameters">
676<h4 class="tsd-parameters-title">Parameters</h4>
677<ul class="tsd-parameter-list">
678<li>
679<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
680<div class="tsd-comment tsd-typography"><p>The name of the task function.</p>
681</div>
682<div class="tsd-comment tsd-typography"></div></li></ul></div>
683<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>
684
685<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
686<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#hasTaskFunction">hasTaskFunction</a></p>
687<ul>
d93988cd 688<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L783">src/pools/abstract-pool.ts:783</a></li></ul></aside></li></ul></section>
c22b117f 689<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hasWorkerNodeBackPressure" class="tsd-anchor"></a>
690<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>
691<ul class="tsd-signatures tsd-is-inherited">
692<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>
693<li class="tsd-description"><code class="tsd-tag ts-flagInternal">Internal</code>
694<div class="tsd-comment tsd-typography"><p>Whether the worker node has back pressure (i.e. its tasks queue is full).</p>
695</div>
696<div class="tsd-parameters">
697<h4 class="tsd-parameters-title">Parameters</h4>
698<ul class="tsd-parameter-list">
699<li>
700<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
701<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 702</div>
703<div class="tsd-comment tsd-typography"></div></li></ul></div>
c22b117f 704<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>
705
706<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
707<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#hasWorkerNodeBackPressure">hasWorkerNodeBackPressure</a></p>
708<ul>
d93988cd 709<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L1627">src/pools/abstract-pool.ts:1627</a></li></ul></aside></li></ul></section>
3bd6a82e 710<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="internalBusy" class="tsd-anchor"></a>
15d6dfaf 711<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 712<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 713<li class="tsd-signature tsd-anchor-link" id="internalBusy.internalBusy-1"><span class="tsd-kind-call-signature">internal<wbr/>Busy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#internalBusy.internalBusy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 714<li class="tsd-description">
f4ff239c 715<div class="tsd-comment tsd-typography"><p>Whether worker nodes are executing concurrently their tasks quota or not.</p>
6be0ab6d 716</div>
717<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Worker nodes busyness boolean status.</p>
718
719<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 720<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#internalBusy">internalBusy</a></p>
a76fac14 721<ul>
d93988cd 722<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L667">src/pools/abstract-pool.ts:667</a></li></ul></aside></li></ul></section>
3bd6a82e 723<section class="tsd-panel tsd-member tsd-is-protected"><a id="isMain" class="tsd-anchor"></a>
15d6dfaf 724<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>is<wbr/>Main</span><a href="#isMain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 725<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 726<li class="tsd-signature tsd-anchor-link" id="isMain.isMain-1"><span class="tsd-kind-call-signature">is<wbr/>Main</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isMain.isMain-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 727<li class="tsd-description">
6c525543 728<div class="tsd-comment tsd-typography"><p>Should return whether the worker is the main worker or not.</p>
729</div>
15d6dfaf 730<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
731<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 732<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#isMain">isMain</a></p>
a76fac14 733<ul>
d93988cd 734<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L55">src/pools/thread/fixed.ts:55</a></li></ul></aside></li></ul></section>
dbf662af
DB
735<section class="tsd-panel tsd-member tsd-is-inherited"><a id="listTaskFunctionNames" class="tsd-anchor"></a>
736<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 737<ul class="tsd-signatures tsd-is-inherited">
dbf662af 738<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 739<li class="tsd-description">
740<div class="tsd-comment tsd-typography"><p>Lists the names of task function available in this pool.</p>
741</div>
742<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>
743
744<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
dbf662af 745<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#listTaskFunctionNames">listTaskFunctionNames</a></p>
013a4697 746<ul>
d93988cd 747<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L835">src/pools/abstract-pool.ts:835</a></li></ul></aside></li></ul></section>
51e49c70
DB
748<section class="tsd-panel tsd-member tsd-is-protected"><a id="registerOnceWorkerMessageListener" class="tsd-anchor"></a>
749<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</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>
750<ul class="tsd-signatures tsd-is-protected">
751<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>
752<li class="tsd-description">
753<div class="tsd-comment tsd-typography"><p>Registers once a listener callback on the worker given its worker node key.</p>
754</div>
755<section class="tsd-panel">
756<h4>Type Parameters</h4>
757<ul class="tsd-type-parameter-list">
758<li>
759<h4><span class="tsd-kind-type-parameter">Message</span></h4></li></ul></section>
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">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
765<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
766</div>
767<div class="tsd-comment tsd-typography"></div></li>
768<li>
769<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>
770<div class="tsd-comment tsd-typography"><p>The message listener callback.</p>
771</div>
772<div class="tsd-comment tsd-typography"></div>
773<ul class="tsd-parameters">
774<li class="tsd-parameter-signature">
775<ul class="tsd-signatures">
776<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>
777<li class="tsd-description">
778<div class="tsd-parameters">
779<h4 class="tsd-parameters-title">Parameters</h4>
780<ul class="tsd-parameter-list">
781<li>
782<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>
783<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
784<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
785<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
786<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#registerOnceWorkerMessageListener">registerOnceWorkerMessageListener</a></p>
787<ul>
d93988cd 788<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L116">src/pools/thread/fixed.ts:116</a></li></ul></aside></li></ul></section>
76b46937 789<section class="tsd-panel tsd-member tsd-is-protected"><a id="registerWorkerMessageListener" class="tsd-anchor"></a>
790<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>register<wbr/>Worker<wbr/>Message<wbr/>Listener</span><a href="#registerWorkerMessageListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
791<ul class="tsd-signatures tsd-is-protected">
f04db52f 792<li class="tsd-signature tsd-anchor-link" id="registerWorkerMessageListener.registerWorkerMessageListener-1"><span class="tsd-kind-call-signature">register<wbr/>Worker<wbr/>Message<wbr/>Listener</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Message</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#registerWorkerMessageListener.registerWorkerMessageListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
76b46937 793<li class="tsd-description">
f04db52f 794<div class="tsd-comment tsd-typography"><p>Registers a listener callback on the worker given its worker node key.</p>
76b46937 795</div>
796<section class="tsd-panel">
797<h4>Type Parameters</h4>
798<ul class="tsd-type-parameter-list">
799<li>
800<h4><span class="tsd-kind-type-parameter">Message</span></h4></li></ul></section>
801<div class="tsd-parameters">
802<h4 class="tsd-parameters-title">Parameters</h4>
803<ul class="tsd-parameter-list">
804<li>
f04db52f 805<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
806<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 807</div>
808<div class="tsd-comment tsd-typography"></div></li>
76b46937 809<li>
810<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>
811<div class="tsd-comment tsd-typography"><p>The message listener callback.</p>
812</div>
cb4889b4 813<div class="tsd-comment tsd-typography"></div>
76b46937 814<ul class="tsd-parameters">
815<li class="tsd-parameter-signature">
816<ul class="tsd-signatures">
817<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>
818<li class="tsd-description">
819<div class="tsd-parameters">
820<h4 class="tsd-parameters-title">Parameters</h4>
821<ul class="tsd-parameter-list">
822<li>
823<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>
824<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
825<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
826<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
827<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#registerWorkerMessageListener">registerWorkerMessageListener</a></p>
828<ul>
d93988cd 829<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L106">src/pools/thread/fixed.ts:106</a></li></ul></aside></li></ul></section>
dbf662af
DB
830<section class="tsd-panel tsd-member tsd-is-inherited"><a id="removeTaskFunction" class="tsd-anchor"></a>
831<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>
832<ul class="tsd-signatures tsd-is-inherited">
833<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>
834<li class="tsd-description">
835<div class="tsd-comment tsd-typography"><p>Removes a task function from this pool.</p>
836</div>
837<div class="tsd-parameters">
838<h4 class="tsd-parameters-title">Parameters</h4>
839<ul class="tsd-parameter-list">
840<li>
841<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
842<div class="tsd-comment tsd-typography"><p>The name of the task function.</p>
843</div>
844<div class="tsd-comment tsd-typography"></div></li></ul></div>
845<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>
846
847<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
848<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#removeTaskFunction">removeTaskFunction</a></p>
849<ul>
d93988cd 850<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L819">src/pools/abstract-pool.ts:819</a></li></ul></aside></li></ul></section>
013a4697 851<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="sendKillMessageToWorker" class="tsd-anchor"></a>
852<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>
853<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
dbf662af 854<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 855<li class="tsd-description">
856<div class="tsd-parameters">
857<h4 class="tsd-parameters-title">Parameters</h4>
858<ul class="tsd-parameter-list">
859<li>
dbf662af 860<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
013a4697 861<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">
862<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#sendKillMessageToWorker">sendKillMessageToWorker</a></p>
863<ul>
d93988cd 864<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L953">src/pools/abstract-pool.ts:953</a></li></ul></aside></li></ul></section>
76b46937 865<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendStartupMessageToWorker" class="tsd-anchor"></a>
866<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>send<wbr/>Startup<wbr/>Message<wbr/>To<wbr/>Worker</span><a href="#sendStartupMessageToWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
867<ul class="tsd-signatures tsd-is-protected">
f04db52f 868<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 869<li class="tsd-description">
f04db52f 870<div class="tsd-comment tsd-typography"><p>Sends the startup message to worker given its worker node key.</p>
76b46937 871</div>
872<div class="tsd-parameters">
873<h4 class="tsd-parameters-title">Parameters</h4>
874<ul class="tsd-parameter-list">
875<li>
f04db52f 876<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
877<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 878</div>
879<div class="tsd-comment tsd-typography"></div></li></ul></div>
76b46937 880<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
881<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
882<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#sendStartupMessageToWorker">sendStartupMessageToWorker</a></p>
883<ul>
d93988cd 884<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L91">src/pools/thread/fixed.ts:91</a></li></ul></aside></li></ul></section>
3bd6a82e 885<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendToWorker" class="tsd-anchor"></a>
15d6dfaf 886<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>send<wbr/>To<wbr/>Worker</span><a href="#sendToWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 887<ul class="tsd-signatures tsd-is-protected">
2447ee8c 888<li class="tsd-signature tsd-anchor-link" id="sendToWorker.sendToWorker-1"><span class="tsd-kind-call-signature">send<wbr/>To<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span>, <span class="tsd-kind-parameter">message</span>, <span class="tsd-kind-parameter">transferList</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sendToWorker.sendToWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 889<li class="tsd-description">
f04db52f 890<div class="tsd-comment tsd-typography"><p>Sends a message to worker given its worker node key.</p>
6c525543 891</div>
a76fac14
JB
892<div class="tsd-parameters">
893<h4 class="tsd-parameters-title">Parameters</h4>
894<ul class="tsd-parameter-list">
895<li>
f04db52f 896<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
897<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 898</div>
899<div class="tsd-comment tsd-typography"></div></li>
a76fac14 900<li>
030eb5a3 901<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 902<div class="tsd-comment tsd-typography"><p>The message.</p>
cb4889b4 903</div>
904<div class="tsd-comment tsd-typography"></div></li>
2447ee8c 905<li>
906<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>
907<div class="tsd-comment tsd-typography"><p>The optional array of transferable objects.</p>
cb4889b4 908</div>
909<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 910<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
911<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 912<p>Overrides <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#sendToWorker">sendToWorker</a></p>
a76fac14 913<ul>
d93988cd 914<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L77">src/pools/thread/fixed.ts:77</a></li></ul></aside></li></ul></section>
dbf662af
DB
915<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setDefaultTaskFunction" class="tsd-anchor"></a>
916<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>
917<ul class="tsd-signatures tsd-is-inherited">
918<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>
919<li class="tsd-description">
920<div class="tsd-comment tsd-typography"><p>Sets the default task function in this pool.</p>
921</div>
922<div class="tsd-parameters">
923<h4 class="tsd-parameters-title">Parameters</h4>
924<ul class="tsd-parameter-list">
925<li>
926<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
927<div class="tsd-comment tsd-typography"><p>The name of the task function.</p>
928</div>
929<div class="tsd-comment tsd-typography"></div></li></ul></div>
930<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>
931
932<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
933<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#setDefaultTaskFunction">setDefaultTaskFunction</a></p>
934<ul>
d93988cd 935<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L848">src/pools/abstract-pool.ts:848</a></li></ul></aside></li></ul></section>
3bd6a82e 936<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setTasksQueueOptions" class="tsd-anchor"></a>
15d6dfaf 937<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 938<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 939<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 940<li class="tsd-description">
31542ddf 941<div class="tsd-comment tsd-typography"><p>Sets the worker node tasks queue options in this pool.</p>
6047493a 942</div>
943<div class="tsd-parameters">
944<h4 class="tsd-parameters-title">Parameters</h4>
945<ul class="tsd-parameter-list">
946<li>
8d1797ad 947<h5><span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5>
31542ddf 948<div class="tsd-comment tsd-typography"><p>The worker node tasks queue options.</p>
cb4889b4 949</div>
950<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 951<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
952<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6047493a 953<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#setTasksQueueOptions">setTasksQueueOptions</a></p>
954<ul>
d93988cd 955<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L579">src/pools/abstract-pool.ts:579</a></li></ul></aside></li></ul></section>
3bd6a82e 956<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setWorkerChoiceStrategy" class="tsd-anchor"></a>
15d6dfaf 957<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 958<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 959<li class="tsd-signature tsd-anchor-link" id="setWorkerChoiceStrategy.setWorkerChoiceStrategy-1"><span class="tsd-kind-call-signature">set<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerChoiceStrategy</span>, <span class="tsd-kind-parameter">workerChoiceStrategyOptions</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setWorkerChoiceStrategy.setWorkerChoiceStrategy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 960<li class="tsd-description">
6c525543 961<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy in this pool.</p>
962</div>
a76fac14
JB
963<div class="tsd-parameters">
964<h4 class="tsd-parameters-title">Parameters</h4>
965<ul class="tsd-parameter-list">
966<li>
f05afd16 967<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 968<div class="tsd-comment tsd-typography"><p>The worker choice strategy.</p>
cb4889b4 969</div>
970<div class="tsd-comment tsd-typography"></div></li>
a8aeac44 971<li>
8d1797ad 972<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 973<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
cb4889b4 974</div>
975<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 976<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
977<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 978<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#setWorkerChoiceStrategy">setWorkerChoiceStrategy</a></p>
a76fac14 979<ul>
d93988cd 980<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L532">src/pools/abstract-pool.ts:532</a></li></ul></aside></li></ul></section>
3bd6a82e 981<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setWorkerChoiceStrategyOptions" class="tsd-anchor"></a>
15d6dfaf 982<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 983<ul class="tsd-signatures tsd-is-inherited">
15d6dfaf 984<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 985<li class="tsd-description">
986<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy options in this pool.</p>
987</div>
988<div class="tsd-parameters">
989<h4 class="tsd-parameters-title">Parameters</h4>
990<ul class="tsd-parameter-list">
991<li>
8d1797ad 992<h5><span class="tsd-kind-parameter">workerChoiceStrategyOptions</span>: <a href="../interfaces/WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></h5>
6047493a 993<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
cb4889b4 994</div>
995<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 996<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
997<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6047493a 998<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#setWorkerChoiceStrategyOptions">setWorkerChoiceStrategyOptions</a></p>
999<ul>
d93988cd 1000<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L551">src/pools/abstract-pool.ts:551</a></li></ul></aside></li></ul></section>
3bd6a82e 1001<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="setupHook" class="tsd-anchor"></a>
15d6dfaf 1002<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 1003<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 1004<li class="tsd-signature tsd-anchor-link" id="setupHook.setupHook-1"><span class="tsd-kind-call-signature">setup<wbr/>Hook</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setupHook.setupHook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 1005<li class="tsd-description">
030eb5a3 1006<div class="tsd-comment tsd-typography"><p>Setup hook to execute code before worker nodes are created in the abstract constructor.
1007Can be overridden.</p>
a76fac14 1008</div>
15d6dfaf 1009<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1010<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1011<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#setupHook">setupHook</a></p>
a76fac14 1012<ul>
d93988cd 1013<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L989">src/pools/abstract-pool.ts:989</a></li></ul></aside></li></ul></section>
0b4e655c 1014<section class="tsd-panel tsd-member tsd-is-inherited"><a id="start" class="tsd-anchor"></a>
1015<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>
1016<ul class="tsd-signatures tsd-is-inherited">
1017<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>
1018<li class="tsd-description">
1019<div class="tsd-comment tsd-typography"><p>Starts the minimum number of workers in this pool.</p>
1020</div>
1021<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1022<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
1023<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#start">start</a></p>
1024<ul>
d93988cd 1025<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L924">src/pools/abstract-pool.ts:924</a></li></ul></aside></li></ul></section>
3bd6a82e 1026<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="workerListener" class="tsd-anchor"></a>
15d6dfaf 1027<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>worker<wbr/>Listener</span><a href="#workerListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 1028<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 1029<li class="tsd-signature tsd-anchor-link" id="workerListener.workerListener-1"><span class="tsd-kind-call-signature">worker<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><a href="#workerListener.workerListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14 1030<li class="tsd-description">
f04db52f 1031<div class="tsd-comment tsd-typography"><p>This method is the listener registered for each worker message.</p>
a76fac14 1032</div>
fab6d3b5 1033<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4><p>The listener function to execute when a message is received from a worker.</p>
1034
a76fac14
JB
1035<ul class="tsd-parameters">
1036<li class="tsd-parameter-signature">
3bd6a82e 1037<ul class="tsd-signatures">
1038<li class="tsd-signature" id="workerListener.workerListener-1.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
a76fac14 1039<li class="tsd-description">
f04db52f 1040<div class="tsd-comment tsd-typography"><p>This method is the listener registered for each worker message.</p>
a76fac14
JB
1041</div>
1042<div class="tsd-parameters">
1043<h4 class="tsd-parameters-title">Parameters</h4>
1044<ul class="tsd-parameter-list">
1045<li>
030eb5a3 1046<h5><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/MessageValue.html" class="tsd-signature-type tsd-kind-interface">MessageValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
fab6d3b5 1047<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>The listener function to execute when a message is received from a worker.</p>
15d6dfaf 1048
1049<div class="tsd-comment tsd-typography"></div></li></ul></li></ul>
1050<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 1051<p>Inherited from <a href="AbstractPool.html">AbstractPool</a>.<a href="AbstractPool.html#workerListener">workerListener</a></p>
a76fac14 1052<ul>
d93988cd 1053<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/abstract-pool.ts#L1497">src/pools/abstract-pool.ts:1497</a></li></ul></aside></li></ul></section></section></div>
ec06e4dd 1054<div class="col-sidebar">
1055<div class="page-menu">
a76fac14
JB
1056<div class="tsd-navigation settings">
1057<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
cb4889b4 1058<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary>
a76fac14
JB
1059<div class="tsd-accordion-details">
1060<div class="tsd-filter-visibility">
1061<h4 class="uppercase">Member Visibility</h4><form>
1062<ul id="tsd-filter-options">
cb4889b4 1063<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"><use href="#icon-checkbox"></use></svg><span>Protected</span></label></li>
1064<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"><use href="#icon-checkbox"></use></svg><span>Private</span></label></li>
1065<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"><use href="#icon-checkbox"></use></svg><span>Inherited</span></label></li>
1066<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"><use href="#icon-checkbox"></use></svg><span>External</span></label></li></ul></form></div>
a76fac14 1067<div class="tsd-theme-toggle">
3bd6a82e 1068<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
ec06e4dd 1069<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 1070<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
a76fac14
JB
1071<div class="tsd-accordion-details">
1072<ul>
15d6dfaf 1073<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>
1074<li><a href="#emitter" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>emitter</span></a></li>
1075<li><a href="#filePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>file<wbr/>Path</span></a></li>
00471704 1076<li><a href="#max" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max</span></a></li>
15d6dfaf 1077<li><a href="#numberOfWorkers" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>number<wbr/>Of<wbr/>Workers</span></a></li>
1078<li><a href="#opts" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>opts</span></a></li>
1079<li><a href="#promiseResponseMap" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>promise<wbr/>Response<wbr/>Map</span></a></li>
1080<li><a href="#workerChoiceStrategyContext" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span></a></li>
1081<li><a href="#workerNodes" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Nodes</span></a></li>
1082<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>
1083<li><a href="#full" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>full</span></a></li>
1084<li><a href="#info" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>info</span></a></li>
00471704 1085<li><a href="#maxSize" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>max<wbr/>Size</span></a></li>
1086<li><a href="#minSize" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>min<wbr/>Size</span></a></li>
c914a50e 1087<li><a href="#ready" class="tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>ready</span></a></li>
15d6dfaf 1088<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 1089<li><a href="#utilization" class="tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>utilization</span></a></li>
15d6dfaf 1090<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 1091<li><a href="#addTaskFunction" class="tsd-is-inherited"><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>
15d6dfaf 1092<li><a href="#afterTaskExecutionHook" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>after<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a></li>
f04db52f 1093<li><a href="#afterWorkerNodeSetup" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>after<wbr/>Worker<wbr/>Node<wbr/>Setup</span></a></li>
15d6dfaf 1094<li><a href="#beforeTaskExecutionHook" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>before<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a></li>
f04db52f 1095<li><a href="#createAndSetupDynamicWorkerNode" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>And<wbr/>Setup<wbr/>Dynamic<wbr/>Worker<wbr/>Node</span></a></li>
1096<li><a href="#createAndSetupWorkerNode" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>And<wbr/>Setup<wbr/>Worker<wbr/>Node</span></a></li>
15d6dfaf 1097<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>
51e49c70 1098<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 1099<li><a href="#destroy" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a></li>
f04db52f 1100<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 1101<li><a href="#enableTasksQueue" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enable<wbr/>Tasks<wbr/>Queue</span></a></li>
1102<li><a href="#execute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>execute</span></a></li>
f04db52f 1103<li><a href="#flushTasksQueue" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flush<wbr/>Tasks<wbr/>Queue</span></a></li>
1104<li><a href="#getWorkerInfo" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Worker<wbr/>Info</span></a></li>
dbf662af 1105<li><a href="#hasTaskFunction" class="tsd-is-inherited"><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 1106<li><a href="#hasWorkerNodeBackPressure" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span></a></li>
15d6dfaf 1107<li><a href="#internalBusy" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>internal<wbr/>Busy</span></a></li>
1108<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 1109<li><a href="#listTaskFunctionNames" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Task<wbr/>Function<wbr/>Names</span></a></li>
51e49c70 1110<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 1111<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 1112<li><a href="#removeTaskFunction" class="tsd-is-inherited"><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>
013a4697 1113<li><a href="#sendKillMessageToWorker" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Kill<wbr/>Message<wbr/>To<wbr/>Worker</span></a></li>
76b46937 1114<li><a href="#sendStartupMessageToWorker" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Startup<wbr/>Message<wbr/>To<wbr/>Worker</span></a></li>
15d6dfaf 1115<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 1116<li><a href="#setDefaultTaskFunction" class="tsd-is-inherited"><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>
15d6dfaf 1117<li><a href="#setTasksQueueOptions" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Tasks<wbr/>Queue<wbr/>Options</span></a></li>
1118<li><a href="#setWorkerChoiceStrategy" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span></a></li>
1119<li><a href="#setWorkerChoiceStrategyOptions" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a></li>
1120<li><a href="#setupHook" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>setup<wbr/>Hook</span></a></li>
0b4e655c 1121<li><a href="#start" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>start</span></a></li>
15d6dfaf 1122<li><a href="#workerListener" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>worker<wbr/>Listener</span></a></li></ul></div></details></div>
ec06e4dd 1123<div class="site-menu">
d93988cd 1124<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 - v2.7.4</span></a>
cb4889b4 1125<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
1126<li><a href="AbstractPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AbstractPool</a></li>
1127<li><a href="AbstractWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AbstractWorker</a></li>
1128<li><a href="CircularArray.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>CircularArray</a></li>
1129<li><a href="ClusterWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ClusterWorker</a></li>
1130<li><a href="Deque.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Deque</a></li>
1131<li><a href="DynamicClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>DynamicClusterPool</a></li>
1132<li><a href="DynamicThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>DynamicThreadPool</a></li>
1133<li><a href="FixedClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>FixedClusterPool</a></li>
1134<li><a href="FixedThreadPool.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>FixedThreadPool</a></li>
1135<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 1136<li><a href="ThreadWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ThreadWorker</a></li>
1137<li><a href="WorkerChoiceStrategyContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>WorkerChoiceStrategyContext</a></li>
1138<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>
1139<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>
1140<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>
1141<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>
1142<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>
1143<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>
1144<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>
1145<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 1146<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 1147<li>Loading...</li></ul></nav></div></div></div>
ec06e4dd 1148<div class="tsd-generator">
323daa7f 1149<p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
cb4889b4 1150<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-checkbox"><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></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>