chore: generate documentation
[poolifier.git] / docs / interfaces / WorkerOptions.html
index bf069678aa6e8a7b324264cfada397c11abb1495..25eec6000f56dcd9df217e87387d7bc56d1e1e2b 100644 (file)
@@ -24,7 +24,7 @@
 <ul class="tsd-hierarchy">
 <li><span class="target">WorkerOptions</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/e9dc6ef/src/worker/worker-options.ts#L28">src/worker/worker-options.ts:28</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/worker-options.ts#L28">src/worker/worker-options.ts:28</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">
@@ -50,7 +50,7 @@
 <h4>Deprecated</h4><p>This option will be removed in the next major version.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/e9dc6ef/src/worker/worker-options.ts#L48">src/worker/worker-options.ts:48</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/worker-options.ts#L48">src/worker/worker-options.ts:48</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="killBehavior" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>kill<wbr/>Behavior</span><a href="#killBehavior" 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">kill<wbr/>Behavior</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;SOFT&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;HARD&quot;</span></div>
 <h4>Default Value</h4><p>KillBehaviors.SOFT</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/e9dc6ef/src/worker/worker-options.ts#L59">src/worker/worker-options.ts:59</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/worker-options.ts#L59">src/worker/worker-options.ts:59</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="killHandler" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>kill<wbr/>Handler</span><a href="#killHandler" 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">kill<wbr/>Handler</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">KillHandler</span></div>
+<div class="tsd-signature"><span class="tsd-kind-property">kill<wbr/>Handler</span><span class="tsd-signature-symbol">?:</span> <a href="../types/KillHandler.html" class="tsd-signature-type tsd-kind-type-alias">KillHandler</a></div>
 <div class="tsd-comment tsd-typography"><p>The function to call when a worker is killed.</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/e9dc6ef/src/worker/worker-options.ts#L63">src/worker/worker-options.ts:63</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/worker-options.ts#L63">src/worker/worker-options.ts:63</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="maxInactiveTime" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>max<wbr/>Inactive<wbr/>Time</span><a href="#maxInactiveTime" 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">max<wbr/>Inactive<wbr/>Time</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -90,7 +90,7 @@ when this timeout expires your tasks is interrupted before completion and remove
 <h4>Default Value</h4><p>60000</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/e9dc6ef/src/worker/worker-options.ts#L41">src/worker/worker-options.ts:41</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/worker-options.ts#L41">src/worker/worker-options.ts:41</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -158,6 +158,7 @@ when this timeout expires your tasks is interrupted before completion and remove
 <li><a href="../types/ErrorHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Error<wbr/>Handler</span></a></li>
 <li><a href="../types/ExitHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Exit<wbr/>Handler</span></a></li>
 <li><a href="../types/KillBehavior.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Kill<wbr/>Behavior</span></a></li>
+<li><a href="../types/KillHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Kill<wbr/>Handler</span></a></li>
 <li><a href="../types/Measurement.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Measurement</span></a></li>
 <li><a href="../types/MessageHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Message<wbr/>Handler</span></a></li>
 <li><a href="../types/OnlineHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Online<wbr/>Handler</span></a></li>