docs: generate documentation
[poolifier.git] / docs / interfaces / MessageValue.html
index c0615429f56ddb5f797d34ece7aad5394da53956..6883c713fe3eccaa67e39eb50173ca23b45ee027 100644 (file)
@@ -39,7 +39,7 @@
 <ul class="tsd-hierarchy">
 <li><span class="target">MessageValue</span></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L105">src/utility-types.ts:105</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L105">src/utility-types.ts:105</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">
@@ -75,7 +75,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/3466e75/src/utility-types.ts#L153">src/utility-types.ts:153</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L153">src/utility-types.ts:153</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="data" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>data</span><a href="#data" 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">data</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type tsd-kind-type-parameter">Data</span></div>
@@ -84,7 +84,7 @@
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Inherited from <a href="Task.html">Task</a>.<a href="Task.html#data">data</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L83">src/utility-types.ts:83</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L83">src/utility-types.ts:83</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="kill" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>kill</span><a href="#kill" 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">kill</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;success&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;SOFT&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;HARD&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;failure&quot;</span></div>
@@ -92,7 +92,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/3466e75/src/utility-types.ts#L110">src/utility-types.ts:110</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L110">src/utility-types.ts:110</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="name" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Inherited from <a href="Task.html">Task</a>.<a href="Task.html#name">name</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L79">src/utility-types.ts:79</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L79">src/utility-types.ts:79</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="port" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>port</span><a href="#port" 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">port</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">MessagePort</span></div>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L157">src/utility-types.ts:157</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L157">src/utility-types.ts:157</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="ready" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>ready</span><a href="#ready" 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">ready</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L149">src/utility-types.ts:149</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L149">src/utility-types.ts:149</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="statistics" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>statistics</span><a href="#statistics" 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">statistics</span><span class="tsd-signature-symbol">?:</span> <a href="WorkerStatistics.html" class="tsd-signature-type tsd-kind-interface">WorkerStatistics</a></div>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L145">src/utility-types.ts:145</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L145">src/utility-types.ts:145</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="taskFunction" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>task<wbr/>Function</span><a href="#taskFunction" 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">task<wbr/>Function</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L133">src/utility-types.ts:133</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L133">src/utility-types.ts:133</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="taskFunctionName" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>task<wbr/>Function<wbr/>Name</span><a href="#taskFunctionName" 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">task<wbr/>Function<wbr/>Name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L137">src/utility-types.ts:137</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L137">src/utility-types.ts:137</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="taskFunctionNames" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>task<wbr/>Function<wbr/>Names</span><a href="#taskFunctionNames" 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">task<wbr/>Function<wbr/>Names</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L141">src/utility-types.ts:141</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L141">src/utility-types.ts:141</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="taskFunctionOperation" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>task<wbr/>Function<wbr/>Operation</span><a href="#taskFunctionOperation" 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">task<wbr/>Function<wbr/>Operation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;add&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;default&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;remove&quot;</span></div>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L125">src/utility-types.ts:125</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L125">src/utility-types.ts:125</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="taskFunctionOperationStatus" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>task<wbr/>Function<wbr/>Operation<wbr/>Status</span><a href="#taskFunctionOperationStatus" 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">task<wbr/>Function<wbr/>Operation<wbr/>Status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L129">src/utility-types.ts:129</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L129">src/utility-types.ts:129</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="taskId" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>task<wbr/>Id</span><a href="#taskId" 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">task<wbr/>Id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Inherited from <a href="Task.html">Task</a>.<a href="Task.html#taskId">taskId</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L95">src/utility-types.ts:95</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L95">src/utility-types.ts:95</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="taskPerformance" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>task<wbr/>Performance</span><a href="#taskPerformance" 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">task<wbr/>Performance</span><span class="tsd-signature-symbol">?:</span> <a href="TaskPerformance.html" class="tsd-signature-type tsd-kind-interface">TaskPerformance</a></div>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L118">src/utility-types.ts:118</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L118">src/utility-types.ts:118</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="timestamp" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>timestamp</span><a href="#timestamp" 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">timestamp</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Inherited from <a href="Task.html">Task</a>.<a href="Task.html#timestamp">timestamp</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L91">src/utility-types.ts:91</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L91">src/utility-types.ts:91</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="transferList" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>transfer<wbr/>List</span><a href="#transferList" 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">transfer<wbr/>List</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">TransferListItem</span><span class="tsd-signature-symbol">[]</span></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Inherited from <a href="Task.html">Task</a>.<a href="Task.html#transferList">transferList</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L87">src/utility-types.ts:87</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L87">src/utility-types.ts:87</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="workerError" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>worker<wbr/>Error</span><a href="#workerError" 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/>Error</span><span class="tsd-signature-symbol">?:</span> <a href="WorkerError.html" class="tsd-signature-type tsd-kind-interface">WorkerError</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">ErrorData</span><span class="tsd-signature-symbol">&gt;</span></div>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L114">src/utility-types.ts:114</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L114">src/utility-types.ts:114</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited"><a id="workerId" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>worker<wbr/>Id</span><a href="#workerId" 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/>Id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Inherited from <a href="Task.html">Task</a>.<a href="Task.html#workerId">workerId</a></p>
 <ul>
-<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/3466e75/src/utility-types.ts#L75">src/utility-types.ts:75</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c10a26d/src/utility-types.ts#L75">src/utility-types.ts:75</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">