docs: generate documentation
[poolifier.git] / docs / interfaces / IPool.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>IPool | 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="IPool.html">IPool</a></li></ul>
6c525543 17<h1>Interface IPool&lt;Worker, Data, Response&gt;</h1></div>
a76fac14
JB
18<section class="tsd-panel tsd-comment">
19<div class="tsd-comment tsd-typography"><p>Contract definition for a poolifier pool.</p>
15d6dfaf 20</div>
21<div class="tsd-comment tsd-typography"></div></section>
fab6d3b5 22<section class="tsd-panel">
a76fac14 23<h4>Type Parameters</h4>
fab6d3b5 24<ul class="tsd-type-parameter-list">
a76fac14 25<li>
8d1797ad 26<h4><span class="tsd-kind-type-parameter">Worker</span><span class="tsd-signature-symbol"> extends </span><a href="IWorker.html" class="tsd-signature-type tsd-kind-interface">IWorker</a></h4>
6c525543 27<div class="tsd-comment tsd-typography"><p>Type of worker which manages this pool.</p>
15d6dfaf 28</div>
29<div class="tsd-comment tsd-typography"></div></li>
6c525543 30<li>
3bd6a82e 31<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 32<div class="tsd-comment tsd-typography"><p>Type of data sent to the worker. This can only be structured-cloneable data.</p>
15d6dfaf 33</div>
34<div class="tsd-comment tsd-typography"></div></li>
a76fac14 35<li>
3bd6a82e 36<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 37<div class="tsd-comment tsd-typography"><p>Type of execution response. This can only be structured-cloneable data.</p>
15d6dfaf 38</div>
39<div class="tsd-comment tsd-typography"></div></li></ul></section>
a76fac14
JB
40<section class="tsd-panel tsd-hierarchy">
41<h4>Hierarchy</h4>
42<ul class="tsd-hierarchy">
6c525543 43<li><span class="target">IPool</span></li></ul></section>
44<section class="tsd-panel">
45<h4>Implemented by</h4>
46<ul class="tsd-hierarchy">
8d1797ad 47<li><a href="../classes/AbstractPool.html" class="tsd-signature-type tsd-kind-class">AbstractPool</a></li></ul></section><aside class="tsd-sources">
a76fac14 48<ul>
d93988cd 49<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L201">src/pools/pool.ts:201</a></li></ul></aside>
a76fac14
JB
50<section class="tsd-panel-group tsd-index-group">
51<section class="tsd-panel tsd-index-panel">
52<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
cb4889b4 53<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
54<div class="tsd-accordion-details">
55<section class="tsd-index-section">
41015374 56<h3 class="tsd-index-heading">Properties</h3>
dbf662af
DB
57<div class="tsd-index-list"><a href="IPool.html#addTaskFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>add<wbr/>Task<wbr/>Function</span></a>
58<a href="IPool.html#destroy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>destroy</span></a>
15d6dfaf 59<a href="IPool.html#emitter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>emitter?</span></a>
60<a href="IPool.html#enableTasksQueue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>enable<wbr/>Tasks<wbr/>Queue</span></a>
61<a href="IPool.html#execute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>execute</span></a>
dbf662af 62<a href="IPool.html#hasTaskFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>has<wbr/>Task<wbr/>Function</span></a>
c22b117f 63<a href="IPool.html#hasWorkerNodeBackPressure" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span></a>
15d6dfaf 64<a href="IPool.html#info" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>info</span></a>
dbf662af
DB
65<a href="IPool.html#listTaskFunctionNames" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>list<wbr/>Task<wbr/>Function<wbr/>Names</span></a>
66<a href="IPool.html#removeTaskFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>remove<wbr/>Task<wbr/>Function</span></a>
67<a href="IPool.html#setDefaultTaskFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>set<wbr/>Default<wbr/>Task<wbr/>Function</span></a>
15d6dfaf 68<a href="IPool.html#setTasksQueueOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>set<wbr/>Tasks<wbr/>Queue<wbr/>Options</span></a>
69<a href="IPool.html#setWorkerChoiceStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span></a>
70<a href="IPool.html#setWorkerChoiceStrategyOptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a>
0b4e655c 71<a href="IPool.html#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>start</span></a>
15d6dfaf 72<a href="IPool.html#workerNodes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Nodes</span></a>
a76fac14
JB
73</div></section></div></details></section></section>
74<section class="tsd-panel-group tsd-member-group">
41015374 75<h2>Properties</h2>
dbf662af
DB
76<section class="tsd-panel tsd-member"><a id="addTaskFunction" class="tsd-anchor"></a>
77<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
78<div class="tsd-signature"><span class="tsd-kind-property">add<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</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"> =&gt; </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><span class="tsd-signature-symbol">)</span></div>
79<div class="tsd-type-declaration">
80<h4>Type declaration</h4>
81<ul class="tsd-parameters">
82<li class="tsd-parameter-signature">
83<ul class="tsd-signatures">
84<li class="tsd-signature" id="addTaskFunction.__type.__type-1"><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></li>
85<li class="tsd-description">
86<div class="tsd-comment tsd-typography"><p>Adds a task function to this pool.
87If a task function with the same name already exists, it will be overwritten.</p>
88</div>
89<div class="tsd-parameters">
90<h4 class="tsd-parameters-title">Parameters</h4>
91<ul class="tsd-parameter-list">
92<li>
93<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
94<div class="tsd-comment tsd-typography"><p>The name of the task function.</p>
95</div>
96<div class="tsd-comment tsd-typography"></div></li>
97<li>
98<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>
99<div class="tsd-comment tsd-typography"><p>The task function.</p>
100</div>
101<div class="tsd-comment tsd-typography"></div></li></ul></div>
102<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>
103
104<div class="tsd-comment tsd-typography">
105<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>
106
107<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>
108</div></li></ul></li></ul></div><aside class="tsd-sources">
109<ul>
d93988cd 110<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L277">src/pools/pool.ts:277</a></li></ul></aside></section>
3bd6a82e 111<section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a>
cb4889b4 112<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
8d1797ad 113<div class="tsd-signature"><span class="tsd-kind-property">destroy</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"> =&gt; </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><span class="tsd-signature-symbol">)</span></div>
402f08b7 114<div class="tsd-type-declaration">
115<h4>Type declaration</h4>
116<ul class="tsd-parameters">
117<li class="tsd-parameter-signature">
3bd6a82e 118<ul class="tsd-signatures">
dbf662af 119<li class="tsd-signature" id="destroy.__type-2.__type-3"><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></li>
402f08b7 120<li class="tsd-description">
f04db52f 121<div class="tsd-comment tsd-typography"><p>Terminates all workers in this pool.</p>
402f08b7 122</div>
15d6dfaf 123<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>
124<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
402f08b7 125<ul>
d93988cd 126<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L259">src/pools/pool.ts:259</a></li></ul></aside></section>
3bd6a82e 127<section class="tsd-panel tsd-member"><a id="emitter" class="tsd-anchor"></a>
15d6dfaf 128<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>emitter</span><a href="#emitter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
48c6ba05
DB
129<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>
130<div class="tsd-comment tsd-typography"><p>Event emitter integrated with async resource on which events can be listened to.
131The async tracking tooling identifier is <code>poolifier:&lt;PoolType&gt;-&lt;WorkerType&gt;-pool</code>.</p>
41015374
JB
132<p>Events that can currently be listened to:</p>
133<ul>
85c03385 134<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 135<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 136<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 137<li><code>&#39;destroy&#39;</code>: Emitted when the pool is destroyed.</li>
ccb7d1a7 138<li><code>&#39;error&#39;</code>: Emitted when an uncaught error occurs.</li>
139<li><code>&#39;taskError&#39;</code>: Emitted when an error occurs while executing a task.</li>
31542ddf 140<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>
41015374 141</ul>
15d6dfaf 142</div>
143<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
41015374 144<ul>
d93988cd 145<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L238">src/pools/pool.ts:238</a></li></ul></aside></section>
3bd6a82e 146<section class="tsd-panel tsd-member"><a id="enableTasksQueue" class="tsd-anchor"></a>
a6b5c73c 147<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
8d1797ad 148<div class="tsd-signature"><span class="tsd-kind-property">enable<wbr/>Tasks<wbr/>Queue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
6047493a 149<div class="tsd-type-declaration">
150<h4>Type declaration</h4>
151<ul class="tsd-parameters">
152<li class="tsd-parameter-signature">
3bd6a82e 153<ul class="tsd-signatures">
dbf662af 154<li class="tsd-signature" id="enableTasksQueue.__type-4.__type-5"><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></li>
6047493a 155<li class="tsd-description">
31542ddf 156<div class="tsd-comment tsd-typography"><p>Enables/disables the worker node tasks queue in this pool.</p>
6047493a 157</div>
158<div class="tsd-parameters">
159<h4 class="tsd-parameters-title">Parameters</h4>
160<ul class="tsd-parameter-list">
161<li>
3bd6a82e 162<h5><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></h5>
31542ddf 163<div class="tsd-comment tsd-typography"><p>Whether to enable or disable the worker node tasks queue.</p>
cb4889b4 164</div>
165<div class="tsd-comment tsd-typography"></div></li>
6047493a 166<li>
8d1797ad 167<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5>
31542ddf 168<div class="tsd-comment tsd-typography"><p>The worker node tasks queue options.</p>
cb4889b4 169</div>
170<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 171<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
172<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
6047493a 173<ul>
d93988cd 174<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L325">src/pools/pool.ts:325</a></li></ul></aside></section>
3bd6a82e 175<section class="tsd-panel tsd-member"><a id="execute" class="tsd-anchor"></a>
a6b5c73c 176<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
2447ee8c 177<div class="tsd-signature"><span class="tsd-kind-property">execute</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</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"> =&gt; </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><span class="tsd-signature-symbol">)</span></div>
402f08b7 178<div class="tsd-type-declaration">
179<h4>Type declaration</h4>
180<ul class="tsd-parameters">
181<li class="tsd-parameter-signature">
3bd6a82e 182<ul class="tsd-signatures">
dbf662af 183<li class="tsd-signature" id="execute.__type-6.__type-7"><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></li>
a76fac14 184<li class="tsd-description">
1bb559f9 185<div class="tsd-comment tsd-typography"><p>Executes the specified function in the worker constructor with the task data input parameter.</p>
a76fac14
JB
186</div>
187<div class="tsd-parameters">
188<h4 class="tsd-parameters-title">Parameters</h4>
189<ul class="tsd-parameter-list">
190<li>
3bd6a82e 191<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 192<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 193</div>
194<div class="tsd-comment tsd-typography"></div></li>
2c94c3a5 195<li>
196<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 197<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 198</div>
199<div class="tsd-comment tsd-typography"></div></li>
2447ee8c 200<li>
201<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>
202<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 203</div>
204<div class="tsd-comment tsd-typography"></div></li></ul></div>
fab6d3b5 205<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 206
207<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
a76fac14 208<ul>
d93988cd 209<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L247">src/pools/pool.ts:247</a></li></ul></aside></section>
dbf662af
DB
210<section class="tsd-panel tsd-member"><a id="hasTaskFunction" class="tsd-anchor"></a>
211<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
212<div class="tsd-signature"><span class="tsd-kind-property">has<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</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"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div>
213<div class="tsd-type-declaration">
214<h4>Type declaration</h4>
215<ul class="tsd-parameters">
216<li class="tsd-parameter-signature">
217<ul class="tsd-signatures">
218<li class="tsd-signature" id="hasTaskFunction.__type-8.__type-9"><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></li>
219<li class="tsd-description">
220<div class="tsd-comment tsd-typography"><p>Whether the specified task function exists in this pool.</p>
221</div>
222<div class="tsd-parameters">
223<h4 class="tsd-parameters-title">Parameters</h4>
224<ul class="tsd-parameter-list">
225<li>
226<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
227<div class="tsd-comment tsd-typography"><p>The name of the task function.</p>
228</div>
229<div class="tsd-comment tsd-typography"></div></li></ul></div>
230<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>
231
232<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
233<ul>
d93988cd 234<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L266">src/pools/pool.ts:266</a></li></ul></aside></section>
c22b117f 235<section class="tsd-panel tsd-member"><a id="hasWorkerNodeBackPressure" class="tsd-anchor"></a>
236<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
237<div class="tsd-signature"><span class="tsd-kind-property">has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div>
238<div class="tsd-type-declaration">
239<h4>Type declaration</h4>
240<ul class="tsd-parameters">
241<li class="tsd-parameter-signature">
242<ul class="tsd-signatures">
dbf662af 243<li class="tsd-signature" id="hasWorkerNodeBackPressure.__type-10.__type-11"><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></li>
c22b117f 244<li class="tsd-description"><code class="tsd-tag ts-flagInternal">Internal</code>
245<div class="tsd-comment tsd-typography"><p>Whether the worker node has back pressure (i.e. its tasks queue is full).</p>
246</div>
247<div class="tsd-parameters">
248<h4 class="tsd-parameters-title">Parameters</h4>
249<ul class="tsd-parameter-list">
250<li>
251<h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5>
252<div class="tsd-comment tsd-typography"><p>The worker node key.</p>
cb4889b4 253</div>
254<div class="tsd-comment tsd-typography"></div></li></ul></div>
c22b117f 255<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>
256
257<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
258<ul>
d93988cd 259<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L223">src/pools/pool.ts:223</a></li></ul></aside></section>
a2742ce7 260<section class="tsd-panel tsd-member"><a id="info" class="tsd-anchor"></a>
15d6dfaf 261<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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 262<div class="tsd-signature"><span class="tsd-kind-property">info</span><span class="tsd-signature-symbol">:</span> <a href="PoolInfo.html" class="tsd-signature-type tsd-kind-interface">PoolInfo</a></div>
263<div class="tsd-comment tsd-typography"><p>Pool information.</p>
15d6dfaf 264</div>
265<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
a2742ce7 266<ul>
d93988cd 267<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L209">src/pools/pool.ts:209</a></li></ul></aside></section>
dbf662af
DB
268<section class="tsd-panel tsd-member"><a id="listTaskFunctionNames" class="tsd-anchor"></a>
269<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
270<div class="tsd-signature"><span class="tsd-kind-property">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-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></div>
013a4697 271<div class="tsd-type-declaration">
272<h4>Type declaration</h4>
273<ul class="tsd-parameters">
274<li class="tsd-parameter-signature">
275<ul class="tsd-signatures">
dbf662af 276<li class="tsd-signature" id="listTaskFunctionNames.__type-12.__type-13"><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></li>
013a4697 277<li class="tsd-description">
278<div class="tsd-comment tsd-typography"><p>Lists the names of task function available in this pool.</p>
279</div>
280<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>
281
282<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
283<ul>
d93988cd 284<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L293">src/pools/pool.ts:293</a></li></ul></aside></section>
dbf662af
DB
285<section class="tsd-panel tsd-member"><a id="removeTaskFunction" class="tsd-anchor"></a>
286<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
287<div class="tsd-signature"><span class="tsd-kind-property">remove<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</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"> =&gt; </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><span class="tsd-signature-symbol">)</span></div>
288<div class="tsd-type-declaration">
289<h4>Type declaration</h4>
290<ul class="tsd-parameters">
291<li class="tsd-parameter-signature">
292<ul class="tsd-signatures">
293<li class="tsd-signature" id="removeTaskFunction.__type-14.__type-15"><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></li>
294<li class="tsd-description">
295<div class="tsd-comment tsd-typography"><p>Removes a task function from this pool.</p>
296</div>
297<div class="tsd-parameters">
298<h4 class="tsd-parameters-title">Parameters</h4>
299<ul class="tsd-parameter-list">
300<li>
301<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
302<div class="tsd-comment tsd-typography"><p>The name of the task function.</p>
303</div>
304<div class="tsd-comment tsd-typography"></div></li></ul></div>
305<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>
306
307<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
308<ul>
d93988cd 309<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L287">src/pools/pool.ts:287</a></li></ul></aside></section>
dbf662af
DB
310<section class="tsd-panel tsd-member"><a id="setDefaultTaskFunction" class="tsd-anchor"></a>
311<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
312<div class="tsd-signature"><span class="tsd-kind-property">set<wbr/>Default<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</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"> =&gt; </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><span class="tsd-signature-symbol">)</span></div>
313<div class="tsd-type-declaration">
314<h4>Type declaration</h4>
315<ul class="tsd-parameters">
316<li class="tsd-parameter-signature">
317<ul class="tsd-signatures">
318<li class="tsd-signature" id="setDefaultTaskFunction.__type-16.__type-17"><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></li>
319<li class="tsd-description">
320<div class="tsd-comment tsd-typography"><p>Sets the default task function in this pool.</p>
321</div>
322<div class="tsd-parameters">
323<h4 class="tsd-parameters-title">Parameters</h4>
324<ul class="tsd-parameter-list">
325<li>
326<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
327<div class="tsd-comment tsd-typography"><p>The name of the task function.</p>
328</div>
329<div class="tsd-comment tsd-typography"></div></li></ul></div>
330<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>
331
332<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
333<ul>
d93988cd 334<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L300">src/pools/pool.ts:300</a></li></ul></aside></section>
3bd6a82e 335<section class="tsd-panel tsd-member"><a id="setTasksQueueOptions" class="tsd-anchor"></a>
a6b5c73c 336<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
8d1797ad 337<div class="tsd-signature"><span class="tsd-kind-property">set<wbr/>Tasks<wbr/>Queue<wbr/>Options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
6047493a 338<div class="tsd-type-declaration">
339<h4>Type declaration</h4>
340<ul class="tsd-parameters">
341<li class="tsd-parameter-signature">
3bd6a82e 342<ul class="tsd-signatures">
dbf662af 343<li class="tsd-signature" id="setTasksQueueOptions.__type-18.__type-19"><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></li>
6047493a 344<li class="tsd-description">
31542ddf 345<div class="tsd-comment tsd-typography"><p>Sets the worker node tasks queue options in this pool.</p>
6047493a 346</div>
347<div class="tsd-parameters">
348<h4 class="tsd-parameters-title">Parameters</h4>
349<ul class="tsd-parameter-list">
350<li>
8d1797ad 351<h5><span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5>
31542ddf 352<div class="tsd-comment tsd-typography"><p>The worker node tasks queue options.</p>
cb4889b4 353</div>
354<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 355<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
356<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
6047493a 357<ul>
d93988cd 358<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L334">src/pools/pool.ts:334</a></li></ul></aside></section>
3bd6a82e 359<section class="tsd-panel tsd-member"><a id="setWorkerChoiceStrategy" class="tsd-anchor"></a>
a6b5c73c 360<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
8d1797ad 361<div class="tsd-signature"><span class="tsd-kind-property">set<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
402f08b7 362<div class="tsd-type-declaration">
363<h4>Type declaration</h4>
364<ul class="tsd-parameters">
365<li class="tsd-parameter-signature">
3bd6a82e 366<ul class="tsd-signatures">
dbf662af 367<li class="tsd-signature" id="setWorkerChoiceStrategy.__type-20.__type-21"><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></li>
a76fac14 368<li class="tsd-description">
ed1ecf09 369<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy in this pool.</p>
a76fac14
JB
370</div>
371<div class="tsd-parameters">
372<h4 class="tsd-parameters-title">Parameters</h4>
373<ul class="tsd-parameter-list">
374<li>
f05afd16 375<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>
a76fac14 376<div class="tsd-comment tsd-typography"><p>The worker choice strategy.</p>
cb4889b4 377</div>
378<div class="tsd-comment tsd-typography"></div></li>
a8aeac44 379<li>
8d1797ad 380<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">workerChoiceStrategyOptions</span>: <a href="WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></h5>
a8aeac44 381<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
cb4889b4 382</div>
383<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 384<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
385<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
a76fac14 386<ul>
d93988cd 387<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L307">src/pools/pool.ts:307</a></li></ul></aside></section>
3bd6a82e 388<section class="tsd-panel tsd-member"><a id="setWorkerChoiceStrategyOptions" class="tsd-anchor"></a>
a6b5c73c 389<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
8d1797ad 390<div class="tsd-signature"><span class="tsd-kind-property">set<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
6047493a 391<div class="tsd-type-declaration">
392<h4>Type declaration</h4>
393<ul class="tsd-parameters">
394<li class="tsd-parameter-signature">
3bd6a82e 395<ul class="tsd-signatures">
dbf662af 396<li class="tsd-signature" id="setWorkerChoiceStrategyOptions.__type-22.__type-23"><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></li>
6047493a 397<li class="tsd-description">
398<div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy options in this pool.</p>
399</div>
400<div class="tsd-parameters">
401<h4 class="tsd-parameters-title">Parameters</h4>
402<ul class="tsd-parameter-list">
403<li>
8d1797ad 404<h5><span class="tsd-kind-parameter">workerChoiceStrategyOptions</span>: <a href="WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></h5>
6047493a 405<div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p>
cb4889b4 406</div>
407<div class="tsd-comment tsd-typography"></div></li></ul></div>
15d6dfaf 408<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
409<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
6047493a 410<ul>
d93988cd 411<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L316">src/pools/pool.ts:316</a></li></ul></aside></section>
0b4e655c 412<section class="tsd-panel tsd-member"><a id="start" class="tsd-anchor"></a>
413<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
414<div class="tsd-signature"><span class="tsd-kind-property">start</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
415<div class="tsd-type-declaration">
416<h4>Type declaration</h4>
417<ul class="tsd-parameters">
418<li class="tsd-parameter-signature">
419<ul class="tsd-signatures">
dbf662af 420<li class="tsd-signature" id="start.__type-24.__type-25"><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></li>
0b4e655c 421<li class="tsd-description">
422<div class="tsd-comment tsd-typography"><p>Starts the minimum number of workers in this pool.</p>
423</div>
424<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
425<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
426<ul>
d93988cd 427<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L255">src/pools/pool.ts:255</a></li></ul></aside></section>
3bd6a82e 428<section class="tsd-panel tsd-member"><a id="workerNodes" class="tsd-anchor"></a>
c22b117f 429<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 430<div class="tsd-signature"><span class="tsd-kind-property">worker<wbr/>Nodes</span><span class="tsd-signature-symbol">:</span> <a href="IWorkerNode.html" class="tsd-signature-type tsd-kind-interface">IWorkerNode</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Worker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div>
6c525543 431<div class="tsd-comment tsd-typography"><p>Pool worker nodes.</p>
15d6dfaf 432</div>
433<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 434<ul>
d93988cd 435<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L215">src/pools/pool.ts:215</a></li></ul></aside></section></section></div>
ec06e4dd 436<div class="col-sidebar">
437<div class="page-menu">
a76fac14
JB
438<div class="tsd-navigation settings">
439<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
cb4889b4 440<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary>
a76fac14
JB
441<div class="tsd-accordion-details">
442<div class="tsd-filter-visibility">
443<h4 class="uppercase">Member Visibility</h4><form>
444<ul id="tsd-filter-options">
cb4889b4 445<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>
446<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>
447<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>
448<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 449<div class="tsd-theme-toggle">
3bd6a82e 450<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 451<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 452<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
453<div class="tsd-accordion-details">
454<ul>
dbf662af 455<li><a href="#addTaskFunction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>add<wbr/>Task<wbr/>Function</span></a></li>
15d6dfaf 456<li><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>destroy</span></a></li>
457<li><a href="#emitter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>emitter</span></a></li>
458<li><a href="#enableTasksQueue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>enable<wbr/>Tasks<wbr/>Queue</span></a></li>
459<li><a href="#execute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>execute</span></a></li>
dbf662af 460<li><a href="#hasTaskFunction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>has<wbr/>Task<wbr/>Function</span></a></li>
c22b117f 461<li><a href="#hasWorkerNodeBackPressure" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>has<wbr/>Worker<wbr/>Node<wbr/>Back<wbr/>Pressure</span></a></li>
15d6dfaf 462<li><a href="#info" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>info</span></a></li>
dbf662af
DB
463<li><a href="#listTaskFunctionNames" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>list<wbr/>Task<wbr/>Function<wbr/>Names</span></a></li>
464<li><a href="#removeTaskFunction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>remove<wbr/>Task<wbr/>Function</span></a></li>
465<li><a href="#setDefaultTaskFunction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>set<wbr/>Default<wbr/>Task<wbr/>Function</span></a></li>
15d6dfaf 466<li><a href="#setTasksQueueOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>set<wbr/>Tasks<wbr/>Queue<wbr/>Options</span></a></li>
467<li><a href="#setWorkerChoiceStrategy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span></a></li>
468<li><a href="#setWorkerChoiceStrategyOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a></li>
0b4e655c 469<li><a href="#start" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>start</span></a></li>
15d6dfaf 470<li><a href="#workerNodes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Nodes</span></a></li></ul></div></details></div>
ec06e4dd 471<div class="site-menu">
d93988cd 472<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 473<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
474<li><a href="../classes/AbstractPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AbstractPool</a></li>
475<li><a href="../classes/AbstractWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AbstractWorker</a></li>
476<li><a href="../classes/CircularArray.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>CircularArray</a></li>
477<li><a href="../classes/ClusterWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ClusterWorker</a></li>
478<li><a href="../classes/Deque.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Deque</a></li>
479<li><a href="../classes/DynamicClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>DynamicClusterPool</a></li>
480<li><a href="../classes/DynamicThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>DynamicThreadPool</a></li>
481<li><a href="../classes/FixedClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>FixedClusterPool</a></li>
482<li><a href="../classes/FixedThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>FixedThreadPool</a></li>
483<li><a href="../classes/Node.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Node</a></li>
cb4889b4 484<li><a href="../classes/ThreadWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ThreadWorker</a></li>
485<li><a href="../classes/WorkerChoiceStrategyContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>WorkerChoiceStrategyContext</a></li>
486<li><a href="ClusterPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ClusterPoolOptions</a></li>
487<li><a href="EventLoopUtilizationMeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EventLoopUtilizationMeasurementStatistics</a></li>
488<li><a href="IPool.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IPool</a></li>
489<li><a href="IWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IWorker</a></li>
490<li><a href="IWorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IWorkerChoiceStrategy</a></li>
491<li><a href="IWorkerNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IWorkerNode</a></li>
492<li><a href="MeasurementOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MeasurementOptions</a></li>
493<li><a href="MeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MeasurementStatistics</a></li>
48c6ba05 494<li><a href="MeasurementStatisticsRequirements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MeasurementStatisticsRequirements</a></li>
cb4889b4 495<li>Loading...</li></ul></nav></div></div></div>
ec06e4dd 496<div class="tsd-generator">
323daa7f 497<p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
cb4889b4 498<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>