chore: generate documentation

[poolifier.git] / docs / interfaces / IWorkerNode.html

diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html
index 5bba3f71f291f084b376cacddbbd76f1bfb4663f..c56022665fe822dd9c7d292594e8cf5613a7e693 100644 (file)
--- a/docs/interfaces/IWorkerNode.html
+++ b/docs/interfaces/IWorkerNode.html
@@ -37,7 +37,7 @@
 <ul class="tsd-hierarchy">
 <li><span class="target">IWorkerNode</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/13a332e/src/pools/worker.ts#L228">src/pools/worker.ts:228</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3557031/src/pools/worker.ts#L200">src/pools/worker.ts:200</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -48,7 +48,7 @@
 <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>
 <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>
 <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>
-<a href="IWorkerNode.html#getTasksWorkerUsage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>get<wbr/>Tasks<wbr/>Worker<wbr/>Usage</span></a>
+<a href="IWorkerNode.html#getTaskWorkerUsage" 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/>Worker<wbr/>Usage</span></a>
 <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>
 <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>
 <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>
@@ -67,12 +67,12 @@
 <ul class="tsd-signatures">
 <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>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Worker node clear tasks queue.</p>
+<div class="tsd-comment tsd-typography"><p>Clears tasks queue.</p>
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/13a332e/src/pools/worker.ts#L263">src/pools/worker.ts:263</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3557031/src/pools/worker.ts#L235">src/pools/worker.ts:235</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="dequeueTask" class="tsd-anchor"></a>
 <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>
 <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>
@@ -83,13 +83,13 @@
 <ul class="tsd-signatures">
 <li class="tsd-signature" id="dequeueTask.__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">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>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Worker node dequeue task.</p>
+<div class="tsd-comment tsd-typography"><p>Dequeue task.</p>
 </div>
 <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>
 
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/13a332e/src/pools/worker.ts#L259">src/pools/worker.ts:259</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3557031/src/pools/worker.ts#L231">src/pools/worker.ts:231</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="enqueueTask" class="tsd-anchor"></a>
 <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>
 <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>
@@ -100,7 +100,7 @@
 <ul class="tsd-signatures">
 <li class="tsd-signature" id="enqueueTask.__type-4.__type-5"><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>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Worker node enqueue task.</p>
+<div class="tsd-comment tsd-typography"><p>Enqueue task.</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
@@ -114,18 +114,18 @@
 
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/13a332e/src/pools/worker.ts#L253">src/pools/worker.ts:253</a></li></ul></aside></section>
-<section class="tsd-panel tsd-member"><a id="getTasksWorkerUsage" class="tsd-anchor"></a>
-<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>get<wbr/>Tasks<wbr/>Worker<wbr/>Usage</span><a href="#getTasksWorkerUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Tasks<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>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3557031/src/pools/worker.ts#L225">src/pools/worker.ts:225</a></li></ul></aside></section>
+<section class="tsd-panel tsd-member"><a id="getTaskWorkerUsage" class="tsd-anchor"></a>
+<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>get<wbr/>Task<wbr/>Worker<wbr/>Usage</span><a href="#getTaskWorkerUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
+<div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Task<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>
 <div class="tsd-type-declaration">
 <h4>Type declaration</h4>
 <ul class="tsd-parameters">
 <li class="tsd-parameter-signature">
 <ul class="tsd-signatures">
-<li class="tsd-signature" id="getTasksWorkerUsage.__type-6.__type-7"><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>
+<li class="tsd-signature" id="getTaskWorkerUsage.__type-6.__type-7"><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>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Worker node get tasks usage statistics.</p>
+<div class="tsd-comment tsd-typography"><p>Gets task usage statistics.</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
@@ -135,15 +135,15 @@
 <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>
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/13a332e/src/pools/worker.ts#L271">src/pools/worker.ts:271</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3557031/src/pools/worker.ts#L243">src/pools/worker.ts:243</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="info" class="tsd-anchor"></a>
 <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>
 <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>
-<div class="tsd-comment tsd-typography"><p>Worker node worker info.</p>
+<div class="tsd-comment tsd-typography"><p>Worker info.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/13a332e/src/pools/worker.ts#L236">src/pools/worker.ts:236</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3557031/src/pools/worker.ts#L208">src/pools/worker.ts:208</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="resetUsage" class="tsd-anchor"></a>
 <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>
 <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>
@@ -154,12 +154,12 @@
 <ul class="tsd-signatures">
 <li class="tsd-signature" id="resetUsage.__type-8.__type-9"><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>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Worker node reset usage statistics .</p>
+<div class="tsd-comment tsd-typography"><p>Resets usage statistics .</p>
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/13a332e/src/pools/worker.ts#L267">src/pools/worker.ts:267</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3557031/src/pools/worker.ts#L239">src/pools/worker.ts:239</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="tasksQueueSize" class="tsd-anchor"></a>
 <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>
 <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>
@@ -170,29 +170,29 @@
 <ul class="tsd-signatures">
 <li class="tsd-signature" id="tasksQueueSize.__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">number</span></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Worker node tasks queue size.</p>
+<div class="tsd-comment tsd-typography"><p>Tasks queue size.</p>
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The tasks queue size.</p>
 
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/13a332e/src/pools/worker.ts#L246">src/pools/worker.ts:246</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3557031/src/pools/worker.ts#L218">src/pools/worker.ts:218</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="usage" class="tsd-anchor"></a>
 <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>
 <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>
-<div class="tsd-comment tsd-typography"><p>Worker node worker usage statistics.</p>
+<div class="tsd-comment tsd-typography"><p>Worker usage statistics.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/13a332e/src/pools/worker.ts#L240">src/pools/worker.ts:240</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3557031/src/pools/worker.ts#L212">src/pools/worker.ts:212</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="worker" class="tsd-anchor"></a>
 <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>
 <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>
-<div class="tsd-comment tsd-typography"><p>Worker node worker.</p>
+<div class="tsd-comment tsd-typography"><p>Worker.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/13a332e/src/pools/worker.ts#L232">src/pools/worker.ts:232</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3557031/src/pools/worker.ts#L204">src/pools/worker.ts:204</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -215,7 +215,7 @@
 <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>
 <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>
 <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>
-<li><a href="#getTasksWorkerUsage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>get<wbr/>Tasks<wbr/>Worker<wbr/>Usage</span></a></li>
+<li><a href="#getTaskWorkerUsage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>get<wbr/>Task<wbr/>Worker<wbr/>Usage</span></a></li>
 <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>
 <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>
 <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>