chore: generate documentation

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

diff --git a/docs/interfaces/TasksUsage.html b/docs/interfaces/TasksUsage.html
index 750516a0e6e7328a2e7bb8cb5b75db29bc33356a..01cb1f60dbb0d1a360920713d7b289a80c6c87ab 100644 (file)
--- a/docs/interfaces/TasksUsage.html
+++ b/docs/interfaces/TasksUsage.html
@@ -24,7 +24,7 @@
 <ul class="tsd-hierarchy">
 <li><span class="target">TasksUsage</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/worker.ts#L63">src/pools/worker.ts:63</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/pools/worker.ts#L64">src/pools/worker.ts:64</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">
@@ -34,6 +34,7 @@
 <h3 class="tsd-index-heading">Properties</h3>
 <div class="tsd-index-list"><a href="TasksUsage.html#avgRunTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>avg<wbr/>Run<wbr/>Time</span></a>
 <a href="TasksUsage.html#avgWaitTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>avg<wbr/>Wait<wbr/>Time</span></a>
+<a href="TasksUsage.html#elu" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>elu</span></a>
 <a href="TasksUsage.html#error" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>error</span></a>
 <a href="TasksUsage.html#medRunTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>med<wbr/>Run<wbr/>Time</span></a>
 <a href="TasksUsage.html#medWaitTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>med<wbr/>Wait<wbr/>Time</span></a>
@@ -53,7 +54,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/1659c4c/src/pools/worker.ts#L83">src/pools/worker.ts:83</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/pools/worker.ts#L84">src/pools/worker.ts:84</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="avgWaitTime" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>avg<wbr/>Wait<wbr/>Time</span><a href="#avgWaitTime" 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">avg<wbr/>Wait<wbr/>Time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -61,7 +62,15 @@
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/worker.ts#L99">src/pools/worker.ts:99</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/pools/worker.ts#L100">src/pools/worker.ts:100</a></li></ul></aside></section>
+<section class="tsd-panel tsd-member"><a id="elu" class="tsd-anchor"></a>
+<h3 class="tsd-anchor-link"><span>elu</span><a href="#elu" 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">elu</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">EventLoopUtilization</span></div>
+<div class="tsd-comment tsd-typography"><p>Event loop utilization.</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/a788de3/src/pools/worker.ts#L112">src/pools/worker.ts:112</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="error" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>error</span><a href="#error" 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</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -69,7 +78,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/1659c4c/src/pools/worker.ts#L107">src/pools/worker.ts:107</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/pools/worker.ts#L108">src/pools/worker.ts:108</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="medRunTime" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>med<wbr/>Run<wbr/>Time</span><a href="#medRunTime" 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">med<wbr/>Run<wbr/>Time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -77,7 +86,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/1659c4c/src/pools/worker.ts#L87">src/pools/worker.ts:87</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/pools/worker.ts#L88">src/pools/worker.ts:88</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="medWaitTime" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>med<wbr/>Wait<wbr/>Time</span><a href="#medWaitTime" 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">med<wbr/>Wait<wbr/>Time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -85,7 +94,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/1659c4c/src/pools/worker.ts#L103">src/pools/worker.ts:103</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/pools/worker.ts#L104">src/pools/worker.ts:104</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="ran" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>ran</span><a href="#ran" 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">ran</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -93,7 +102,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/1659c4c/src/pools/worker.ts#L67">src/pools/worker.ts:67</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/pools/worker.ts#L68">src/pools/worker.ts:68</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="runTime" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><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-type">number</span></div>
@@ -101,7 +110,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/1659c4c/src/pools/worker.ts#L75">src/pools/worker.ts:75</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/pools/worker.ts#L76">src/pools/worker.ts:76</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="runTimeHistory" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>run<wbr/>Time<wbr/>History</span><a href="#runTimeHistory" 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<wbr/>History</span><span class="tsd-signature-symbol">:</span> <a href="../classes/CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></div>
@@ -109,7 +118,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/1659c4c/src/pools/worker.ts#L79">src/pools/worker.ts:79</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/pools/worker.ts#L80">src/pools/worker.ts:80</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="running" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>running</span><a href="#running" 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">running</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
@@ -117,7 +126,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/1659c4c/src/pools/worker.ts#L71">src/pools/worker.ts:71</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/pools/worker.ts#L72">src/pools/worker.ts:72</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="waitTime" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><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-type">number</span></div>
@@ -125,7 +134,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/1659c4c/src/pools/worker.ts#L91">src/pools/worker.ts:91</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/pools/worker.ts#L92">src/pools/worker.ts:92</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="waitTimeHistory" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>wait<wbr/>Time<wbr/>History</span><a href="#waitTimeHistory" 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<wbr/>History</span><span class="tsd-signature-symbol">:</span> <a href="../classes/CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></div>
@@ -133,7 +142,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/1659c4c/src/pools/worker.ts#L95">src/pools/worker.ts:95</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/pools/worker.ts#L96">src/pools/worker.ts:96</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -155,6 +164,7 @@
 <ul>
 <li><a href="#avgRunTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>avg<wbr/>Run<wbr/>Time</span></a></li>
 <li><a href="#avgWaitTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>avg<wbr/>Wait<wbr/>Time</span></a></li>
+<li><a href="#elu" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>elu</span></a></li>
 <li><a href="#error" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>error</span></a></li>
 <li><a href="#medRunTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>med<wbr/>Run<wbr/>Time</span></a></li>
 <li><a href="#medWaitTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>med<wbr/>Wait<wbr/>Time</span></a></li>
@@ -187,8 +197,8 @@
 <li><a href="PoolInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Pool<wbr/>Info</span></a></li>
 <li><a href="PoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Pool<wbr/>Options</span></a></li>
 <li><a href="PromiseResponseWrapper.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Promise<wbr/>Response<wbr/>Wrapper</span></a></li>
-<li><a href="RequiredStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Required<wbr/>Statistics</span></a></li>
 <li><a href="Task.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task</span></a></li>
+<li><a href="TaskStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Statistics</span></a></li>
 <li><a href="TasksQueueOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tasks<wbr/>Queue<wbr/>Options</span></a></li>
 <li><a href="TasksUsage.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tasks<wbr/>Usage</span></a></li>
 <li><a href="WorkerChoiceStrategyOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a></li>