chore: v2.4.10

[poolifier.git] / docs / types / WorkerAsyncFunction.html

diff --git a/docs/types/WorkerAsyncFunction.html b/docs/types/WorkerAsyncFunction.html
index 7f8519fbe3f991027304b1704522c2398d30f06f..78927d36102d53ff23b1b4517e91ba4e3f8da61f 100644 (file)
--- a/docs/types/WorkerAsyncFunction.html
+++ b/docs/types/WorkerAsyncFunction.html
@@ -20,9 +20,13 @@
 <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>
+<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>
 <div class="tsd-type-declaration">
 <h4>Type declaration</h4>
 <ul class="tsd-parameters">
@@ -30,6 +34,9 @@
 <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
 <li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></li>
 <li class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Worker asynchronous function that can be executed.
+This function must return a promise.</p>
+</div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
@@ -37,7 +44,7 @@
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> data: <span class="tsd-signature-type">Data</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/ef41a6e/src/utility-types.ts#L48">src/utility-types.ts:48</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7254e41/src/utility-types.ts#L58">src/utility-types.ts:58</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">