chore: generate documentation
[poolifier.git] / docs / interfaces / Task.html
index 5a5cddd69de0f9d02ae936ac75e05ffd5450c936..cf097693738ec9187ed7e2369c8b87fbdd279e9f 100644 (file)
@@ -14,7 +14,7 @@
 <ul class="tsd-breadcrumb">
 <li><a href="../index.html">poolifier</a></li>
 <li><a href="Task.html">Task</a></li></ul>
-<h1>Interface Task&lt;Data&gt;</h1></div>
+<h1>Interface Task&lt;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 task interface.</p>
 </div></section> 
 <h4>Type Parameters</h4>
 <ul class="tsd-type-parameters">
 <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">Task</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#L35">src/pools/worker.ts:35</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/14a2e53/src/pools/worker.ts#L38">src/pools/worker.ts:38</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">
 <div class="tsd-comment tsd-typography"><p>Worker task data.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/e7339cf/src/pools/worker.ts#L39">src/pools/worker.ts:39</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/14a2e53/src/pools/worker.ts#L42">src/pools/worker.ts:42</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>id</span><a href="#id" 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">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>Task UUID.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/e7339cf/src/pools/worker.ts#L43">src/pools/worker.ts:43</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/14a2e53/src/pools/worker.ts#L46">src/pools/worker.ts:46</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">