chore: generate documentation

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

diff --git a/docs/interfaces/WorkerNode.html b/docs/interfaces/WorkerNode.html
index e9a8013d81ba7fdf0a813f611519a6c7f4b4a060..830bc2c932990619c7e3f43cf4575f325f140fa7 100644 (file)
--- a/docs/interfaces/WorkerNode.html
+++ b/docs/interfaces/WorkerNode.html
@@ -14,7 +14,7 @@
 <ul class="tsd-breadcrumb">
 <li><a href="../index.html">poolifier</a></li>
 <li><a href="WorkerNode.html">WorkerNode</a></li></ul>
-<h1>Interface WorkerNode&lt;Worker, Data&gt;</h1></div>
+<h1>Interface WorkerNode&lt;Worker, Data&gt;<code class="tsd-tag ts-flagInternal">Internal</code> </h1></div>
 <section class="tsd-panel tsd-comment">
 <div class="tsd-comment tsd-typography"><p>Worker node interface.</p>
 </div></section> 
@@ -22,15 +22,19 @@
 <h4>Type Parameters</h4>
 <ul class="tsd-type-parameters">
 <li>
-<h4>Worker<span class="tsd-signature-symbol"> extends </span><a href="IWorker.html" class="tsd-signature-type" data-tsd-kind="Interface">IWorker</a></h4></li>
+<h4>Worker<span class="tsd-signature-symbol"> extends </span><a href="IWorker.html" class="tsd-signature-type" data-tsd-kind="Interface">IWorker</a></h4>
+<div class="tsd-comment tsd-typography"><p>Type of worker.</p>
+</div></li>
 <li>
-<h4>Data = <span class="tsd-signature-type">unknown</span></h4></li></ul></section> 
+<h4>Data = <span class="tsd-signature-type">unknown</span></h4>
+<div class="tsd-comment tsd-typography"><p>Type of data sent to the worker. This can only be serializable data.</p>
+</div></li></ul></section> 
 <section class="tsd-panel tsd-hierarchy">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">WorkerNode</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/e7339cf/src/pools/worker.ts#L85">src/pools/worker.ts:85</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0270635/src/pools/worker.ts#L113">src/pools/worker.ts:113</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">
@@ -45,20 +49,26 @@
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tasksQueue" class="tsd-anchor"></a>
-<h3 class="tsd-anchor-link"><span>tasks<wbr/>Queue</span><a href="#tasksQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
-<div class="tsd-signature">tasks<wbr/>Queue<span class="tsd-signature-symbol">:</span> <a href="Task.html" class="tsd-signature-type" data-tsd-kind="Interface">Task</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
+<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>tasks<wbr/>Queue</span><a href="#tasksQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
+<div class="tsd-signature">tasks<wbr/>Queue<span class="tsd-signature-symbol">:</span> <a href="Task.html" class="tsd-signature-type" data-tsd-kind="Interface">Task</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div>
+<div class="tsd-comment tsd-typography"><p>Worker node tasks queue.</p>
+</div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/e7339cf/src/pools/worker.ts#L88">src/pools/worker.ts:88</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0270635/src/pools/worker.ts#L125">src/pools/worker.ts:125</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tasksUsage" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>tasks<wbr/>Usage</span><a href="#tasksUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
-<div class="tsd-signature">tasks<wbr/>Usage<span class="tsd-signature-symbol">:</span> <a href="TasksUsage.html" class="tsd-signature-type" data-tsd-kind="Interface">TasksUsage</a></div><aside class="tsd-sources">
+<div class="tsd-signature">tasks<wbr/>Usage<span class="tsd-signature-symbol">:</span> <a href="TasksUsage.html" class="tsd-signature-type" data-tsd-kind="Interface">TasksUsage</a></div>
+<div class="tsd-comment tsd-typography"><p>Worker node tasks usage statistics.</p>
+</div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/e7339cf/src/pools/worker.ts#L87">src/pools/worker.ts:87</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0270635/src/pools/worker.ts#L121">src/pools/worker.ts:121</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="worker" class="tsd-anchor"></a>
-<h3 class="tsd-anchor-link"><span>worker</span><a href="#worker" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
-<div class="tsd-signature">worker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Worker</span></div><aside class="tsd-sources">
+<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
+<div class="tsd-signature">worker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Worker</span></div>
+<div class="tsd-comment tsd-typography"><p>Worker node worker.</p>
+</div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/e7339cf/src/pools/worker.ts#L86">src/pools/worker.ts:86</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0270635/src/pools/worker.ts#L117">src/pools/worker.ts:117</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">