chore: generate documentation

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

diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html
index 98df631d731b04d526930670e09780a318d0a3d8..1165ce3c76c6c620b90caf5bd2e17a2f3bb1246f 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/ab80dc4/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/6b27295/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">
@@ -42,6 +42,7 @@
 <a href="PoolInfo.html#minSize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>min<wbr/>Size</span></a>
 <a href="PoolInfo.html#queuedTasks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>queued<wbr/>Tasks</span></a>
 <a href="PoolInfo.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>type</span></a>
+<a href="PoolInfo.html#utilization" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>utilization</span></a>
 <a href="PoolInfo.html#worker" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker</span></a>
 <a href="PoolInfo.html#workerNodes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Nodes</span></a>
 </div></section></div></details></section></section>
@@ -49,64 +50,81 @@
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member"><a id="busyWorkerNodes" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>busy<wbr/>Worker<wbr/>Nodes</span><a href="#busyWorkerNodes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">busy<wbr/>Worker<wbr/>Nodes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
+<div class="tsd-signature"><span class="tsd-kind-property">busy<wbr/>Worker<wbr/>Nodes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
+<div class="tsd-comment tsd-typography"><p>Pool busy worker nodes</p>
+</div>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/ab80dc4/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/6b27295/src/pools/pool.ts#L82">src/pools/pool.ts:82</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/ab80dc4/src/pools/pool.ts#L78">src/pools/pool.ts:78</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6b27295/src/pools/pool.ts#L83">src/pools/pool.ts:83</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/ab80dc4/src/pools/pool.ts#L79">src/pools/pool.ts:79</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6b27295/src/pools/pool.ts#L84">src/pools/pool.ts:84</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/ab80dc4/src/pools/pool.ts#L82">src/pools/pool.ts:82</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6b27295/src/pools/pool.ts#L87">src/pools/pool.ts:87</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><aside class="tsd-sources">
+<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>
+<div class="tsd-comment tsd-typography"><p>Pool idle worker nodes</p>
+</div>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/ab80dc4/src/pools/pool.ts#L76">src/pools/pool.ts:76</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6b27295/src/pools/pool.ts#L80">src/pools/pool.ts:80</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/ab80dc4/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/6b27295/src/pools/pool.ts#L86">src/pools/pool.ts:86</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/ab80dc4/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/6b27295/src/pools/pool.ts#L74">src/pools/pool.ts:74</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/ab80dc4/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/6b27295/src/pools/pool.ts#L73">src/pools/pool.ts:73</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/ab80dc4/src/pools/pool.ts#L80">src/pools/pool.ts:80</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6b27295/src/pools/pool.ts#L85">src/pools/pool.ts:85</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/ab80dc4/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/6b27295/src/pools/pool.ts#L71">src/pools/pool.ts:71</a></li></ul></aside></section>
+<section class="tsd-panel tsd-member"><a id="utilization" class="tsd-anchor"></a>
+<h3 class="tsd-anchor-link"><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>
+<div class="tsd-comment tsd-typography"><p>Pool utilization ratio.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6b27295/src/pools/pool.ts#L76">src/pools/pool.ts:76</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/ab80dc4/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/6b27295/src/pools/pool.ts#L72">src/pools/pool.ts:72</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><aside class="tsd-sources">
+<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>
+<div class="tsd-comment tsd-typography"><p>Pool total worker nodes</p>
+</div>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/ab80dc4/src/pools/pool.ts#L75">src/pools/pool.ts:75</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6b27295/src/pools/pool.ts#L78">src/pools/pool.ts:78</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -136,6 +154,7 @@
 <li><a href="#minSize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>min<wbr/>Size</span></a></li>
 <li><a href="#queuedTasks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>queued<wbr/>Tasks</span></a></li>
 <li><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>type</span></a></li>
+<li><a href="#utilization" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>utilization</span></a></li>
 <li><a href="#worker" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker</span></a></li>
 <li><a href="#workerNodes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Nodes</span></a></li></ul></div></details></div>
 <div class="site-menu">