chore: v2.4.10
[poolifier.git] / docs / types / WorkerFunction.html
index 38cbd9796ac4e33cd252e360b2408742dde5bf48..caeec109e7b58dda36db48ddac0ff757ad623851 100644 (file)
 <li><a href="WorkerFunction.html">WorkerFunction</a></li></ul>
 <h1>Type alias WorkerFunction&lt;Data, Response&gt;</h1></div>
 <div class="tsd-signature">Worker<wbr/>Function<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <a href="WorkerSyncFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">WorkerSyncFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="WorkerAsyncFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">WorkerAsyncFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></div>
+<div class="tsd-comment tsd-typography"><p>Worker function that can be executed.
+This function can be synchronous or asynchronous.</p>
+</div>
 <section class="tsd-panel tsd-type-parameters">
 <h4>Type Parameters</h4>
 <ul class="tsd-type-parameters">
 <li>
-<h4>Data = <span class="tsd-signature-type">unknown</span></h4></li>
+<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>
 <li>
-<h4>Response = <span class="tsd-signature-type">unknown</span></h4></li></ul></section><aside class="tsd-sources">
+<h4>Response = <span class="tsd-signature-type">unknown</span></h4>
+<div class="tsd-comment tsd-typography"><p>Type of execution response. This can only be serializable data.</p>
+</div></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/ef41a6e/src/utility-types.ts#L51">src/utility-types.ts:51</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7254e41/src/utility-types.ts#L68">src/utility-types.ts:68</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">