docs/interfaces/WorkerChoiceStrategyOptions.html

   1 <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkerChoiceStrategyOptions | poolifier - v4.4.4</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/icons.js" id="tsd-icons-script"></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";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</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="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><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 - v4.4.4</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="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">poolifier</a></li><li><a href="WorkerChoiceStrategyOptions.html">WorkerChoiceStrategyOptions</a></li></ul><h1>Interface WorkerChoiceStrategyOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Worker choice strategy options.</p>
   2 </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">WorkerChoiceStrategyOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="WorkerChoiceStrategyOptions.html#elu">elu</a><span class="tsd-signature-symbol">?: </span><a href="MeasurementOptions.html" class="tsd-signature-type tsd-kind-interface">MeasurementOptions</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="WorkerChoiceStrategyOptions.html#measurement">measurement</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;elu&quot;</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><br/><span>    </span><a class="tsd-kind-property" href="WorkerChoiceStrategyOptions.html#runTime">runTime</a><span class="tsd-signature-symbol">?: </span><a href="MeasurementOptions.html" class="tsd-signature-type tsd-kind-interface">MeasurementOptions</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="WorkerChoiceStrategyOptions.html#waitTime">waitTime</a><span class="tsd-signature-symbol">?: </span><a href="MeasurementOptions.html" class="tsd-signature-type tsd-kind-interface">MeasurementOptions</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="WorkerChoiceStrategyOptions.html#weights">weights</a><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><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0f078e852d9050b00348b2c81b0ff0697da4a336/src/pools/selection-strategies/selection-strategies-types.ts#L80">src/pools/selection-strategies/selection-strategies-types.ts:80</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-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="WorkerChoiceStrategyOptions.html#elu" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>elu?</span></a>
   3 <a href="WorkerChoiceStrategyOptions.html#measurement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>measurement?</span></a>
   4 <a href="WorkerChoiceStrategyOptions.html#runTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>run<wbr/>Time?</span></a>
   5 <a href="WorkerChoiceStrategyOptions.html#waitTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wait<wbr/>Time?</span></a>
   6 <a href="WorkerChoiceStrategyOptions.html#weights" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>weights?</span></a>
   7 </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="elu" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>elu</span><a href="#elu" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">elu</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>Event loop utilization options.</p>
   8 </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Default Value"><h4 class="tsd-anchor-link"><a id="Default Value" class="tsd-anchor"></a>Default Value<a href="#Default Value" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">{ </span><span class="hl-10">median</span><span class="hl-2">: </span><span class="hl-1">false</span><span class="hl-2"> }</span>
   9 </code><button type="button">Copy</button></pre>
  10
  11 </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0f078e852d9050b00348b2c81b0ff0697da4a336/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="measurement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>measurement</span><a href="#measurement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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;elu&quot;</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></div><div class="tsd-comment tsd-typography"><p>Measurement to use in worker choice strategy supporting it.</p>
  12 </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0f078e852d9050b00348b2c81b0ff0697da4a336/src/pools/selection-strategies/selection-strategies-types.ts#L89">src/pools/selection-strategies/selection-strategies-types.ts:89</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">Optional</code> <code class="tsd-tag">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="../assets/icons.svg#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>
  13 </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Default Value"><h4 class="tsd-anchor-link"><a id="Default Value-1" class="tsd-anchor"></a>Default Value<a href="#Default Value-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">{ </span><span class="hl-10">median</span><span class="hl-2">: </span><span class="hl-1">false</span><span class="hl-2"> }</span>
  14 </code><button type="button">Copy</button></pre>
  15
  16 </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0f078e852d9050b00348b2c81b0ff0697da4a336/src/pools/selection-strategies/selection-strategies-types.ts#L94">src/pools/selection-strategies/selection-strategies-types.ts:94</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">Optional</code> <code class="tsd-tag">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="../assets/icons.svg#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>
  17 </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Default Value"><h4 class="tsd-anchor-link"><a id="Default Value-2" class="tsd-anchor"></a>Default Value<a href="#Default Value-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">{ </span><span class="hl-10">median</span><span class="hl-2">: </span><span class="hl-1">false</span><span class="hl-2"> }</span>
  18 </code><button type="button">Copy</button></pre>
  19
  20 </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0f078e852d9050b00348b2c81b0ff0697da4a336/src/pools/selection-strategies/selection-strategies-types.ts#L99">src/pools/selection-strategies/selection-strategies-types.ts:99</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">Optional</code><span>weights</span><a href="#weights" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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><div class="tsd-comment tsd-typography"><p>Worker weights to use for weighted round robin worker selection strategies.
  21 A weight is tasks maximum execution time in milliseconds for a worker node.</p>
  22 </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Default Value"><h4 class="tsd-anchor-link"><a id="Default Value-3" class="tsd-anchor"></a>Default Value<a href="#Default Value-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">Weights</span><span class="hl-2"> </span><span class="hl-0">computed</span><span class="hl-2"> </span><span class="hl-0">automatically</span><span class="hl-2"> </span><span class="hl-0">given</span><span class="hl-2"> </span><span class="hl-0">the</span><span class="hl-2"> </span><span class="hl-3">CPU</span><span class="hl-2"> </span><span class="hl-0">performance</span><span class="hl-2">.</span>
  23 </code><button type="button">Copy</button></pre>
  24
  25 </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/poolifier/poolifier/blob/0f078e852d9050b00348b2c81b0ff0697da4a336/src/pools/selection-strategies/selection-strategies-types.ts#L105">src/pools/selection-strategies/selection-strategies-types.ts:105</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#elu" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>elu</span></a><a href="#measurement" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>measurement</span></a><a href="#runTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>run<wbr/>Time</span></a><a href="#waitTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>wait<wbr/>Time</span></a><a href="#weights" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>weights</span></a></div></details></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="../assets/icons.svg#icon-1"></use></svg><span>poolifier - v4.4.4</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>