chore: generate documentation

[poolifier.git] / docs / interfaces / PoolInfo.html

diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html
index 88b8c6d92226a27f01579d96df889b72e49c89bc..582782d9026baec0fc39a58b091d6c3784d5f345 100644 (file)
--- a/docs/interfaces/PoolInfo.html
+++ b/docs/interfaces/PoolInfo.html
@@ -24,7 +24,7 @@
 <ul class="tsd-hierarchy">
 <li><span class="target">PoolInfo</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L70">src/pools/pool.ts:70</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L70">src/pools/pool.ts:70</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">
@@ -58,22 +58,22 @@
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L83">src/pools/pool.ts:83</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L83">src/pools/pool.ts:83</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="executedTasks" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>executed<wbr/>Tasks</span><a href="#executedTasks" 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">executed<wbr/>Tasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L84">src/pools/pool.ts:84</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L84">src/pools/pool.ts:84</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="executingTasks" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>executing<wbr/>Tasks</span><a href="#executingTasks" 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">executing<wbr/>Tasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L85">src/pools/pool.ts:85</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L85">src/pools/pool.ts:85</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="failedTasks" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>failed<wbr/>Tasks</span><a href="#failedTasks" 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">failed<wbr/>Tasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L88">src/pools/pool.ts:88</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L88">src/pools/pool.ts:88</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="idleWorkerNodes" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>idle<wbr/>Worker<wbr/>Nodes</span><a href="#idleWorkerNodes" 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">idle<wbr/>Worker<wbr/>Nodes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -81,27 +81,27 @@
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L81">src/pools/pool.ts:81</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L81">src/pools/pool.ts:81</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="maxQueuedTasks" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>max<wbr/>Queued<wbr/>Tasks</span><a href="#maxQueuedTasks" 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/>Queued<wbr/>Tasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L87">src/pools/pool.ts:87</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L87">src/pools/pool.ts:87</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="maxSize" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>max<wbr/>Size</span><a href="#maxSize" 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/>Size</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L75">src/pools/pool.ts:75</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L75">src/pools/pool.ts:75</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="minSize" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>min<wbr/>Size</span><a href="#minSize" 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">min<wbr/>Size</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L74">src/pools/pool.ts:74</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L74">src/pools/pool.ts:74</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="queuedTasks" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>queued<wbr/>Tasks</span><a href="#queuedTasks" 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">queued<wbr/>Tasks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L86">src/pools/pool.ts:86</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L86">src/pools/pool.ts:86</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> <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> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">average</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">maximum</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">median</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">minimum</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -117,12 +117,12 @@
 <li class="tsd-parameter">
 <h5><span class="tsd-kind-property">minimum</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L89">src/pools/pool.ts:89</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L89">src/pools/pool.ts:89</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;fixed&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dynamic&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L72">src/pools/pool.ts:72</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L72">src/pools/pool.ts:72</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="utilization" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>utilization</span><a href="#utilization" 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">utilization</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -130,12 +130,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/6cc77e2/src/pools/pool.ts#L77">src/pools/pool.ts:77</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L77">src/pools/pool.ts:77</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="version" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>version</span><a href="#version" 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">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L71">src/pools/pool.ts:71</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L71">src/pools/pool.ts:71</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> <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> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">average</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">maximum</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">median</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">minimum</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
@@ -151,12 +151,12 @@
 <li class="tsd-parameter">
 <h5><span class="tsd-kind-property">minimum</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L95">src/pools/pool.ts:95</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L95">src/pools/pool.ts:95</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="worker" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>worker</span><a href="#worker" 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</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;cluster&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;thread&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6cc77e2/src/pools/pool.ts#L73">src/pools/pool.ts:73</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L73">src/pools/pool.ts:73</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="workerNodes" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>worker<wbr/>Nodes</span><a href="#workerNodes" 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/>Nodes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -164,7 +164,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/6cc77e2/src/pools/pool.ts#L79">src/pools/pool.ts:79</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/18fea9f/src/pools/pool.ts#L79">src/pools/pool.ts:79</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">