repositories / poolifier.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
docs: generate documentation
[poolifier.git] / docs / interfaces / WorkerOptions.html
diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html
index 58a7d9e44d27b62e46e49c920dda26c413336307..ba94d197169cf950ddfaa9d48bac91686f955952 100644 (file)
--- a/docs/interfaces/WorkerOptions.html
+++ b/docs/interfaces/WorkerOptions.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkerOptions | poolifier - v2.7.2</title><meta name="description" content="Documentation for poolifier"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkerOptions | poolifier - v2.7.3</title><meta name="description" content="Documentation for poolifier"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
 <div class="tsd-toolbar-contents container">
 <div class="table-cell" id="tsd-search" data-base="..">
 <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
@@ -6,7 +6,7 @@
 <div id="tsd-toolbar-links"></div></div>
 <ul class="results">
 <li class="state loading">Preparing search index...</li>
-<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.7.2</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.7.3</a></div>
 <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-content">
@@ -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/2030d17/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/eeb1f96/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">
@@ -51,7 +51,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/2030d17/src/worker/worker-options.ts#L65">src/worker/worker-options.ts:65</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/worker/worker-options.ts#L65">src/worker/worker-options.ts:65</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>
@@ -63,11 +63,11 @@
 <p>This option only apply to the newly created workers.</p>
 </div>
 <div class="tsd-comment tsd-typography">
-<h4>Default Value</h4><pre><code class="language-ts"><span class="hl-3">KillBehaviors</span><span class="hl-0">.</span><span class="hl-7">SOFT</span>
+<h4>Default Value</h4><pre><code class="language-ts"><span class="hl-3">KillBehaviors</span><span class="hl-0">.</span><span class="hl-5">SOFT</span>
 </code><button>Copy</button></pre>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2030d17/src/worker/worker-options.ts#L39">src/worker/worker-options.ts:39</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/worker/worker-options.ts#L39">src/worker/worker-options.ts:39</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> <a href="../types/KillHandler.html" class="tsd-signature-type tsd-kind-type-alias">KillHandler</a></div>
@@ -77,7 +77,7 @@
 <h4>Default Value</h4><p><code>() =&gt; {}</code></p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2030d17/src/worker/worker-options.ts#L58">src/worker/worker-options.ts:58</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/worker/worker-options.ts#L58">src/worker/worker-options.ts:58</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>
@@ -95,7 +95,7 @@ when this timeout expires your tasks is interrupted before completion and remove
 </code><button>Copy</button></pre>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2030d17/src/worker/worker-options.ts#L52">src/worker/worker-options.ts:52</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/worker/worker-options.ts#L52">src/worker/worker-options.ts:52</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -120,7 +120,7 @@ when this timeout expires your tasks is interrupted before completion and remove
 <li><a href="#killHandler" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>kill<wbr/>Handler</span></a></li>
 <li><a href="#maxInactiveTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max<wbr/>Inactive<wbr/>Time</span></a></li></ul></div></details></div>
 <div class="site-menu">
-<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>poolifier - v2.7.2</span></a>
+<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>poolifier - v2.7.3</span></a>
 <ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
 <li><a href="../classes/AbstractPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AbstractPool</a></li>
 <li><a href="../classes/AbstractWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AbstractWorker</a></li>
@@ -132,7 +132,6 @@ when this timeout expires your tasks is interrupted before completion and remove
 <li><a href="../classes/FixedClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>FixedClusterPool</a></li>
 <li><a href="../classes/FixedThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>FixedThreadPool</a></li>
 <li><a href="../classes/Node.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Node</a></li>
-<li><a href="../classes/PoolEmitter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>PoolEmitter</a></li>
 <li><a href="../classes/ThreadWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ThreadWorker</a></li>
 <li><a href="../classes/WorkerChoiceStrategyContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>WorkerChoiceStrategyContext</a></li>
 <li><a href="ClusterPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ClusterPoolOptions</a></li>
@@ -143,6 +142,7 @@ when this timeout expires your tasks is interrupted before completion and remove
 <li><a href="IWorkerNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>IWorkerNode</a></li>
 <li><a href="MeasurementOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MeasurementOptions</a></li>
 <li><a href="MeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MeasurementStatistics</a></li>
+<li><a href="MeasurementStatisticsRequirements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MeasurementStatisticsRequirements</a></li>
 <li>Loading...</li></ul></nav></div></div></div>
 <div class="tsd-generator">
 <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
Fast and small Node.js thread pool implementation mirror - https://github.com/poolifier/poolifier