Merge branch 'master' of github.com:poolifier/poolifier
[poolifier.git] / docs / interfaces / IWorkerNode.html
CommitLineData
7ab352a6 1<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IWorkerNode | poolifier - v2.6.37</title><meta name="description" content="Documentation for poolifier"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
6c525543 2<div class="tsd-toolbar-contents container">
3<div class="table-cell" id="tsd-search" data-base="..">
4<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5<div class="field">
6<div id="tsd-toolbar-links"></div></div>
7<ul class="results">
8<li class="state loading">Preparing search index...</li>
7ab352a6 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.6.37</a></div>
6c525543 10<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11<div class="container container-main">
12<div class="col-content">
13<div class="tsd-page-title">
14<ul class="tsd-breadcrumb">
15<li><a href="../index.html">poolifier</a></li>
a6b5c73c 16<li><a href="IWorkerNode.html">IWorkerNode</a></li></ul>
17<h1>Interface IWorkerNode&lt;Worker, Data&gt;<code class="tsd-tag ts-flagInternal">Internal</code> </h1></div>
6c525543 18<section class="tsd-panel tsd-comment">
19<div class="tsd-comment tsd-typography"><p>Worker node interface.</p>
15d6dfaf 20</div>
21<div class="tsd-comment tsd-typography"></div></section>
fab6d3b5 22<section class="tsd-panel">
6c525543 23<h4>Type Parameters</h4>
fab6d3b5 24<ul class="tsd-type-parameter-list">
6c525543 25<li>
8d1797ad 26<h4><span class="tsd-kind-type-parameter">Worker</span><span class="tsd-signature-symbol"> extends </span><a href="IWorker.html" class="tsd-signature-type tsd-kind-interface">IWorker</a></h4>
d6b93f1a 27<div class="tsd-comment tsd-typography"><p>Type of worker.</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></ul></section>
6c525543 35<section class="tsd-panel tsd-hierarchy">
36<h4>Hierarchy</h4>
37<ul class="tsd-hierarchy">
a6b5c73c 38<li><span class="target">IWorkerNode</span></li></ul></section><aside class="tsd-sources">
6c525543 39<ul>
7ab352a6 40<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L211">src/pools/worker.ts:211</a></li></ul></aside>
6c525543 41<section class="tsd-panel-group tsd-index-group">
42<section class="tsd-panel tsd-index-panel">
43<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
44<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
45<div class="tsd-accordion-details">
46<section class="tsd-index-section">
47<h3 class="tsd-index-heading">Properties</h3>
a6b5c73c 48<div class="tsd-index-list"><a href="IWorkerNode.html#clearTasksQueue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>clear<wbr/>Tasks<wbr/>Queue</span></a>
76b46937 49<a href="IWorkerNode.html#closeChannel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>close<wbr/>Channel</span></a>
a6b5c73c 50<a href="IWorkerNode.html#dequeueTask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dequeue<wbr/>Task</span></a>
51<a href="IWorkerNode.html#enqueueTask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>enqueue<wbr/>Task</span></a>
c22b117f 52<a href="IWorkerNode.html#getTaskFunctionWorkerUsage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>get<wbr/>Task<wbr/>Function<wbr/>Worker<wbr/>Usage</span></a>
53<a href="IWorkerNode.html#hasBackPressure" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>has<wbr/>Back<wbr/>Pressure</span></a>
a6b5c73c 54<a href="IWorkerNode.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>
c22b117f 55<a href="IWorkerNode.html#messageChannel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>message<wbr/>Channel?</span></a>
31542ddf 56<a href="IWorkerNode.html#onBackPressure" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>on<wbr/>Back<wbr/>Pressure?</span></a>
969223ea 57<a href="IWorkerNode.html#onEmptyQueue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>on<wbr/>Empty<wbr/>Queue?</span></a>
31542ddf 58<a href="IWorkerNode.html#popTask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>pop<wbr/>Task</span></a>
a6b5c73c 59<a href="IWorkerNode.html#resetUsage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>reset<wbr/>Usage</span></a>
31542ddf 60<a href="IWorkerNode.html#tasksQueueBackPressureSize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tasks<wbr/>Queue<wbr/>Back<wbr/>Pressure<wbr/>Size</span></a>
a6b5c73c 61<a href="IWorkerNode.html#tasksQueueSize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tasks<wbr/>Queue<wbr/>Size</span></a>
31542ddf 62<a href="IWorkerNode.html#unshiftTask" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>unshift<wbr/>Task</span></a>
a6b5c73c 63<a href="IWorkerNode.html#usage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>usage</span></a>
64<a href="IWorkerNode.html#worker" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker</span></a>
6c525543 65</div></section></div></details></section></section>
66<section class="tsd-panel-group tsd-member-group">
67<h2>Properties</h2>
a6b5c73c 68<section class="tsd-panel tsd-member"><a id="clearTasksQueue" class="tsd-anchor"></a>
69<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>clear<wbr/>Tasks<wbr/>Queue</span><a href="#clearTasksQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
70<div class="tsd-signature"><span class="tsd-kind-property">clear<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-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div>
71<div class="tsd-type-declaration">
72<h4>Type declaration</h4>
73<ul class="tsd-parameters">
74<li class="tsd-parameter-signature">
75<ul class="tsd-signatures">
76<li class="tsd-signature" id="clearTasksQueue.__type.__type-1"><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>
77<li class="tsd-description">
68887e30 78<div class="tsd-comment tsd-typography"><p>Clears tasks queue.</p>
a6b5c73c 79</div>
80<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
81<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
82<ul>
7ab352a6 83<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L280">src/pools/worker.ts:280</a></li></ul></aside></section>
76b46937 84<section class="tsd-panel tsd-member"><a id="closeChannel" class="tsd-anchor"></a>
85<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>close<wbr/>Channel</span><a href="#closeChannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
86<div class="tsd-signature"><span class="tsd-kind-property">close<wbr/>Channel</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>
87<div class="tsd-type-declaration">
88<h4>Type declaration</h4>
89<ul class="tsd-parameters">
90<li class="tsd-parameter-signature">
91<ul class="tsd-signatures">
92<li class="tsd-signature" id="closeChannel.__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">void</span></li>
93<li class="tsd-description">
c22b117f 94<div class="tsd-comment tsd-typography"><p>Closes communication channel.</p>
76b46937 95</div>
96<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
97<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
98<ul>
7ab352a6 99<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L294">src/pools/worker.ts:294</a></li></ul></aside></section>
a6b5c73c 100<section class="tsd-panel tsd-member"><a id="dequeueTask" class="tsd-anchor"></a>
101<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>dequeue<wbr/>Task</span><a href="#dequeueTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
102<div class="tsd-signature"><span class="tsd-kind-property">dequeue<wbr/>Task</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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="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><span class="tsd-signature-symbol">)</span></div>
103<div class="tsd-type-declaration">
104<h4>Type declaration</h4>
105<ul class="tsd-parameters">
106<li class="tsd-parameter-signature">
107<ul class="tsd-signatures">
76b46937 108<li class="tsd-signature" id="dequeueTask.__type-4.__type-5"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="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></li>
a6b5c73c 109<li class="tsd-description">
68887e30 110<div class="tsd-comment tsd-typography"><p>Dequeue task.</p>
a6b5c73c 111</div>
112<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="Task.html" class="tsd-signature-type tsd-kind-interface">Task</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The dequeued task.</p>
113
114<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
115<ul>
7ab352a6 116<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L270">src/pools/worker.ts:270</a></li></ul></aside></section>
a6b5c73c 117<section class="tsd-panel tsd-member"><a id="enqueueTask" class="tsd-anchor"></a>
118<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>enqueue<wbr/>Task</span><a href="#enqueueTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
119<div class="tsd-signature"><span class="tsd-kind-property">enqueue<wbr/>Task</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></div>
120<div class="tsd-type-declaration">
121<h4>Type declaration</h4>
122<ul class="tsd-parameters">
123<li class="tsd-parameter-signature">
124<ul class="tsd-signatures">
76b46937 125<li class="tsd-signature" id="enqueueTask.__type-6.__type-7"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
a6b5c73c 126<li class="tsd-description">
68887e30 127<div class="tsd-comment tsd-typography"><p>Enqueue task.</p>
a6b5c73c 128</div>
129<div class="tsd-parameters">
130<h4 class="tsd-parameters-title">Parameters</h4>
131<ul class="tsd-parameter-list">
132<li>
133<h5><span class="tsd-kind-parameter">task</span>: <a href="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>
134<div class="tsd-comment tsd-typography"><p>The task to queue.</p>
323daa7f 135</div></li></ul></div>
00471704 136<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The tasks queue size.</p>
a6b5c73c 137
138<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
139<ul>
7ab352a6 140<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L257">src/pools/worker.ts:257</a></li></ul></aside></section>
c22b117f 141<section class="tsd-panel tsd-member"><a id="getTaskFunctionWorkerUsage" class="tsd-anchor"></a>
142<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>get<wbr/>Task<wbr/>Function<wbr/>Worker<wbr/>Usage</span><a href="#getTaskFunctionWorkerUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
143<div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Task<wbr/>Function<wbr/>Worker<wbr/>Usage</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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WorkerUsage.html" class="tsd-signature-type tsd-kind-interface">WorkerUsage</a><span class="tsd-signature-symbol">)</span></div>
52f4e813 144<div class="tsd-type-declaration">
145<h4>Type declaration</h4>
146<ul class="tsd-parameters">
147<li class="tsd-parameter-signature">
148<ul class="tsd-signatures">
c22b117f 149<li class="tsd-signature" id="getTaskFunctionWorkerUsage.__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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WorkerUsage.html" class="tsd-signature-type tsd-kind-interface">WorkerUsage</a></li>
52f4e813 150<li class="tsd-description">
c22b117f 151<div class="tsd-comment tsd-typography"><p>Gets task function worker usage statistics.</p>
52f4e813 152</div>
153<div class="tsd-parameters">
154<h4 class="tsd-parameters-title">Parameters</h4>
155<ul class="tsd-parameter-list">
156<li>
c22b117f 157<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
158<div class="tsd-comment tsd-typography"><p>The task function name.</p>
323daa7f 159</div></li></ul></div>
c22b117f 160<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WorkerUsage.html" class="tsd-signature-type tsd-kind-interface">WorkerUsage</a></h4><p>The task function worker usage statistics if the task function worker usage statistics are initialized, <code>undefined</code> otherwise.</p>
161
162<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
163<ul>
7ab352a6 164<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L301">src/pools/worker.ts:301</a></li></ul></aside></section>
c22b117f 165<section class="tsd-panel tsd-member"><a id="hasBackPressure" class="tsd-anchor"></a>
166<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>has<wbr/>Back<wbr/>Pressure</span><a href="#hasBackPressure" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
167<div class="tsd-signature"><span class="tsd-kind-property">has<wbr/>Back<wbr/>Pressure</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div>
168<div class="tsd-type-declaration">
169<h4>Type declaration</h4>
170<ul class="tsd-parameters">
171<li class="tsd-parameter-signature">
172<ul class="tsd-signatures">
173<li class="tsd-signature" id="hasBackPressure.__type-10.__type-11"><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>
174<li class="tsd-description">
175<div class="tsd-comment tsd-typography"><p>Whether the worker node has back pressure (i.e. its tasks queue is full).</p>
176</div>
177<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>
178
52f4e813 179<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
180<ul>
7ab352a6 181<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L286">src/pools/worker.ts:286</a></li></ul></aside></section>
202bcb6b 182<section class="tsd-panel tsd-member"><a id="info" class="tsd-anchor"></a>
a6b5c73c 183<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>
ac2cb9e2 184<div class="tsd-signature"><span class="tsd-kind-property">info</span><span class="tsd-signature-symbol">:</span> <a href="WorkerInfo.html" class="tsd-signature-type tsd-kind-interface">WorkerInfo</a></div>
68887e30 185<div class="tsd-comment tsd-typography"><p>Worker info.</p>
202bcb6b 186</div>
187<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
188<ul>
7ab352a6 189<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L219">src/pools/worker.ts:219</a></li></ul></aside></section>
c22b117f 190<section class="tsd-panel tsd-member"><a id="messageChannel" class="tsd-anchor"></a>
191<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>message<wbr/>Channel</span><a href="#messageChannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
192<div class="tsd-signature"><span class="tsd-kind-property">message<wbr/>Channel</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">MessageChannel</span></div>
953288ed 193<div class="tsd-comment tsd-typography"><p>Message channel (worker_threads only).</p>
c22b117f 194</div>
195<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
196<ul>
7ab352a6 197<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L227">src/pools/worker.ts:227</a></li></ul></aside></section>
31542ddf 198<section class="tsd-panel tsd-member"><a id="onBackPressure" class="tsd-anchor"></a>
199<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>on<wbr/>Back<wbr/>Pressure</span><a href="#onBackPressure" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7ab352a6 200<div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Back<wbr/>Pressure</span><span class="tsd-signature-symbol">?:</span> <a href="../types/WorkerNodeEventCallback.html" class="tsd-signature-type tsd-kind-type-alias">WorkerNodeEventCallback</a></div>
31542ddf 201<div class="tsd-comment tsd-typography"><p>Callback invoked when worker node tasks queue is back pressured.</p>
202</div>
7ab352a6 203<div class="tsd-comment tsd-typography">
204<h4>Param</h4><p>The worker id.</p>
205</div><aside class="tsd-sources">
31542ddf 206<ul>
7ab352a6 207<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L238">src/pools/worker.ts:238</a></li></ul></aside></section>
969223ea 208<section class="tsd-panel tsd-member"><a id="onEmptyQueue" class="tsd-anchor"></a>
209<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>on<wbr/>Empty<wbr/>Queue</span><a href="#onEmptyQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7ab352a6 210<div class="tsd-signature"><span class="tsd-kind-property">on<wbr/>Empty<wbr/>Queue</span><span class="tsd-signature-symbol">?:</span> <a href="../types/WorkerNodeEventCallback.html" class="tsd-signature-type tsd-kind-type-alias">WorkerNodeEventCallback</a></div>
969223ea 211<div class="tsd-comment tsd-typography"><p>Callback invoked when worker node tasks queue is empty.</p>
212</div>
7ab352a6 213<div class="tsd-comment tsd-typography">
214<h4>Param</h4><p>The worker id.</p>
215</div><aside class="tsd-sources">
969223ea 216<ul>
7ab352a6 217<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L244">src/pools/worker.ts:244</a></li></ul></aside></section>
31542ddf 218<section class="tsd-panel tsd-member"><a id="popTask" class="tsd-anchor"></a>
219<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>pop<wbr/>Task</span><a href="#popTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
220<div class="tsd-signature"><span class="tsd-kind-property">pop<wbr/>Task</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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="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><span class="tsd-signature-symbol">)</span></div>
221<div class="tsd-type-declaration">
222<h4>Type declaration</h4>
223<ul class="tsd-parameters">
224<li class="tsd-parameter-signature">
225<ul class="tsd-signatures">
7ab352a6 226<li class="tsd-signature" id="popTask.__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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="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></li>
31542ddf 227<li class="tsd-description">
228<div class="tsd-comment tsd-typography"><p>Pops a task from the tasks queue.</p>
229</div>
230<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="Task.html" class="tsd-signature-type tsd-kind-interface">Task</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The popped task.</p>
231
232<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
233<ul>
7ab352a6 234<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L276">src/pools/worker.ts:276</a></li></ul></aside></section>
a6b5c73c 235<section class="tsd-panel tsd-member"><a id="resetUsage" class="tsd-anchor"></a>
236<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>reset<wbr/>Usage</span><a href="#resetUsage" 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">reset<wbr/>Usage</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>
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">
7ab352a6 243<li class="tsd-signature" id="resetUsage.__type-14.__type-15"><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>
a6b5c73c 244<li class="tsd-description">
c22b117f 245<div class="tsd-comment tsd-typography"><p>Resets usage statistics.</p>
15d6dfaf 246</div>
a6b5c73c 247<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
248<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
249<ul>
7ab352a6 250<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L290">src/pools/worker.ts:290</a></li></ul></aside></section>
31542ddf 251<section class="tsd-panel tsd-member"><a id="tasksQueueBackPressureSize" class="tsd-anchor"></a>
252<h3 class="tsd-anchor-link"><span>tasks<wbr/>Queue<wbr/>Back<wbr/>Pressure<wbr/>Size</span><a href="#tasksQueueBackPressureSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
253<div class="tsd-signature"><span class="tsd-kind-property">tasks<wbr/>Queue<wbr/>Back<wbr/>Pressure<wbr/>Size</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
254<div class="tsd-comment tsd-typography"><p>Tasks queue back pressure size.
255This is the number of tasks that can be enqueued before the worker node has back pressure.</p>
256</div>
257<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
258<ul>
7ab352a6 259<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L232">src/pools/worker.ts:232</a></li></ul></aside></section>
a6b5c73c 260<section class="tsd-panel tsd-member"><a id="tasksQueueSize" class="tsd-anchor"></a>
261<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tasks<wbr/>Queue<wbr/>Size</span><a href="#tasksQueueSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
262<div class="tsd-signature"><span class="tsd-kind-property">tasks<wbr/>Queue<wbr/>Size</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">number</span><span class="tsd-signature-symbol">)</span></div>
263<div class="tsd-type-declaration">
264<h4>Type declaration</h4>
265<ul class="tsd-parameters">
266<li class="tsd-parameter-signature">
267<ul class="tsd-signatures">
7ab352a6 268<li class="tsd-signature" id="tasksQueueSize.__type-16.__type-17"><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>
a6b5c73c 269<li class="tsd-description">
68887e30 270<div class="tsd-comment tsd-typography"><p>Tasks queue size.</p>
a6b5c73c 271</div>
272<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The tasks queue size.</p>
273
274<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
6c525543 275<ul>
7ab352a6 276<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L250">src/pools/worker.ts:250</a></li></ul></aside></section>
31542ddf 277<section class="tsd-panel tsd-member"><a id="unshiftTask" class="tsd-anchor"></a>
278<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>unshift<wbr/>Task</span><a href="#unshiftTask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
279<div class="tsd-signature"><span class="tsd-kind-property">unshift<wbr/>Task</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></div>
280<div class="tsd-type-declaration">
281<h4>Type declaration</h4>
282<ul class="tsd-parameters">
283<li class="tsd-parameter-signature">
284<ul class="tsd-signatures">
7ab352a6 285<li class="tsd-signature" id="unshiftTask.__type-18.__type-19"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
31542ddf 286<li class="tsd-description">
287<div class="tsd-comment tsd-typography"><p>Prepends a task to the tasks queue.</p>
288</div>
289<div class="tsd-parameters">
290<h4 class="tsd-parameters-title">Parameters</h4>
291<ul class="tsd-parameter-list">
292<li>
293<h5><span class="tsd-kind-parameter">task</span>: <a href="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>
294<div class="tsd-comment tsd-typography"><p>The task to prepend.</p>
323daa7f 295</div></li></ul></div>
31542ddf 296<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The tasks queue size.</p>
297
298<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
299<ul>
7ab352a6 300<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L264">src/pools/worker.ts:264</a></li></ul></aside></section>
a97f9c80 301<section class="tsd-panel tsd-member"><a id="usage" class="tsd-anchor"></a>
302<h3 class="tsd-anchor-link"><span>usage</span><a href="#usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
303<div class="tsd-signature"><span class="tsd-kind-property">usage</span><span class="tsd-signature-symbol">:</span> <a href="WorkerUsage.html" class="tsd-signature-type tsd-kind-interface">WorkerUsage</a></div>
68887e30 304<div class="tsd-comment tsd-typography"><p>Worker usage statistics.</p>
a97f9c80 305</div>
306<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
307<ul>
7ab352a6 308<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L223">src/pools/worker.ts:223</a></li></ul></aside></section>
3bd6a82e 309<section class="tsd-panel tsd-member"><a id="worker" class="tsd-anchor"></a>
15d6dfaf 310<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</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>
8d1797ad 311<div class="tsd-signature"><span class="tsd-kind-property">worker</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type tsd-kind-type-parameter">Worker</span></div>
68887e30 312<div class="tsd-comment tsd-typography"><p>Worker.</p>
15d6dfaf 313</div>
314<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 315<ul>
7ab352a6 316<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/5a24d71/src/pools/worker.ts#L215">src/pools/worker.ts:215</a></li></ul></aside></section></section></div>
6c525543 317<div class="col-sidebar">
318<div class="page-menu">
319<div class="tsd-navigation settings">
320<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
15d6dfaf 321<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
6c525543 322<div class="tsd-accordion-details">
323<div class="tsd-filter-visibility">
324<h4 class="uppercase">Member Visibility</h4><form>
325<ul id="tsd-filter-options">
326<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
327<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
328<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
329<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
330<div class="tsd-theme-toggle">
3bd6a82e 331<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
6c525543 332<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 333<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
6c525543 334<div class="tsd-accordion-details">
335<ul>
a6b5c73c 336<li><a href="#clearTasksQueue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>clear<wbr/>Tasks<wbr/>Queue</span></a></li>
76b46937 337<li><a href="#closeChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>close<wbr/>Channel</span></a></li>
a6b5c73c 338<li><a href="#dequeueTask" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>dequeue<wbr/>Task</span></a></li>
339<li><a href="#enqueueTask" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>enqueue<wbr/>Task</span></a></li>
c22b117f 340<li><a href="#getTaskFunctionWorkerUsage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>get<wbr/>Task<wbr/>Function<wbr/>Worker<wbr/>Usage</span></a></li>
341<li><a href="#hasBackPressure" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>has<wbr/>Back<wbr/>Pressure</span></a></li>
202bcb6b 342<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>
c22b117f 343<li><a href="#messageChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>message<wbr/>Channel</span></a></li>
31542ddf 344<li><a href="#onBackPressure" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>on<wbr/>Back<wbr/>Pressure</span></a></li>
969223ea 345<li><a href="#onEmptyQueue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>on<wbr/>Empty<wbr/>Queue</span></a></li>
31542ddf 346<li><a href="#popTask" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>pop<wbr/>Task</span></a></li>
a6b5c73c 347<li><a href="#resetUsage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>reset<wbr/>Usage</span></a></li>
31542ddf 348<li><a href="#tasksQueueBackPressureSize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tasks<wbr/>Queue<wbr/>Back<wbr/>Pressure<wbr/>Size</span></a></li>
a6b5c73c 349<li><a href="#tasksQueueSize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>tasks<wbr/>Queue<wbr/>Size</span></a></li>
31542ddf 350<li><a href="#unshiftTask" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>unshift<wbr/>Task</span></a></li>
a97f9c80 351<li><a href="#usage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>usage</span></a></li>
352<li><a href="#worker" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker</span></a></li></ul></div></details></div>
6c525543 353<div class="site-menu">
7ab352a6 354<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>poolifier -<wbr/> v2.6.37</span></a>
6c525543 355<ul class="tsd-small-nested-navigation">
15d6dfaf 356<li><a href="../classes/AbstractPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Abstract<wbr/>Pool</span></a></li>
357<li><a href="../classes/AbstractWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Abstract<wbr/>Worker</span></a></li>
358<li><a href="../classes/CircularArray.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Circular<wbr/>Array</span></a></li>
359<li><a href="../classes/ClusterWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cluster<wbr/>Worker</span></a></li>
31542ddf 360<li><a href="../classes/Deque.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Deque</span></a></li>
15d6dfaf 361<li><a href="../classes/DynamicClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dynamic<wbr/>Cluster<wbr/>Pool</span></a></li>
362<li><a href="../classes/DynamicThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dynamic<wbr/>Thread<wbr/>Pool</span></a></li>
363<li><a href="../classes/FixedClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Fixed<wbr/>Cluster<wbr/>Pool</span></a></li>
364<li><a href="../classes/FixedThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Fixed<wbr/>Thread<wbr/>Pool</span></a></li>
f2d2c4a4 365<li><a href="../classes/Node.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Node</span></a></li>
15d6dfaf 366<li><a href="../classes/PoolEmitter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Pool<wbr/>Emitter</span></a></li>
15d6dfaf 367<li><a href="../classes/ThreadWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Thread<wbr/>Worker</span></a></li>
368<li><a href="../classes/WorkerChoiceStrategyContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span></a></li>
369<li><a href="ClusterPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Cluster<wbr/>Pool<wbr/>Options</span></a></li>
f05afd16 370<li><a href="EventLoopUtilizationMeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Event<wbr/>Loop<wbr/>Utilization<wbr/>Measurement<wbr/>Statistics</span></a></li>
15d6dfaf 371<li><a href="IPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IPool</span></a></li>
372<li><a href="IWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker</span></a></li>
373<li><a href="IWorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker<wbr/>Choice<wbr/>Strategy</span></a></li>
a6b5c73c 374<li><a href="IWorkerNode.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker<wbr/>Node</span></a></li>
f05afd16 375<li><a href="MeasurementOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Measurement<wbr/>Options</span></a></li>
376<li><a href="MeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Measurement<wbr/>Statistics</span></a></li>
377<li><a href="MeasurementStatisticsRequirements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Measurement<wbr/>Statistics<wbr/>Requirements</span></a></li>
15d6dfaf 378<li><a href="MessageValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Message<wbr/>Value</span></a></li>
379<li><a href="PoolInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Pool<wbr/>Info</span></a></li>
380<li><a href="PoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Pool<wbr/>Options</span></a></li>
381<li><a href="PromiseResponseWrapper.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Promise<wbr/>Response<wbr/>Wrapper</span></a></li>
aba8d9bd 382<li><a href="StrategyPolicy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Strategy<wbr/>Policy</span></a></li>
15d6dfaf 383<li><a href="Task.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task</span></a></li>
f05afd16 384<li><a href="TaskError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Error</span></a></li>
71056a0a 385<li><a href="TaskPerformance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Performance</span></a></li>
afa30fd0 386<li><a href="TaskStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Statistics</span></a></li>
f05afd16 387<li><a href="TaskStatisticsRequirements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Statistics<wbr/>Requirements</span></a></li>
15d6dfaf 388<li><a href="TasksQueueOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tasks<wbr/>Queue<wbr/>Options</span></a></li>
f45a3823 389<li><a href="ThreadPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Thread<wbr/>Pool<wbr/>Options</span></a></li>
15d6dfaf 390<li><a href="WorkerChoiceStrategyOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a></li>
ac2cb9e2 391<li><a href="WorkerInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Info</span></a></li>
15d6dfaf 392<li><a href="WorkerOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Options</span></a></li>
71056a0a 393<li><a href="WorkerStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Statistics</span></a></li>
f05afd16 394<li><a href="WorkerUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Usage</span></a></li>
323daa7f 395<li><a href="../types/ErrorHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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></svg><span>Error<wbr/>Handler</span></a></li>
396<li><a href="../types/ExitHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Exit<wbr/>Handler</span></a></li>
397<li><a href="../types/KillBehavior.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Kill<wbr/>Behavior</span></a></li>
398<li><a href="../types/KillHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Kill<wbr/>Handler</span></a></li>
399<li><a href="../types/Measurement.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Measurement</span></a></li>
400<li><a href="../types/MessageHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Message<wbr/>Handler</span></a></li>
401<li><a href="../types/OnlineHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Online<wbr/>Handler</span></a></li>
402<li><a href="../types/PoolEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Pool<wbr/>Event</span></a></li>
403<li><a href="../types/PoolType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Pool<wbr/>Type</span></a></li>
404<li><a href="../types/TaskAsyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Task<wbr/>Async<wbr/>Function</span></a></li>
405<li><a href="../types/TaskFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Task<wbr/>Function</span></a></li>
406<li><a href="../types/TaskFunctions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Task<wbr/>Functions</span></a></li>
407<li><a href="../types/TaskSyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Task<wbr/>Sync<wbr/>Function</span></a></li>
408<li><a href="../types/WorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy</span></a></li>
7ab352a6 409<li><a href="../types/WorkerNodeEventCallback.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Worker<wbr/>Node<wbr/>Event<wbr/>Callback</span></a></li>
323daa7f 410<li><a href="../types/WorkerType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Worker<wbr/>Type</span></a></li>
411<li><a href="../types/Writable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Writable</span></a></li>
15d6dfaf 412<li><a href="../variables/KillBehaviors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>Kill<wbr/>Behaviors</span></a></li>
f05afd16 413<li><a href="../variables/Measurements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Measurements</span></a></li>
15d6dfaf 414<li><a href="../variables/PoolEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Pool<wbr/>Events</span></a></li>
415<li><a href="../variables/PoolTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Pool<wbr/>Types</span></a></li>
416<li><a href="../variables/WorkerChoiceStrategies.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategies</span></a></li>
a97f9c80 417<li><a href="../variables/WorkerTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Worker<wbr/>Types</span></a></li>
418<li><a href="../functions/availableParallelism.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>available<wbr/>Parallelism</span></a></li></ul></nav></div></div></div>
6c525543 419<div class="tsd-generator">
323daa7f 420<p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
6c525543 421<div class="overlay"></div></body></html>