repositories / poolifier.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
docs: generate documentation
[poolifier.git] / docs / interfaces / ThreadPoolOptions.html
diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html
index 3d17d7ac300a9007606d68e1d7a39eea24dcb6e3..14e1f036d8a6f1cccdb86c842643ede9951ba567 100644 (file)
--- a/docs/interfaces/ThreadPoolOptions.html
+++ b/docs/interfaces/ThreadPoolOptions.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>ThreadPoolOptions | 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">
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ThreadPoolOptions | poolifier - v2.7.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/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.3</a></div>
+<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.7.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="#icon-menu"></use></svg></a></div></div></header>
 <div class="container container-main">
 <div class="col-content">
@@ -26,7 +26,7 @@
 <ul class="tsd-hierarchy">
 <li><span class="target">ThreadPoolOptions</span></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/thread/fixed.ts#L18">src/pools/thread/fixed.ts:18</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L18">src/pools/thread/fixed.ts:18</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">
@@ -60,7 +60,7 @@
 </div><aside class="tsd-sources">
 <p>Inherited from <a href="PoolOptions.html">PoolOptions</a>.<a href="PoolOptions.html#enableEvents">enableEvents</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/pool.ts#L181">src/pools/pool.ts:181</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L181">src/pools/pool.ts:181</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="enableTasksQueue" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>enable<wbr/>Tasks<wbr/>Queue</span><a href="#enableTasksQueue" 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">enable<wbr/>Tasks<wbr/>Queue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -72,7 +72,7 @@
 </div><aside class="tsd-sources">
 <p>Inherited from <a href="PoolOptions.html">PoolOptions</a>.<a href="PoolOptions.html#enableTasksQueue">enableTasksQueue</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/pool.ts#L187">src/pools/pool.ts:187</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L187">src/pools/pool.ts:187</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="errorHandler" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>error<wbr/>Handler</span><a href="#errorHandler" 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">error<wbr/>Handler</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ErrorHandler.html" class="tsd-signature-type tsd-kind-type-alias">ErrorHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol">&gt;</span></div>
@@ -83,7 +83,7 @@
 </div><aside class="tsd-sources">
 <p>Inherited from <a href="PoolOptions.html">PoolOptions</a>.<a href="PoolOptions.html#errorHandler">errorHandler</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/pool.ts#L149">src/pools/pool.ts:149</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L149">src/pools/pool.ts:149</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="exitHandler" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>exit<wbr/>Handler</span><a href="#exitHandler" 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">exit<wbr/>Handler</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ExitHandler.html" class="tsd-signature-type tsd-kind-type-alias">ExitHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol">&gt;</span></div>
@@ -94,7 +94,7 @@
 </div><aside class="tsd-sources">
 <p>Inherited from <a href="PoolOptions.html">PoolOptions</a>.<a href="PoolOptions.html#exitHandler">exitHandler</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/pool.ts#L155">src/pools/pool.ts:155</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L155">src/pools/pool.ts:155</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="messageHandler" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>message<wbr/>Handler</span><a href="#messageHandler" 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">message<wbr/>Handler</span><span class="tsd-signature-symbol">?:</span> <a href="../types/MessageHandler.html" class="tsd-signature-type tsd-kind-type-alias">MessageHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol">&gt;</span></div>
@@ -105,7 +105,7 @@
 </div><aside class="tsd-sources">
 <p>Inherited from <a href="PoolOptions.html">PoolOptions</a>.<a href="PoolOptions.html#messageHandler">messageHandler</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/pool.ts#L143">src/pools/pool.ts:143</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L143">src/pools/pool.ts:143</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="onlineHandler" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>online<wbr/>Handler</span><a href="#onlineHandler" 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">online<wbr/>Handler</span><span class="tsd-signature-symbol">?:</span> <a href="../types/OnlineHandler.html" class="tsd-signature-type tsd-kind-type-alias">OnlineHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol">&gt;</span></div>
