docs: generate documentation
[poolifier.git] / docs / interfaces / WorkerChoiceStrategyOptions.html
index 47a0d1021a003f5c0105a4dd4660f33ab8201c40..b6331292be2dee3495b7f487a05baff89b22ea05 100644 (file)
@@ -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>WorkerChoiceStrategyOptions | 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>WorkerChoiceStrategyOptions | 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">WorkerChoiceStrategyOptions</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2030d17/src/pools/selection-strategies/selection-strategies-types.ts#L69">src/pools/selection-strategies/selection-strategies-types.ts:69</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/selection-strategies/selection-strategies-types.ts#L69">src/pools/selection-strategies/selection-strategies-types.ts:69</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>Event loop utilization options.</p>
 </div>
 <div class="tsd-comment tsd-typography">
-<h4>Default Value</h4><pre><code class="language-ts"><span class="hl-0">{ </span><span class="hl-10">median</span><span class="hl-0">: </span><span class="hl-4">false</span><span class="hl-0"> }</span>
+<h4>Default Value</h4><pre><code class="language-ts"><span class="hl-0">{ </span><span class="hl-6">median</span><span class="hl-0">: </span><span class="hl-4">false</span><span class="hl-0"> }</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/pools/selection-strategies/selection-strategies-types.ts#L97">src/pools/selection-strategies/selection-strategies-types.ts:97</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/selection-strategies/selection-strategies-types.ts#L97">src/pools/selection-strategies/selection-strategies-types.ts:97</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="measurement" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>measurement</span><a href="#measurement" 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">measurement</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;runTime&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;waitTime&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;elu&quot;</span></div>
@@ -59,7 +59,7 @@
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2030d17/src/pools/selection-strategies/selection-strategies-types.ts#L79">src/pools/selection-strategies/selection-strategies-types.ts:79</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/selection-strategies/selection-strategies-types.ts#L79">src/pools/selection-strategies/selection-strategies-types.ts:79</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="retries" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>retries</span><a href="#retries" 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">retries</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
 </code><button>Copy</button></pre>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/2030d17/src/pools/selection-strategies/selection-strategies-types.ts#L75">src/pools/selection-strategies/selection-strategies-types.ts:75</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/selection-strategies/selection-strategies-types.ts#L75">src/pools/selection-strategies/selection-strategies-types.ts:75</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="runTime" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>run<wbr/>Time</span><a href="#runTime" 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">run<wbr/>Time</span><span class="tsd-signature-symbol">?:</span> <a href="MeasurementOptions.html" class="tsd-signature-type tsd-kind-interface">MeasurementOptions</a></div>
 <div class="tsd-comment tsd-typography"><p>Runtime options.</p>
 </div>
 <div class="tsd-comment tsd-typography">
-<h4>Default Value</h4><pre><code class="language-ts"><span class="hl-0">{ </span><span class="hl-10">median</span><span class="hl-0">: </span><span class="hl-4">false</span><span class="hl-0"> }</span>
+<h4>Default Value</h4><pre><code class="language-ts"><span class="hl-0">{ </span><span class="hl-6">median</span><span class="hl-0">: </span><span class="hl-4">false</span><span class="hl-0"> }</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/pools/selection-strategies/selection-strategies-types.ts#L85">src/pools/selection-strategies/selection-strategies-types.ts:85</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/selection-strategies/selection-strategies-types.ts#L85">src/pools/selection-strategies/selection-strategies-types.ts:85</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="waitTime" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>wait<wbr/>Time</span><a href="#waitTime" 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">wait<wbr/>Time</span><span class="tsd-signature-symbol">?:</span> <a href="MeasurementOptions.html" class="tsd-signature-type tsd-kind-interface">MeasurementOptions</a></div>
 <div class="tsd-comment tsd-typography"><p>Wait time options.</p>
 </div>
 <div class="tsd-comment tsd-typography">
-<h4>Default Value</h4><pre><code class="language-ts"><span class="hl-0">{ </span><span class="hl-10">median</span><span class="hl-0">: </span><span class="hl-4">false</span><span class="hl-0"> }</span>
+<h4>Default Value</h4><pre><code class="language-ts"><span class="hl-0">{ </span><span class="hl-6">median</span><span class="hl-0">: </span><span class="hl-4">false</span><span class="hl-0"> }</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/pools/selection-strategies/selection-strategies-types.ts#L91">src/pools/selection-strategies/selection-strategies-types.ts:91</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/selection-strategies/selection-strategies-types.ts#L91">src/pools/selection-strategies/selection-strategies-types.ts:91</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="weights" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>weights</span><a href="#weights" 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">weights</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></div>
 A weight is tasks maximum execution time in milliseconds for a worker node.</p>
 </div>
 <div class="tsd-comment tsd-typography">
-<h4>Default Value</h4><pre><code class="language-ts"><span class="hl-3">Weights</span><span class="hl-0"> </span><span class="hl-3">computed</span><span class="hl-0"> </span><span class="hl-3">automatically</span><span class="hl-0"> </span><span class="hl-3">given</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-7">CPU</span><span class="hl-0"> </span><span class="hl-3">performance</span><span class="hl-0">.</span>
+<h4>Default Value</h4><pre><code class="language-ts"><span class="hl-3">Weights</span><span class="hl-0"> </span><span class="hl-3">computed</span><span class="hl-0"> </span><span class="hl-3">automatically</span><span class="hl-0"> </span><span class="hl-3">given</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-5">CPU</span><span class="hl-0"> </span><span class="hl-3">performance</span><span class="hl-0">.</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/pools/selection-strategies/selection-strategies-types.ts#L104">src/pools/selection-strategies/selection-strategies-types.ts:104</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/selection-strategies/selection-strategies-types.ts#L104">src/pools/selection-strategies/selection-strategies-types.ts:104</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -131,7 +131,7 @@ A weight is tasks maximum execution time in milliseconds for a worker node.</p>
 <li><a href="#waitTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>wait<wbr/>Time</span></a></li>
 <li><a href="#weights" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>weights</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>
@@ -143,7 +143,6 @@ A weight is tasks maximum execution time in milliseconds for a worker node.</p>
 <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>
@@ -154,6 +153,7 @@ A weight is tasks maximum execution time in milliseconds for a worker node.</p>
 <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>