repositories / poolifier.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
docs: generate documentation
[poolifier.git] / docs / interfaces / IWorkerNode.html
CommitLineData
0b4e655c 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.45</title><meta name="description" content="Documentation for poolifier"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
6c525543 2<div class="tsd-toolbar-contents container">
3<div class="table-cell" id="tsd-search" data-base="..">
cb4889b4 4<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
6c525543 5<div class="field">
6<div id="tsd-toolbar-links"></div></div>
7<ul class="results">
8<li class="state loading">Preparing search index...</li>
0b4e655c 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.6.45</a></div>
cb4889b4 10<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header>
6c525543 11<div class="container container-main">
12<div class="col-content">
13<div class="tsd-page-title">
14<ul class="tsd-breadcrumb">
15<li><a href="../index.html">poolifier</a></li>
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>
134c1944 40<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L226">src/pools/worker.ts:226</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">
cb4889b4 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"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary>
6c525543 45<div class="tsd-accordion-details">
46<section class="tsd-index-section">
47<h3 class="tsd-index-heading">Properties</h3>
cb4889b4 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"><use href="#icon-1024"></use></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>
95d287d1 60<a href="IWorkerNode.html#strategyData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>strategy<wbr/>Data?</span></a>
31542ddf 61<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 62<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 63<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 64<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>
65<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 66</div></section></div></details></section></section>
67<section class="tsd-panel-group tsd-member-group">
68<h2>Properties</h2>
a6b5c73c 69<section class="tsd-panel tsd-member"><a id="clearTasksQueue" class="tsd-anchor"></a>
cb4889b4 70<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"><use href="#icon-anchor"></use></svg></a></h3>
a6b5c73c 71<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>
72<div class="tsd-type-declaration">
73<h4>Type declaration</h4>
74<ul class="tsd-parameters">
75<li class="tsd-parameter-signature">
76<ul class="tsd-signatures">
77<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>
78<li class="tsd-description">
68887e30 79<div class="tsd-comment tsd-typography"><p>Clears tasks queue.</p>
a6b5c73c 80</div>
81<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
82<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
83<ul>
134c1944 84<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L296">src/pools/worker.ts:296</a></li></ul></aside></section>
76b46937 85<section class="tsd-panel tsd-member"><a id="closeChannel" class="tsd-anchor"></a>
86<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>
87<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>
88<div class="tsd-type-declaration">
89<h4>Type declaration</h4>
90<ul class="tsd-parameters">
91<li class="tsd-parameter-signature">
92<ul class="tsd-signatures">
93<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>
94<li class="tsd-description">
c22b117f 95<div class="tsd-comment tsd-typography"><p>Closes communication channel.</p>
76b46937 96</div>
97<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
98<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
99<ul>
134c1944 100<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L310">src/pools/worker.ts:310</a></li></ul></aside></section>
a6b5c73c 101<section class="tsd-panel tsd-member"><a id="dequeueTask" class="tsd-anchor"></a>
102<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>
103<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>
104<div class="tsd-type-declaration">
105<h4>Type declaration</h4>
106<ul class="tsd-parameters">
107<li class="tsd-parameter-signature">
108<ul class="tsd-signatures">
76b46937 109<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 110<li class="tsd-description">
68887e30 111<div class="tsd-comment tsd-typography"><p>Dequeue task.</p>
a6b5c73c 112</div>
113<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>
114
115<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
116<ul>
134c1944 117<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L286">src/pools/worker.ts:286</a></li></ul></aside></section>
a6b5c73c 118<section class="tsd-panel tsd-member"><a id="enqueueTask" class="tsd-anchor"></a>
119<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>
120<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>
121<div class="tsd-type-declaration">
122<h4>Type declaration</h4>
123<ul class="tsd-parameters">
124<li class="tsd-parameter-signature">
125<ul class="tsd-signatures">
76b46937 126<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 127<li class="tsd-description">
68887e30 128<div class="tsd-comment tsd-typography"><p>Enqueue task.</p>
a6b5c73c 129</div>
130<div class="tsd-parameters">
131<h4 class="tsd-parameters-title">Parameters</h4>
132<ul class="tsd-parameter-list">
133<li>
134<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>
135<div class="tsd-comment tsd-typography"><p>The task to queue.</p>
cb4889b4 136</div>
137<div class="tsd-comment tsd-typography"></div></li></ul></div>
00471704 138<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The tasks queue size.</p>
a6b5c73c 139
140<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
141<ul>
134c1944 142<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L273">src/pools/worker.ts:273</a></li></ul></aside></section>
c22b117f 143<section class="tsd-panel tsd-member"><a id="getTaskFunctionWorkerUsage" class="tsd-anchor"></a>
144<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>
145<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 146<div class="tsd-type-declaration">
147<h4>Type declaration</h4>
148<ul class="tsd-parameters">
149<li class="tsd-parameter-signature">
150<ul class="tsd-signatures">
c22b117f 151<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 152<li class="tsd-description">
c22b117f 153<div class="tsd-comment tsd-typography"><p>Gets task function worker usage statistics.</p>
52f4e813 154</div>
155<div class="tsd-parameters">
156<h4 class="tsd-parameters-title">Parameters</h4>
157<ul class="tsd-parameter-list">
158<li>
c22b117f 159<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
160<div class="tsd-comment tsd-typography"><p>The task function name.</p>
cb4889b4 161</div>
162<div class="tsd-comment tsd-typography"></div></li></ul></div>
c22b117f 163<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>
164
165<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
166<ul>
134c1944 167<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L317">src/pools/worker.ts:317</a></li></ul></aside></section>
c22b117f 168<section class="tsd-panel tsd-member"><a id="hasBackPressure" class="tsd-anchor"></a>
169<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>
170<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>
171<div class="tsd-type-declaration">
172<h4>Type declaration</h4>
173<ul class="tsd-parameters">
174<li class="tsd-parameter-signature">
175<ul class="tsd-signatures">
176<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>
177<li class="tsd-description">
178<div class="tsd-comment tsd-typography"><p>Whether the worker node has back pressure (i.e. its tasks queue is full).</p>
179</div>
180<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>
181
52f4e813 182<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
183<ul>
134c1944 184<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L302">src/pools/worker.ts:302</a></li></ul></aside></section>
202bcb6b 185<section class="tsd-panel tsd-member"><a id="info" class="tsd-anchor"></a>
a6b5c73c 186<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 187<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 188<div class="tsd-comment tsd-typography"><p>Worker info.</p>
202bcb6b 189</div>
190<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
191<ul>
134c1944 192<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L234">src/pools/worker.ts:234</a></li></ul></aside></section>
c22b117f 193<section class="tsd-panel tsd-member"><a id="messageChannel" class="tsd-anchor"></a>
194<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>
195<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 196<div class="tsd-comment tsd-typography"><p>Message channel (worker_threads only).</p>
c22b117f 197</div>
198<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
199<ul>
134c1944 200<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L247">src/pools/worker.ts:247</a></li></ul></aside></section>
31542ddf 201<section class="tsd-panel tsd-member"><a id="onBackPressure" class="tsd-anchor"></a>
202<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 203<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 204<div class="tsd-comment tsd-typography"><p>Callback invoked when worker node tasks queue is back pressured.</p>
205</div>
c8a9d171 206<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
31542ddf 207<ul>
134c1944 208<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L256">src/pools/worker.ts:256</a></li></ul></aside></section>
969223ea 209<section class="tsd-panel tsd-member"><a id="onEmptyQueue" class="tsd-anchor"></a>
210<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 211<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 212<div class="tsd-comment tsd-typography"><p>Callback invoked when worker node tasks queue is empty.</p>
213</div>
c8a9d171 214<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
969223ea 215<ul>
134c1944 216<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L260">src/pools/worker.ts:260</a></li></ul></aside></section>
31542ddf 217<section class="tsd-panel tsd-member"><a id="popTask" class="tsd-anchor"></a>
218<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>
219<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>
220<div class="tsd-type-declaration">
221<h4>Type declaration</h4>
222<ul class="tsd-parameters">
223<li class="tsd-parameter-signature">
224<ul class="tsd-signatures">
7ab352a6 225<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 226<li class="tsd-description">
227<div class="tsd-comment tsd-typography"><p>Pops a task from the tasks queue.</p>
228</div>
229<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>
230
231<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
232<ul>
134c1944 233<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L292">src/pools/worker.ts:292</a></li></ul></aside></section>
a6b5c73c 234<section class="tsd-panel tsd-member"><a id="resetUsage" class="tsd-anchor"></a>
235<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>
236<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>
237<div class="tsd-type-declaration">
238<h4>Type declaration</h4>
239<ul class="tsd-parameters">
240<li class="tsd-parameter-signature">
241<ul class="tsd-signatures">
7ab352a6 242<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 243<li class="tsd-description">
c22b117f 244<div class="tsd-comment tsd-typography"><p>Resets usage statistics.</p>
15d6dfaf 245</div>
a6b5c73c 246<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
247<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
248<ul>
134c1944 249<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L306">src/pools/worker.ts:306</a></li></ul></aside></section>
95d287d1 250<section class="tsd-panel tsd-member"><a id="strategyData" class="tsd-anchor"></a>
251<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>strategy<wbr/>Data</span><a href="#strategyData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
da7631f8 252<div class="tsd-signature"><span class="tsd-kind-property">strategy<wbr/>Data</span><span class="tsd-signature-symbol">?:</span> <a href="StrategyData.html" class="tsd-signature-type tsd-kind-interface">StrategyData</a></div>
95d287d1 253<div class="tsd-comment tsd-typography"><p>Worker choice strategy data.
254This is used to store data that is specific to the worker choice strategy.</p>
255</div>
256<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
257<ul>
134c1944 258<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L243">src/pools/worker.ts:243</a></li></ul></aside></section>
31542ddf 259<section class="tsd-panel tsd-member"><a id="tasksQueueBackPressureSize" class="tsd-anchor"></a>
260<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>
261<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>
262<div class="tsd-comment tsd-typography"><p>Tasks queue back pressure size.
263This is the number of tasks that can be enqueued before the worker node has back pressure.</p>
264</div>
265<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
266<ul>
134c1944 267<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L252">src/pools/worker.ts:252</a></li></ul></aside></section>
a6b5c73c 268<section class="tsd-panel tsd-member"><a id="tasksQueueSize" class="tsd-anchor"></a>
269<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>
270<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>
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">
7ab352a6 276<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 277<li class="tsd-description">
68887e30 278<div class="tsd-comment tsd-typography"><p>Tasks queue size.</p>
a6b5c73c 279</div>
280<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The tasks queue size.</p>
281
282<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
6c525543 283<ul>
134c1944 284<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L266">src/pools/worker.ts:266</a></li></ul></aside></section>
31542ddf 285<section class="tsd-panel tsd-member"><a id="unshiftTask" class="tsd-anchor"></a>
286<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>
287<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>
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">
7ab352a6 293<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 294<li class="tsd-description">
295<div class="tsd-comment tsd-typography"><p>Prepends a task to the tasks queue.</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">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>
302<div class="tsd-comment tsd-typography"><p>The task to prepend.</p>
cb4889b4 303</div>
304<div class="tsd-comment tsd-typography"></div></li></ul></div>
31542ddf 305<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The tasks queue size.</p>
306
307<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
308<ul>
134c1944 309<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L280">src/pools/worker.ts:280</a></li></ul></aside></section>
a97f9c80 310<section class="tsd-panel tsd-member"><a id="usage" class="tsd-anchor"></a>
c8a9d171 311<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <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>
a97f9c80 312<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 313<div class="tsd-comment tsd-typography"><p>Worker usage statistics.</p>
a97f9c80 314</div>
315<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
316<ul>
134c1944 317<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L238">src/pools/worker.ts:238</a></li></ul></aside></section>
3bd6a82e 318<section class="tsd-panel tsd-member"><a id="worker" class="tsd-anchor"></a>
15d6dfaf 319<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 320<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 321<div class="tsd-comment tsd-typography"><p>Worker.</p>
15d6dfaf 322</div>
323<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 324<ul>
134c1944 325<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/001be8c/src/pools/worker.ts#L230">src/pools/worker.ts:230</a></li></ul></aside></section></section></div>
6c525543 326<div class="col-sidebar">
327<div class="page-menu">
328<div class="tsd-navigation settings">
329<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
cb4889b4 330<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary>
6c525543 331<div class="tsd-accordion-details">
332<div class="tsd-filter-visibility">
333<h4 class="uppercase">Member Visibility</h4><form>
334<ul id="tsd-filter-options">
cb4889b4 335<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>
336<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>
337<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>
338<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>
6c525543 339<div class="tsd-theme-toggle">
3bd6a82e 340<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 341<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 342<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 343<div class="tsd-accordion-details">
344<ul>
a6b5c73c 345<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 346<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 347<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>
348<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 349<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>
350<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 351<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 352<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 353<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 354<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 355<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 356<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>
95d287d1 357<li><a href="#strategyData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>strategy<wbr/>Data</span></a></li>
31542ddf 358<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 359<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 360<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 361<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>
362<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 363<div class="site-menu">
0b4e655c 364<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.6.45</span></a>
cb4889b4 365<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
366<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>
367<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>
368<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>
369<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>
370<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>
371<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>
372<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>
373<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>
374<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>
375<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>
376<li><a href="../classes/PoolEmitter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>PoolEmitter</a></li>
377<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>
378<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>
379<li><a href="ClusterPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ClusterPoolOptions</a></li>
380<li><a href="EventLoopUtilizationMeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EventLoopUtilizationMeasurementStatistics</a></li>
381<li><a href="IPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IPool</a></li>
382<li><a href="IWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IWorker</a></li>
383<li><a href="IWorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IWorkerChoiceStrategy</a></li>
384<li><a href="IWorkerNode.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IWorkerNode</a></li>
385<li><a href="MeasurementOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MeasurementOptions</a></li>
386<li><a href="MeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MeasurementStatistics</a></li>
387<li>Loading...</li></ul></nav></div></div></div>
6c525543 388<div class="tsd-generator">
323daa7f 389<p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
cb4889b4 390<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>
Fast and small Node.js thread pool implementation mirror - https://github.com/poolifier/poolifier