@@ -116,7 +116,7 @@
 </div><aside class="tsd-sources">
 <p>Inherited from <a href="PoolOptions.html">PoolOptions</a>.<a href="PoolOptions.html#onlineHandler">onlineHandler</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/pool.ts#L137">src/pools/pool.ts:137</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L137">src/pools/pool.ts:137</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="restartWorkerOnError" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>restart<wbr/>Worker<wbr/>On<wbr/>Error</span><a href="#restartWorkerOnError" 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">restart<wbr/>Worker<wbr/>On<wbr/>Error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -125,7 +125,7 @@
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Inherited from <a href="PoolOptions.html">PoolOptions</a>.<a href="PoolOptions.html#restartWorkerOnError">restartWorkerOnError</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/pool.ts#L175">src/pools/pool.ts:175</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L175">src/pools/pool.ts:175</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="startWorkers" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>start<wbr/>Workers</span><a href="#startWorkers" 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">start<wbr/>Workers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -137,7 +137,7 @@
 </div><aside class="tsd-sources">
 <p>Inherited from <a href="PoolOptions.html">PoolOptions</a>.<a href="PoolOptions.html#startWorkers">startWorkers</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/pool.ts#L161">src/pools/pool.ts:161</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L161">src/pools/pool.ts:161</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="tasksQueueOptions" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>tasks<wbr/>Queue<wbr/>Options</span><a href="#tasksQueueOptions" 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">tasks<wbr/>Queue<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <a href="TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></div>
@@ -146,7 +146,7 @@
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Inherited from <a href="PoolOptions.html">PoolOptions</a>.<a href="PoolOptions.html#tasksQueueOptions">tasksQueueOptions</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/pool.ts#L191">src/pools/pool.ts:191</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L191">src/pools/pool.ts:191</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="workerChoiceStrategy" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>worker<wbr/>Choice<wbr/>Strategy</span><a href="#workerChoiceStrategy" 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">worker<wbr/>Choice<wbr/>Strategy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;ROUND_ROBIN&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;LEAST_USED&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;LEAST_BUSY&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;LEAST_ELU&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;FAIR_SHARE&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;WEIGHTED_ROUND_ROBIN&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;INTERLEAVED_WEIGHTED_ROUND_ROBIN&quot;</span></div>
@@ -158,7 +158,7 @@
 </div><aside class="tsd-sources">
 <p>Inherited from <a href="PoolOptions.html">PoolOptions</a>.<a href="PoolOptions.html#workerChoiceStrategy">workerChoiceStrategy</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/pool.ts#L167">src/pools/pool.ts:167</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L167">src/pools/pool.ts:167</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="workerChoiceStrategyOptions" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span><a href="#workerChoiceStrategyOptions" 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">worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <a href="WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></div>
@@ -167,7 +167,7 @@
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Inherited from <a href="PoolOptions.html">PoolOptions</a>.<a href="PoolOptions.html#workerChoiceStrategyOptions">workerChoiceStrategyOptions</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/pool.ts#L171">src/pools/pool.ts:171</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/pool.ts#L171">src/pools/pool.ts:171</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="workerOptions" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>worker<wbr/>Options</span><a href="#workerOptions" 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">worker<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">WorkerOptions</span></div>
@@ -177,7 +177,7 @@
 <h4>See</h4><p><a href="https://nodejs.org/api/worker_threads.html#new-workerfilename-options">https://nodejs.org/api/worker_threads.html#new-workerfilename-options</a></p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/eeb1f96/src/pools/thread/fixed.ts#L24">src/pools/thread/fixed.ts:24</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/pools/thread/fixed.ts#L24">src/pools/thread/fixed.ts:24</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -210,7 +210,7 @@
 <li><a href="#workerChoiceStrategyOptions" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a></li>
 <li><a href="#workerOptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Options</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.3</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.4</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>
Fast and small Node.js thread pool implementation mirror - https://github.com/poolifier/poolifier