| 3bd6a82e |
1 | <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AbstractWorker | poolifier</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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> |
| 6c525543 |
2 | <div class="tsd-toolbar-contents container"> |
| 3 | <div class="table-cell" id="tsd-search" data-base=".."> |
| 4 | <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"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> |
| 5 | <div class="field"> |
| 6 | <div id="tsd-toolbar-links"></div></div> |
| 7 | <ul class="results"> |
| 8 | <li class="state loading">Preparing search index...</li> |
| 9 | <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier</a></div> |
| 10 | <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"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> |
| 11 | <div class="container container-main"> |
| 12 | <div class="col-content"> |
| 13 | <div class="tsd-page-title"> |
| 14 | <ul class="tsd-breadcrumb"> |
| 15 | <li><a href="../index.html">poolifier</a></li> |
| 16 | <li><a href="AbstractWorker.html">AbstractWorker</a></li></ul> |
| 17 | <h1>Class AbstractWorker<MainWorker, Data, Response><code class="tsd-tag ts-flagAbstract">Abstract</code> </h1></div> |
| 18 | <section class="tsd-panel tsd-comment"> |
| 19 | <div class="tsd-comment tsd-typography"><p>Base class that implements some shared logic for all poolifier workers.</p> |
| 15d6dfaf |
20 | </div> |
| 21 | <div class="tsd-comment tsd-typography"></div></section> |
| fab6d3b5 |
22 | <section class="tsd-panel"> |
| 6c525543 |
23 | <h4>Type Parameters</h4> |
| fab6d3b5 |
24 | <ul class="tsd-type-parameter-list"> |
| 6c525543 |
25 | <li> |
| 3bd6a82e |
26 | <h4><span class="tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MessagePort</span></h4> |
| 6c525543 |
27 | <div class="tsd-comment tsd-typography"><p>Type of main worker.</p> |
| 15d6dfaf |
28 | </div> |
| 29 | <div class="tsd-comment tsd-typography"></div></li> |
| 6c525543 |
30 | <li> |
| 3bd6a82e |
31 | <h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4> |
| 6c525543 |
32 | <div class="tsd-comment tsd-typography"><p>Type of data this worker receives from pool's execution. This can only be serializable data.</p> |
| 15d6dfaf |
33 | </div> |
| 34 | <div class="tsd-comment tsd-typography"></div></li> |
| 6c525543 |
35 | <li> |
| 3bd6a82e |
36 | <h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4> |
| 6c525543 |
37 | <div class="tsd-comment tsd-typography"><p>Type of response the worker sends back to the main worker. This can only be serializable data.</p> |
| 15d6dfaf |
38 | </div> |
| 39 | <div class="tsd-comment tsd-typography"></div></li></ul></section> |
| 6c525543 |
40 | <section class="tsd-panel tsd-hierarchy"> |
| 41 | <h4>Hierarchy</h4> |
| 42 | <ul class="tsd-hierarchy"> |
| 3bd6a82e |
43 | <li><span class="tsd-signature-type ">AsyncResource</span> |
| 6c525543 |
44 | <ul class="tsd-hierarchy"> |
| 45 | <li><span class="target">AbstractWorker</span> |
| 46 | <ul class="tsd-hierarchy"> |
| 8d1797ad |
47 | <li><a href="ClusterWorker.html" class="tsd-signature-type tsd-kind-class">ClusterWorker</a></li> |
| 48 | <li><a href="ThreadWorker.html" class="tsd-signature-type tsd-kind-class">ThreadWorker</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources"> |
| 6c525543 |
49 | <ul> |
| afa30fd0 |
50 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L40">src/worker/abstract-worker.ts:40</a></li></ul></aside> |
| 6c525543 |
51 | <section class="tsd-panel-group tsd-index-group"> |
| 52 | <section class="tsd-panel tsd-index-panel"> |
| 53 | <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"> |
| 54 | <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary> |
| 55 | <div class="tsd-accordion-details"> |
| 56 | <section class="tsd-index-section"> |
| 57 | <h3 class="tsd-index-heading">Constructors</h3> |
| 15d6dfaf |
58 | <div class="tsd-index-list"><a href="AbstractWorker.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>constructor</span></a> |
| 6c525543 |
59 | </div></section> |
| 60 | <section class="tsd-index-section"> |
| 61 | <h3 class="tsd-index-heading">Properties</h3> |
| 15d6dfaf |
62 | <div class="tsd-index-list"><a href="AbstractWorker.html#aliveInterval" class="tsd-index-link tsd-is-protected"><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>alive<wbr/>Interval?</span></a> |
| 63 | <a href="AbstractWorker.html#isMain" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>is<wbr/>Main</span></a> |
| 64 | <a href="AbstractWorker.html#lastTaskTimestamp" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>last<wbr/>Task<wbr/>Timestamp</span></a> |
| 65 | <a href="AbstractWorker.html#mainWorker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>main<wbr/>Worker</span></a> |
| 66 | <a href="AbstractWorker.html#opts" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>opts</span></a> |
| afa30fd0 |
67 | <a href="AbstractWorker.html#statistics" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>statistics</span></a> |
| 15d6dfaf |
68 | <a href="AbstractWorker.html#taskFunctions" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>task<wbr/>Functions</span></a> |
| 6c525543 |
69 | </div></section> |
| 70 | <section class="tsd-index-section"> |
| 71 | <h3 class="tsd-index-heading">Methods</h3> |
| 15d6dfaf |
72 | <div class="tsd-index-list"><a href="AbstractWorker.html#asyncId" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>async<wbr/>Id</span></a> |
| afa30fd0 |
73 | <a href="AbstractWorker.html#beginTaskPerformance" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>begin<wbr/>Task<wbr/>Performance</span></a> |
| 15d6dfaf |
74 | <a href="AbstractWorker.html#bind" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>bind</span></a> |
| 75 | <a href="AbstractWorker.html#checkAlive" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Alive</span></a> |
| 76 | <a href="AbstractWorker.html#checkTaskFunctions" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Task<wbr/>Functions</span></a> |
| 77 | <a href="AbstractWorker.html#checkWorkerOptions" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Worker<wbr/>Options</span></a> |
| 78 | <a href="AbstractWorker.html#emitDestroy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit<wbr/>Destroy</span></a> |
| afa30fd0 |
79 | <a href="AbstractWorker.html#endTaskPerformance" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>end<wbr/>Task<wbr/>Performance</span></a> |
| 15d6dfaf |
80 | <a href="AbstractWorker.html#getMainWorker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Main<wbr/>Worker</span></a> |
| 81 | <a href="AbstractWorker.html#getTaskFunction" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Task<wbr/>Function</span></a> |
| 82 | <a href="AbstractWorker.html#handleError" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Error</span></a> |
| 83 | <a href="AbstractWorker.html#messageListener" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>message<wbr/>Listener</span></a> |
| 84 | <a href="AbstractWorker.html#runAsync" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Async</span></a> |
| 85 | <a href="AbstractWorker.html#runInAsyncScope" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>In<wbr/>Async<wbr/>Scope</span></a> |
| 86 | <a href="AbstractWorker.html#runSync" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Sync</span></a> |
| 87 | <a href="AbstractWorker.html#sendToMainWorker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>To<wbr/>Main<wbr/>Worker</span></a> |
| 88 | <a href="AbstractWorker.html#triggerAsyncId" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trigger<wbr/>Async<wbr/>Id</span></a> |
| 89 | <a href="AbstractWorker.html#bind-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>bind</span></a> |
| 6c525543 |
90 | </div></section></div></details></section></section> |
| 91 | <section class="tsd-panel-group tsd-member-group"> |
| 92 | <h2>Constructors</h2> |
| 3bd6a82e |
93 | <section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a> |
| 15d6dfaf |
94 | <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" 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> |
| 3bd6a82e |
95 | <ul class="tsd-signatures"> |
| 15d6dfaf |
96 | <li class="tsd-signature tsd-anchor-link" id="constructor.new_AbstractWorker"><span class="tsd-kind-constructor-signature">new <wbr/>Abstract<wbr/>Worker</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span>, <span class="tsd-kind-parameter">isMain</span>, <span class="tsd-kind-parameter">taskFunctions</span>, <span class="tsd-kind-parameter">mainWorker</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AbstractWorker.html" class="tsd-signature-type tsd-kind-class">AbstractWorker</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span><a href="#constructor.new_AbstractWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
97 | <li class="tsd-description"> |
| 98 | <div class="tsd-comment tsd-typography"><p>Constructs a new poolifier worker.</p> |
| 99 | </div> |
| fab6d3b5 |
100 | <section class="tsd-panel"> |
| 6c525543 |
101 | <h4>Type Parameters</h4> |
| fab6d3b5 |
102 | <ul class="tsd-type-parameter-list"> |
| 6c525543 |
103 | <li> |
| 3bd6a82e |
104 | <h4><span class="tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MessagePort</span></h4></li> |
| 6c525543 |
105 | <li> |
| 3bd6a82e |
106 | <h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4></li> |
| 6c525543 |
107 | <li> |
| 3bd6a82e |
108 | <h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section> |
| 6c525543 |
109 | <div class="tsd-parameters"> |
| 110 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 111 | <ul class="tsd-parameter-list"> |
| 112 | <li> |
| 3bd6a82e |
113 | <h5><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></h5> |
| 6c525543 |
114 | <div class="tsd-comment tsd-typography"><p>The type of async event.</p> |
| 15d6dfaf |
115 | </div> |
| 116 | <div class="tsd-comment tsd-typography"></div></li> |
| 6c525543 |
117 | <li> |
| 3bd6a82e |
118 | <h5><span class="tsd-kind-parameter">isMain</span>: <span class="tsd-signature-type">boolean</span></h5> |
| 6c525543 |
119 | <div class="tsd-comment tsd-typography"><p>Whether this is the main worker or not.</p> |
| 15d6dfaf |
120 | </div> |
| 121 | <div class="tsd-comment tsd-typography"></div></li> |
| 6c525543 |
122 | <li> |
| 2c94c3a5 |
123 | <h5><span class="tsd-kind-parameter">taskFunctions</span>: <a href="../types/WorkerFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerFunction</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><a href="../types/TaskFunctions.html" class="tsd-signature-type tsd-kind-type-alias">TaskFunctions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span></h5> |
| 124 | <div class="tsd-comment tsd-typography"><p>Task function(s) processed by the worker when the pool's <code>execution</code> function is invoked. The first function is the default function.</p> |
| 15d6dfaf |
125 | </div> |
| 126 | <div class="tsd-comment tsd-typography"></div></li> |
| 6c525543 |
127 | <li> |
| 3bd6a82e |
128 | <h5><span class="tsd-kind-parameter">mainWorker</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span></h5> |
| 6c525543 |
129 | <div class="tsd-comment tsd-typography"><p>Reference to main worker.</p> |
| 15d6dfaf |
130 | </div> |
| 131 | <div class="tsd-comment tsd-typography"></div></li> |
| 6c525543 |
132 | <li> |
| 8d1797ad |
133 | <h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/WorkerOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerOptions</a><span class="tsd-signature-symbol"> = ...</span></h5> |
| 6c525543 |
134 | <div class="tsd-comment tsd-typography"><p>Options for the worker.</p> |
| 15d6dfaf |
135 | </div> |
| 136 | <div class="tsd-comment tsd-typography"></div></li></ul></div> |
| 137 | <h4 class="tsd-returns-title">Returns <a href="AbstractWorker.html" class="tsd-signature-type tsd-kind-class">AbstractWorker</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span></h4> |
| 138 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
139 | <p>Overrides AsyncResource.constructor</p> |
| 140 | <ul> |
| afa30fd0 |
141 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L70">src/worker/abstract-worker.ts:70</a></li></ul></aside></li></ul></section></section> |
| 6c525543 |
142 | <section class="tsd-panel-group tsd-member-group"> |
| 143 | <h2>Properties</h2> |
| 3bd6a82e |
144 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="aliveInterval" class="tsd-anchor"></a> |
| 15d6dfaf |
145 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>alive<wbr/>Interval</span><a href="#aliveInterval" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad |
146 | <div class="tsd-signature"><span class="tsd-kind-property">alive<wbr/>Interval</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Timeout</span></div> |
| 6c525543 |
147 | <div class="tsd-comment tsd-typography"><p>Handler id of the <code>aliveInterval</code> worker alive check.</p> |
| 15d6dfaf |
148 | </div> |
| 149 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
150 | <ul> |
| afa30fd0 |
151 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L60">src/worker/abstract-worker.ts:60</a></li></ul></aside></section> |
| 3bd6a82e |
152 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="isMain" class="tsd-anchor"></a> |
| 15d6dfaf |
153 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>is<wbr/>Main</span><a href="#isMain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad |
154 | <div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Main</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> |
| 6c525543 |
155 | <div class="tsd-comment tsd-typography"><p>Whether this is the main worker or not.</p> |
| 15d6dfaf |
156 | </div> |
| 157 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
158 | <ul> |
| afa30fd0 |
159 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L72">src/worker/abstract-worker.ts:72</a></li></ul></aside></section> |
| 3bd6a82e |
160 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="lastTaskTimestamp" class="tsd-anchor"></a> |
| 15d6dfaf |
161 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>last<wbr/>Task<wbr/>Timestamp</span><a href="#lastTaskTimestamp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad |
162 | <div class="tsd-signature"><span class="tsd-kind-property">last<wbr/>Task<wbr/>Timestamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> |
| 6c525543 |
163 | <div class="tsd-comment tsd-typography"><p>Timestamp of the last task processed by this worker.</p> |
| 15d6dfaf |
164 | </div> |
| 165 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
166 | <ul> |
| afa30fd0 |
167 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L52">src/worker/abstract-worker.ts:52</a></li></ul></aside></section> |
| 3bd6a82e |
168 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="mainWorker" class="tsd-anchor"></a> |
| 15d6dfaf |
169 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>main<wbr/>Worker</span><a href="#mainWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad |
170 | <div class="tsd-signature"><span class="tsd-kind-property">main<wbr/>Worker</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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span></div> |
| 6c525543 |
171 | <div class="tsd-comment tsd-typography"><p>Reference to main worker.</p> |
| 15d6dfaf |
172 | </div> |
| 173 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
174 | <ul> |
| afa30fd0 |
175 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L76">src/worker/abstract-worker.ts:76</a></li></ul></aside></section> |
| 3bd6a82e |
176 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="opts" class="tsd-anchor"></a> |
| 15d6dfaf |
177 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>opts</span><a href="#opts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad |
178 | <div class="tsd-signature"><span class="tsd-kind-property">opts</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/WorkerOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerOptions</a><span class="tsd-signature-symbol"> = ...</span></div> |
| 6c525543 |
179 | <div class="tsd-comment tsd-typography"><p>Options for the worker.</p> |
| 15d6dfaf |
180 | </div> |
| 181 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
182 | <ul> |
| afa30fd0 |
183 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L77">src/worker/abstract-worker.ts:77</a></li></ul></aside></section> |
| 184 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="statistics" class="tsd-anchor"></a> |
| 185 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</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> |
| 186 | <div class="tsd-signature"><span class="tsd-kind-property">statistics</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">WorkerStatistics</span></div> |
| 187 | <div class="tsd-comment tsd-typography"><p>Performance statistics computation.</p> |
| 188 | </div> |
| 189 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 190 | <ul> |
| 191 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L56">src/worker/abstract-worker.ts:56</a></li></ul></aside></section> |
| 2c94c3a5 |
192 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="taskFunctions" class="tsd-anchor"></a> |
| 15d6dfaf |
193 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>task<wbr/>Functions</span><a href="#taskFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 2c94c3a5 |
194 | <div class="tsd-signature"><span class="tsd-kind-property">task<wbr/>Functions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../types/WorkerFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerFunction</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div> |
| 195 | <div class="tsd-comment tsd-typography"><p>Task function(s) processed by the worker when the pool's <code>execution</code> function is invoked.</p> |
| 15d6dfaf |
196 | </div> |
| 197 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 2c94c3a5 |
198 | <ul> |
| afa30fd0 |
199 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L48">src/worker/abstract-worker.ts:48</a></li></ul></aside></section></section> |
| 6c525543 |
200 | <section class="tsd-panel-group tsd-member-group"> |
| 201 | <h2>Methods</h2> |
| 3bd6a82e |
202 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="asyncId" class="tsd-anchor"></a> |
| 15d6dfaf |
203 | <h3 class="tsd-anchor-link"><span>async<wbr/>Id</span><a href="#asyncId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
204 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
205 | <li class="tsd-signature tsd-anchor-link" id="asyncId.asyncId-1"><span class="tsd-kind-call-signature">async<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asyncId.asyncId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
206 | <li class="tsd-description"> |
| fab6d3b5 |
207 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The unique <code>asyncId</code> assigned to the resource.</p> |
| 15d6dfaf |
208 | |
| 209 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
210 | <p>Inherited from AsyncResource.asyncId</p> |
| 211 | <ul> |
| 811dc01f |
212 | <li>Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:306</li></ul></aside></li></ul></section> |
| afa30fd0 |
213 | <section class="tsd-panel tsd-member tsd-is-private"><a id="beginTaskPerformance" class="tsd-anchor"></a> |
| 214 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>begin<wbr/>Task<wbr/>Performance</span><a href="#beginTaskPerformance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 215 | <ul class="tsd-signatures tsd-is-private"> |
| 216 | <li class="tsd-signature tsd-anchor-link" id="beginTaskPerformance.beginTaskPerformance-1"><span class="tsd-kind-call-signature">begin<wbr/>Task<wbr/>Performance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">TaskPerformance</span><a href="#beginTaskPerformance.beginTaskPerformance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 217 | <li class="tsd-description"> |
| 218 | <div class="tsd-parameters"> |
| 219 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 220 | <ul class="tsd-parameter-list"> |
| 221 | <li> |
| 222 | <h5><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/MessageValue.html" class="tsd-signature-type tsd-kind-interface">MessageValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MessagePort</span><span class="tsd-signature-symbol">></span></h5></li></ul></div> |
| 223 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">TaskPerformance</span></h4><aside class="tsd-sources"> |
| 224 | <ul> |
| 225 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L304">src/worker/abstract-worker.ts:304</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
226 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bind" class="tsd-anchor"></a> |
| 15d6dfaf |
227 | <h3 class="tsd-anchor-link"><span>bind</span><a href="#bind" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
228 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
229 | <li class="tsd-signature tsd-anchor-link" id="bind.bind-1"><span class="tsd-kind-call-signature">bind</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Func</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">Func</span><a href="#bind.bind-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
230 | <li class="tsd-description"> |
| 231 | <div class="tsd-comment tsd-typography"><p>Binds the given function to execute to this <code>AsyncResource</code>'s scope.</p> |
| 6c525543 |
232 | </div> |
| fab6d3b5 |
233 | <section class="tsd-panel"> |
| 6c525543 |
234 | <h4>Type Parameters</h4> |
| fab6d3b5 |
235 | <ul class="tsd-type-parameter-list"> |
| 6c525543 |
236 | <li> |
| 3bd6a82e |
237 | <h4><span class="tsd-kind-type-parameter">Func</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></h4></li></ul></section> |
| 6c525543 |
238 | <div class="tsd-parameters"> |
| 239 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 240 | <ul class="tsd-parameter-list"> |
| 241 | <li> |
| 3bd6a82e |
242 | <h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h5> |
| 6c525543 |
243 | <div class="tsd-comment tsd-typography"><p>The function to bind to the current <code>AsyncResource</code>.</p> |
| 15d6dfaf |
244 | </div> |
| 245 | <div class="tsd-comment tsd-typography"></div></li></ul></div> |
| 246 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h4> |
| 247 | <div class="tsd-comment tsd-typography"> |
| 248 | <h4>Since</h4><p>v14.8.0, v12.19.0</p> |
| 249 | </div><aside class="tsd-sources"> |
| 6c525543 |
250 | <p>Inherited from AsyncResource.bind</p> |
| 251 | <ul> |
| 811dc01f |
252 | <li>Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:283</li></ul></aside></li></ul></section> |
| 3bd6a82e |
253 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="checkAlive" class="tsd-anchor"></a> |
| 15d6dfaf |
254 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>check<wbr/>Alive</span><a href="#checkAlive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
255 | <ul class="tsd-signatures tsd-is-protected"> |
| 15d6dfaf |
256 | <li class="tsd-signature tsd-anchor-link" id="checkAlive.checkAlive-1"><span class="tsd-kind-call-signature">check<wbr/>Alive</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkAlive.checkAlive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
257 | <li class="tsd-description"> |
| 258 | <div class="tsd-comment tsd-typography"><p>Checks if the worker should be terminated, because its living too long.</p> |
| 259 | </div> |
| 15d6dfaf |
260 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 261 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
262 | <ul> |
| afa30fd0 |
263 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L199">src/worker/abstract-worker.ts:199</a></li></ul></aside></li></ul></section> |
| 2c94c3a5 |
264 | <section class="tsd-panel tsd-member tsd-is-private"><a id="checkTaskFunctions" class="tsd-anchor"></a> |
| 15d6dfaf |
265 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Task<wbr/>Functions</span><a href="#checkTaskFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
266 | <ul class="tsd-signatures tsd-is-private"> |
| 15d6dfaf |
267 | <li class="tsd-signature tsd-anchor-link" id="checkTaskFunctions.checkTaskFunctions-1"><span class="tsd-kind-call-signature">check<wbr/>Task<wbr/>Functions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskFunctions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkTaskFunctions.checkTaskFunctions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
268 | <li class="tsd-description"> |
| 2c94c3a5 |
269 | <div class="tsd-comment tsd-typography"><p>Checks if the <code>taskFunctions</code> parameter is passed to the constructor.</p> |
| 6c525543 |
270 | </div> |
| 271 | <div class="tsd-parameters"> |
| 272 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 273 | <ul class="tsd-parameter-list"> |
| 274 | <li> |
| 2c94c3a5 |
275 | <h5><span class="tsd-kind-parameter">taskFunctions</span>: <a href="../types/WorkerFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerFunction</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><a href="../types/TaskFunctions.html" class="tsd-signature-type tsd-kind-type-alias">TaskFunctions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span></h5> |
| 276 | <div class="tsd-comment tsd-typography"><p>The task function(s) parameter that should be checked.</p> |
| 15d6dfaf |
277 | </div> |
| 278 | <div class="tsd-comment tsd-typography"></div></li></ul></div> |
| 279 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 280 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
281 | <ul> |
| afa30fd0 |
282 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L115">src/worker/abstract-worker.ts:115</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
283 | <section class="tsd-panel tsd-member tsd-is-private"><a id="checkWorkerOptions" class="tsd-anchor"></a> |
| 15d6dfaf |
284 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Worker<wbr/>Options</span><a href="#checkWorkerOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
285 | <ul class="tsd-signatures tsd-is-private"> |
| 15d6dfaf |
286 | <li class="tsd-signature tsd-anchor-link" id="checkWorkerOptions.checkWorkerOptions-1"><span class="tsd-kind-call-signature">check<wbr/>Worker<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkWorkerOptions.checkWorkerOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
287 | <li class="tsd-description"> |
| 288 | <div class="tsd-parameters"> |
| 289 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 290 | <ul class="tsd-parameter-list"> |
| 291 | <li> |
| 8d1797ad |
292 | <h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/WorkerOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerOptions</a></h5></li></ul></div> |
| 6c525543 |
293 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"> |
| 294 | <ul> |
| afa30fd0 |
295 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L103">src/worker/abstract-worker.ts:103</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
296 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="emitDestroy" class="tsd-anchor"></a> |
| 15d6dfaf |
297 | <h3 class="tsd-anchor-link"><span>emit<wbr/>Destroy</span><a href="#emitDestroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
298 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
299 | <li class="tsd-signature tsd-anchor-link" id="emitDestroy.emitDestroy-1"><span class="tsd-kind-call-signature">emit<wbr/>Destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AbstractWorker.html" class="tsd-signature-type tsd-kind-class">AbstractWorker</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span><a href="#emitDestroy.emitDestroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
300 | <li class="tsd-description"> |
| 301 | <div class="tsd-comment tsd-typography"><p>Call all <code>destroy</code> hooks. This should only ever be called once. An error will |
| 302 | be thrown if it is called more than once. This <strong>must</strong> be manually called. If |
| 303 | the resource is left to be collected by the GC then the <code>destroy</code> hooks will |
| 304 | never be called.</p> |
| 6c525543 |
305 | </div> |
| fab6d3b5 |
306 | <h4 class="tsd-returns-title">Returns <a href="AbstractWorker.html" class="tsd-signature-type tsd-kind-class">AbstractWorker</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span></h4><p>A reference to <code>asyncResource</code>.</p> |
| 15d6dfaf |
307 | |
| 308 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
309 | <p>Inherited from AsyncResource.emitDestroy</p> |
| 310 | <ul> |
| 811dc01f |
311 | <li>Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:302</li></ul></aside></li></ul></section> |
| afa30fd0 |
312 | <section class="tsd-panel tsd-member tsd-is-private"><a id="endTaskPerformance" class="tsd-anchor"></a> |
| 313 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>end<wbr/>Task<wbr/>Performance</span><a href="#endTaskPerformance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 314 | <ul class="tsd-signatures tsd-is-private"> |
| 315 | <li class="tsd-signature tsd-anchor-link" id="endTaskPerformance.endTaskPerformance-1"><span class="tsd-kind-call-signature">end<wbr/>Task<wbr/>Performance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskPerformance</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">TaskPerformance</span><a href="#endTaskPerformance.endTaskPerformance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 316 | <li class="tsd-description"> |
| 317 | <div class="tsd-parameters"> |
| 318 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 319 | <ul class="tsd-parameter-list"> |
| 320 | <li> |
| 321 | <h5><span class="tsd-kind-parameter">taskPerformance</span>: <span class="tsd-signature-type ">TaskPerformance</span></h5></li></ul></div> |
| 322 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">TaskPerformance</span></h4><aside class="tsd-sources"> |
| 323 | <ul> |
| 324 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L315">src/worker/abstract-worker.ts:315</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
325 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="getMainWorker" class="tsd-anchor"></a> |
| 15d6dfaf |
326 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Main<wbr/>Worker</span><a href="#getMainWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
327 | <ul class="tsd-signatures tsd-is-protected"> |
| 15d6dfaf |
328 | <li class="tsd-signature tsd-anchor-link" id="getMainWorker.getMainWorker-1"><span class="tsd-kind-call-signature">get<wbr/>Main<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span><a href="#getMainWorker.getMainWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
329 | <li class="tsd-description"> |
| 330 | <div class="tsd-comment tsd-typography"><p>Returns the main worker.</p> |
| 6c525543 |
331 | </div> |
| fab6d3b5 |
332 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span></h4><p>Reference to the main worker.</p> |
| 15d6dfaf |
333 | |
| 334 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
335 | <ul> |
| afa30fd0 |
336 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L182">src/worker/abstract-worker.ts:182</a></li></ul></aside></li></ul></section> |
| 2c94c3a5 |
337 | <section class="tsd-panel tsd-member tsd-is-private"><a id="getTaskFunction" class="tsd-anchor"></a> |
| 15d6dfaf |
338 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Task<wbr/>Function</span><a href="#getTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 2c94c3a5 |
339 | <ul class="tsd-signatures tsd-is-private"> |
| 15d6dfaf |
340 | <li class="tsd-signature tsd-anchor-link" id="getTaskFunction.getTaskFunction-1"><span class="tsd-kind-call-signature">get<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkerFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerFunction</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span><a href="#getTaskFunction.getTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 2c94c3a5 |
341 | <li class="tsd-description"> |
| 342 | <div class="tsd-comment tsd-typography"><p>Gets the task function in the given scope.</p> |
| 343 | </div> |
| 344 | <div class="tsd-parameters"> |
| 345 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 346 | <ul class="tsd-parameter-list"> |
| 347 | <li> |
| 348 | <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5> |
| 349 | <div class="tsd-comment tsd-typography"><p>Name of the function that will be returned.</p> |
| 15d6dfaf |
350 | </div> |
| 351 | <div class="tsd-comment tsd-typography"></div></li></ul></div> |
| 352 | <h4 class="tsd-returns-title">Returns <a href="../types/WorkerFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerFunction</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span></h4> |
| 353 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 2c94c3a5 |
354 | <ul> |
| afa30fd0 |
355 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L295">src/worker/abstract-worker.ts:295</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
356 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="handleError" class="tsd-anchor"></a> |
| 15d6dfaf |
357 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>handle<wbr/>Error</span><a href="#handleError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
358 | <ul class="tsd-signatures tsd-is-protected"> |
| 15d6dfaf |
359 | <li class="tsd-signature tsd-anchor-link" id="handleError.handleError-1"><span class="tsd-kind-call-signature">handle<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">e</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#handleError.handleError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
360 | <li class="tsd-description"> |
| 361 | <div class="tsd-comment tsd-typography"><p>Handles an error and convert it to a string so it can be sent back to the main worker.</p> |
| 6c525543 |
362 | </div> |
| 363 | <div class="tsd-parameters"> |
| 364 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 365 | <ul class="tsd-parameter-list"> |
| 366 | <li> |
| 3bd6a82e |
367 | <h5><span class="tsd-kind-parameter">e</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></h5> |
| 6c525543 |
368 | <div class="tsd-comment tsd-typography"><p>The error raised by the worker.</p> |
| 15d6dfaf |
369 | </div> |
| 370 | <div class="tsd-comment tsd-typography"></div></li></ul></div> |
| fab6d3b5 |
371 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>Message of the error.</p> |
| 15d6dfaf |
372 | |
| 373 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
374 | <ul> |
| afa30fd0 |
375 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L214">src/worker/abstract-worker.ts:214</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
376 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="messageListener" class="tsd-anchor"></a> |
| 15d6dfaf |
377 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>message<wbr/>Listener</span><a href="#messageListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
378 | <ul class="tsd-signatures tsd-is-protected"> |
| 15d6dfaf |
379 | <li class="tsd-signature tsd-anchor-link" id="messageListener.messageListener-1"><span class="tsd-kind-call-signature">message<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#messageListener.messageListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
380 | <li class="tsd-description"> |
| 381 | <div class="tsd-comment tsd-typography"><p>Worker message listener.</p> |
| 382 | </div> |
| 383 | <div class="tsd-parameters"> |
| 384 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 385 | <ul class="tsd-parameter-list"> |
| 386 | <li> |
| 8d1797ad |
387 | <h5><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/MessageValue.html" class="tsd-signature-type tsd-kind-interface">MessageValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol">></span></h5> |
| 6c525543 |
388 | <div class="tsd-comment tsd-typography"><p>Message received.</p> |
| 15d6dfaf |
389 | </div> |
| 390 | <div class="tsd-comment tsd-typography"></div></li></ul></div> |
| 391 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 392 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
393 | <ul> |
| afa30fd0 |
394 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L155">src/worker/abstract-worker.ts:155</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
395 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="runAsync" class="tsd-anchor"></a> |
| 15d6dfaf |
396 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>run<wbr/>Async</span><a href="#runAsync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
397 | <ul class="tsd-signatures tsd-is-protected"> |
| 15d6dfaf |
398 | <li class="tsd-signature tsd-anchor-link" id="runAsync.runAsync-1"><span class="tsd-kind-call-signature">run<wbr/>Async</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#runAsync.runAsync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
399 | <li class="tsd-description"> |
| 400 | <div class="tsd-comment tsd-typography"><p>Runs the given function asynchronously.</p> |
| 401 | </div> |
| 402 | <div class="tsd-parameters"> |
| 403 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 404 | <ul class="tsd-parameter-list"> |
| 405 | <li> |
| 8d1797ad |
406 | <h5><span class="tsd-kind-parameter">fn</span>: <a href="../types/WorkerAsyncFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerAsyncFunction</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span></h5> |
| 6c525543 |
407 | <div class="tsd-comment tsd-typography"><p>Function that will be executed.</p> |
| 15d6dfaf |
408 | </div> |
| 409 | <div class="tsd-comment tsd-typography"></div></li> |
| 6c525543 |
410 | <li> |
| 2c94c3a5 |
411 | <h5><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/MessageValue.html" class="tsd-signature-type tsd-kind-interface">MessageValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MessagePort</span><span class="tsd-signature-symbol">></span></h5> |
| 6c525543 |
412 | <div class="tsd-comment tsd-typography"><p>Input data for the given function.</p> |
| 15d6dfaf |
413 | </div> |
| 414 | <div class="tsd-comment tsd-typography"></div></li></ul></div> |
| 415 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 416 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
417 | <ul> |
| afa30fd0 |
418 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L258">src/worker/abstract-worker.ts:258</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
419 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runInAsyncScope" class="tsd-anchor"></a> |
| 15d6dfaf |
420 | <h3 class="tsd-anchor-link"><span>run<wbr/>In<wbr/>Async<wbr/>Scope</span><a href="#runInAsyncScope" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
421 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
422 | <li class="tsd-signature tsd-anchor-link" id="runInAsyncScope.runInAsyncScope-1"><span class="tsd-kind-call-signature">run<wbr/>In<wbr/>Async<wbr/>Scope</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">This</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Result</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">thisArg</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">Result</span><a href="#runInAsyncScope.runInAsyncScope-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
423 | <li class="tsd-description"> |
| 424 | <div class="tsd-comment tsd-typography"><p>Call the provided function with the provided arguments in the execution context |
| 425 | of the async resource. This will establish the context, trigger the AsyncHooks |
| 426 | before callbacks, call the function, trigger the AsyncHooks after callbacks, and |
| 427 | then restore the original execution context.</p> |
| 6c525543 |
428 | </div> |
| fab6d3b5 |
429 | <section class="tsd-panel"> |
| 6c525543 |
430 | <h4>Type Parameters</h4> |
| fab6d3b5 |
431 | <ul class="tsd-type-parameter-list"> |
| 6c525543 |
432 | <li> |
| 3bd6a82e |
433 | <h4><span class="tsd-kind-type-parameter">This</span></h4></li> |
| 6c525543 |
434 | <li> |
| 3bd6a82e |
435 | <h4><span class="tsd-kind-type-parameter">Result</span></h4></li></ul></section> |
| 6c525543 |
436 | <div class="tsd-parameters"> |
| 437 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 438 | <ul class="tsd-parameter-list"> |
| 439 | <li> |
| 3bd6a82e |
440 | <h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type tsd-kind-type-parameter">Result</span><span class="tsd-signature-symbol">)</span></h5> |
| 6c525543 |
441 | <div class="tsd-comment tsd-typography"><p>The function to call in the execution context of this async resource.</p> |
| 442 | </div> |
| 15d6dfaf |
443 | <div class="tsd-comment tsd-typography"></div> |
| 6c525543 |
444 | <ul class="tsd-parameters"> |
| 445 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
446 | <ul class="tsd-signatures tsd-is-external"> |
| 447 | <li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">Result</span></li> |
| 6c525543 |
448 | <li class="tsd-description"> |
| 449 | <div class="tsd-parameters"> |
| 450 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 451 | <ul class="tsd-parameter-list"> |
| 452 | <li> |
| 3bd6a82e |
453 | <h5><span class="tsd-kind-parameter">this</span>: <span class="tsd-signature-type tsd-kind-type-parameter">This</span></h5></li> |
| 6c525543 |
454 | <li> |
| 3bd6a82e |
455 | <h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div> |
| 456 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Result</span></h4></li></ul></li></ul></li> |
| 6c525543 |
457 | <li> |
| 3bd6a82e |
458 | <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type tsd-kind-type-parameter">This</span></h5> |
| 6c525543 |
459 | <div class="tsd-comment tsd-typography"><p>The receiver to be used for the function call.</p> |
| 15d6dfaf |
460 | </div> |
| 461 | <div class="tsd-comment tsd-typography"></div></li> |
| 6c525543 |
462 | <li> |
| 3bd6a82e |
463 | <h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5> |
| 6c525543 |
464 | <div class="tsd-comment tsd-typography"><p>Optional arguments to pass to the function.</p> |
| 15d6dfaf |
465 | </div> |
| 466 | <div class="tsd-comment tsd-typography"></div></li></ul></div> |
| 467 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Result</span></h4> |
| 468 | <div class="tsd-comment tsd-typography"> |
| 469 | <h4>Since</h4><p>v9.6.0</p> |
| 470 | </div><aside class="tsd-sources"> |
| 6c525543 |
471 | <p>Inherited from AsyncResource.runInAsyncScope</p> |
| 472 | <ul> |
| 811dc01f |
473 | <li>Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:294</li></ul></aside></li></ul></section> |
| 2c94c3a5 |
474 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="runSync" class="tsd-anchor"></a> |
| 15d6dfaf |
475 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>run<wbr/>Sync</span><a href="#runSync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 2c94c3a5 |
476 | <ul class="tsd-signatures tsd-is-protected"> |
| 15d6dfaf |
477 | <li class="tsd-signature tsd-anchor-link" id="runSync.runSync-1"><span class="tsd-kind-call-signature">run<wbr/>Sync</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#runSync.runSync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 2c94c3a5 |
478 | <li class="tsd-description"> |
| 479 | <div class="tsd-comment tsd-typography"><p>Runs the given function synchronously.</p> |
| 480 | </div> |
| 481 | <div class="tsd-parameters"> |
| 482 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 483 | <ul class="tsd-parameter-list"> |
| 484 | <li> |
| 485 | <h5><span class="tsd-kind-parameter">fn</span>: <a href="../types/WorkerSyncFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerSyncFunction</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span></h5> |
| 486 | <div class="tsd-comment tsd-typography"><p>Function that will be executed.</p> |
| 15d6dfaf |
487 | </div> |
| 488 | <div class="tsd-comment tsd-typography"></div></li> |
| 2c94c3a5 |
489 | <li> |
| 490 | <h5><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/MessageValue.html" class="tsd-signature-type tsd-kind-interface">MessageValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MessagePort</span><span class="tsd-signature-symbol">></span></h5> |
| 491 | <div class="tsd-comment tsd-typography"><p>Input data for the given function.</p> |
| 15d6dfaf |
492 | </div> |
| 493 | <div class="tsd-comment tsd-typography"></div></li></ul></div> |
| 494 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 495 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 2c94c3a5 |
496 | <ul> |
| afa30fd0 |
497 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L224">src/worker/abstract-worker.ts:224</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
498 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="sendToMainWorker" class="tsd-anchor"></a> |
| 15d6dfaf |
499 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>send<wbr/>To<wbr/>Main<wbr/>Worker</span><a href="#sendToMainWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
500 | <ul class="tsd-signatures tsd-is-protected"> |
| 15d6dfaf |
501 | <li class="tsd-signature tsd-anchor-link" id="sendToMainWorker.sendToMainWorker-1"><span class="tsd-kind-call-signature">send<wbr/>To<wbr/>Main<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sendToMainWorker.sendToMainWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
502 | <li class="tsd-description"> |
| 503 | <div class="tsd-comment tsd-typography"><p>Sends a message to the main worker.</p> |
| 504 | </div> |
| 505 | <div class="tsd-parameters"> |
| 506 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 507 | <ul class="tsd-parameter-list"> |
| 508 | <li> |
| 2c94c3a5 |
509 | <h5><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/MessageValue.html" class="tsd-signature-type tsd-kind-interface">MessageValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MessagePort</span><span class="tsd-signature-symbol">></span></h5> |
| 6c525543 |
510 | <div class="tsd-comment tsd-typography"><p>The response message.</p> |
| 15d6dfaf |
511 | </div> |
| 512 | <div class="tsd-comment tsd-typography"></div></li></ul></div> |
| 513 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 514 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
515 | <ul> |
| afa30fd0 |
516 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/a788de3/src/worker/abstract-worker.ts#L194">src/worker/abstract-worker.ts:194</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
517 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="triggerAsyncId" class="tsd-anchor"></a> |
| 15d6dfaf |
518 | <h3 class="tsd-anchor-link"><span>trigger<wbr/>Async<wbr/>Id</span><a href="#triggerAsyncId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
519 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
520 | <li class="tsd-signature tsd-anchor-link" id="triggerAsyncId.triggerAsyncId-1"><span class="tsd-kind-call-signature">trigger<wbr/>Async<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#triggerAsyncId.triggerAsyncId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
521 | <li class="tsd-description"> |
| fab6d3b5 |
522 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The same <code>triggerAsyncId</code> that is passed to the <code>AsyncResource</code> constructor.</p> |
| 15d6dfaf |
523 | |
| 524 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 6c525543 |
525 | <p>Inherited from AsyncResource.triggerAsyncId</p> |
| 526 | <ul> |
| 811dc01f |
527 | <li>Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:311</li></ul></aside></li></ul></section> |
| 3bd6a82e |
528 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bind-2" class="tsd-anchor"></a> |
| 15d6dfaf |
529 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>bind</span><a href="#bind-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
530 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
531 | <li class="tsd-signature tsd-anchor-link" id="bind-2.bind-3"><span class="tsd-kind-call-signature">bind</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Func</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">ThisArg</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">thisArg</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">Func</span><a href="#bind-2.bind-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6c525543 |
532 | <li class="tsd-description"> |
| 533 | <div class="tsd-comment tsd-typography"><p>Binds the given function to the current execution context.</p> |
| 6c525543 |
534 | </div> |
| fab6d3b5 |
535 | <section class="tsd-panel"> |
| 6c525543 |
536 | <h4>Type Parameters</h4> |
| fab6d3b5 |
537 | <ul class="tsd-type-parameter-list"> |
| 6c525543 |
538 | <li> |
| 3bd6a82e |
539 | <h4><span class="tsd-kind-type-parameter">Func</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></h4></li> |
| 6c525543 |
540 | <li> |
| 3bd6a82e |
541 | <h4><span class="tsd-kind-type-parameter">ThisArg</span></h4></li></ul></section> |
| 6c525543 |
542 | <div class="tsd-parameters"> |
| 543 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 544 | <ul class="tsd-parameter-list"> |
| 545 | <li> |
| 3bd6a82e |
546 | <h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h5> |
| 6c525543 |
547 | <div class="tsd-comment tsd-typography"><p>The function to bind to the current execution context.</p> |
| 15d6dfaf |
548 | </div> |
| 549 | <div class="tsd-comment tsd-typography"></div></li> |
| 6c525543 |
550 | <li> |
| 3bd6a82e |
551 | <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></h5> |
| 6c525543 |
552 | <div class="tsd-comment tsd-typography"><p>An optional name to associate with the underlying <code>AsyncResource</code>.</p> |
| 15d6dfaf |
553 | </div> |
| 554 | <div class="tsd-comment tsd-typography"></div></li> |
| 6c525543 |
555 | <li> |
| 3bd6a82e |
556 | <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type tsd-kind-type-parameter">ThisArg</span></h5></li></ul></div> |
| 15d6dfaf |
557 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h4> |
| 558 | <div class="tsd-comment tsd-typography"> |
| 559 | <h4>Since</h4><p>v14.8.0, v12.19.0</p> |
| 560 | </div><aside class="tsd-sources"> |
| 6c525543 |
561 | <p>Inherited from AsyncResource.bind</p> |
| 562 | <ul> |
| 811dc01f |
563 | <li>Defined in node_modules/.pnpm/@types+node@20.2.5/node_modules/@types/node/async_hooks.d.ts:277</li></ul></aside></li></ul></section></section></div> |
| 6c525543 |
564 | <div class="col-sidebar"> |
| 565 | <div class="page-menu"> |
| 566 | <div class="tsd-navigation settings"> |
| 567 | <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> |
| 15d6dfaf |
568 | <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary> |
| 6c525543 |
569 | <div class="tsd-accordion-details"> |
| 570 | <div class="tsd-filter-visibility"> |
| 571 | <h4 class="uppercase">Member Visibility</h4><form> |
| 572 | <ul id="tsd-filter-options"> |
| 573 | <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li> |
| 574 | <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li> |
| 575 | <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li> |
| 576 | <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div> |
| 577 | <div class="tsd-theme-toggle"> |
| 3bd6a82e |
578 | <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> |
| 6c525543 |
579 | <details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"> |
| 15d6dfaf |
580 | <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary> |
| 6c525543 |
581 | <div class="tsd-accordion-details"> |
| 582 | <ul> |
| 15d6dfaf |
583 | <li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li> |
| 584 | <li><a href="#aliveInterval" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>alive<wbr/>Interval</span></a></li> |
| 585 | <li><a href="#isMain" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>is<wbr/>Main</span></a></li> |
| 586 | <li><a href="#lastTaskTimestamp" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>last<wbr/>Task<wbr/>Timestamp</span></a></li> |
| 587 | <li><a href="#mainWorker" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>main<wbr/>Worker</span></a></li> |
| 588 | <li><a href="#opts" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>opts</span></a></li> |
| afa30fd0 |
589 | <li><a href="#statistics" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>statistics</span></a></li> |
| 15d6dfaf |
590 | <li><a href="#taskFunctions" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>task<wbr/>Functions</span></a></li> |
| 591 | <li><a href="#asyncId" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>async<wbr/>Id</span></a></li> |
| afa30fd0 |
592 | <li><a href="#beginTaskPerformance" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>begin<wbr/>Task<wbr/>Performance</span></a></li> |
| 15d6dfaf |
593 | <li><a href="#bind" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>bind</span></a></li> |
| 594 | <li><a href="#checkAlive" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Alive</span></a></li> |
| 595 | <li><a href="#checkTaskFunctions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Task<wbr/>Functions</span></a></li> |
| 596 | <li><a href="#checkWorkerOptions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Worker<wbr/>Options</span></a></li> |
| 597 | <li><a href="#emitDestroy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit<wbr/>Destroy</span></a></li> |
| afa30fd0 |
598 | <li><a href="#endTaskPerformance" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>end<wbr/>Task<wbr/>Performance</span></a></li> |
| 15d6dfaf |
599 | <li><a href="#getMainWorker" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Main<wbr/>Worker</span></a></li> |
| 600 | <li><a href="#getTaskFunction" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Task<wbr/>Function</span></a></li> |
| 601 | <li><a href="#handleError" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Error</span></a></li> |
| 602 | <li><a href="#messageListener" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>message<wbr/>Listener</span></a></li> |
| 603 | <li><a href="#runAsync" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Async</span></a></li> |
| 604 | <li><a href="#runInAsyncScope" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>In<wbr/>Async<wbr/>Scope</span></a></li> |
| 605 | <li><a href="#runSync" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Sync</span></a></li> |
| 606 | <li><a href="#sendToMainWorker" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>To<wbr/>Main<wbr/>Worker</span></a></li> |
| 607 | <li><a href="#triggerAsyncId" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trigger<wbr/>Async<wbr/>Id</span></a></li> |
| 608 | <li><a href="#bind-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>bind</span></a></li></ul></div></details></div> |
| 6c525543 |
609 | <div class="site-menu"> |
| 15d6dfaf |
610 | <nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>poolifier</span></a> |
| 6c525543 |
611 | <ul class="tsd-small-nested-navigation"> |
| 15d6dfaf |
612 | <li><a href="AbstractPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Abstract<wbr/>Pool</span></a></li> |
| 613 | <li><a href="AbstractWorker.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Abstract<wbr/>Worker</span></a></li> |
| 614 | <li><a href="CircularArray.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Circular<wbr/>Array</span></a></li> |
| 615 | <li><a href="ClusterWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cluster<wbr/>Worker</span></a></li> |
| 616 | <li><a href="DynamicClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dynamic<wbr/>Cluster<wbr/>Pool</span></a></li> |
| 617 | <li><a href="DynamicThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dynamic<wbr/>Thread<wbr/>Pool</span></a></li> |
| 618 | <li><a href="FixedClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Fixed<wbr/>Cluster<wbr/>Pool</span></a></li> |
| 619 | <li><a href="FixedThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Fixed<wbr/>Thread<wbr/>Pool</span></a></li> |
| 620 | <li><a href="PoolEmitter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Pool<wbr/>Emitter</span></a></li> |
| 621 | <li><a href="Queue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Queue</span></a></li> |
| 622 | <li><a href="ThreadWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Thread<wbr/>Worker</span></a></li> |
| 623 | <li><a href="WorkerChoiceStrategyContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span></a></li> |
| 624 | <li><a href="../interfaces/ClusterPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Cluster<wbr/>Pool<wbr/>Options</span></a></li> |
| 625 | <li><a href="../interfaces/IPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IPool</span></a></li> |
| 626 | <li><a href="../interfaces/IWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker</span></a></li> |
| 627 | <li><a href="../interfaces/IWorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker<wbr/>Choice<wbr/>Strategy</span></a></li> |
| 628 | <li><a href="../interfaces/MessageValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Message<wbr/>Value</span></a></li> |
| 629 | <li><a href="../interfaces/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> |
| 630 | <li><a href="../interfaces/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> |
| 631 | <li><a href="../interfaces/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> |
| 15d6dfaf |
632 | <li><a href="../interfaces/Task.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task</span></a></li> |
| afa30fd0 |
633 | <li><a href="../interfaces/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> |
| 15d6dfaf |
634 | <li><a href="../interfaces/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> |
| 635 | <li><a href="../interfaces/TasksUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tasks<wbr/>Usage</span></a></li> |
| 636 | <li><a href="../interfaces/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> |
| 637 | <li><a href="../interfaces/WorkerNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Node</span></a></li> |
| 638 | <li><a href="../interfaces/WorkerOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Options</span></a></li> |
| 639 | <li><a href="../types/Draft.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Draft</span></a></li> |
| 640 | <li><a href="../types/ErrorHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Error<wbr/>Handler</span></a></li> |
| 641 | <li><a href="../types/ExitHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Exit<wbr/>Handler</span></a></li> |
| 642 | <li><a href="../types/KillBehavior.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Kill<wbr/>Behavior</span></a></li> |
| 643 | <li><a href="../types/MessageHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Message<wbr/>Handler</span></a></li> |
| 644 | <li><a href="../types/OnlineHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Online<wbr/>Handler</span></a></li> |
| 645 | <li><a href="../types/PoolEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Pool<wbr/>Event</span></a></li> |
| 646 | <li><a href="../types/PoolType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Pool<wbr/>Type</span></a></li> |
| 647 | <li><a href="../types/TaskFunctions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Functions</span></a></li> |
| 648 | <li><a href="../types/ThreadWorkerWithMessageChannel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Thread<wbr/>Worker<wbr/>With<wbr/>Message<wbr/>Channel</span></a></li> |
| 649 | <li><a href="../types/WorkerAsyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Async<wbr/>Function</span></a></li> |
| 650 | <li><a href="../types/WorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy</span></a></li> |
| 651 | <li><a href="../types/WorkerFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Function</span></a></li> |
| 652 | <li><a href="../types/WorkerSyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Sync<wbr/>Function</span></a></li> |
| 653 | <li><a href="../types/WorkerType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Type</span></a></li> |
| 654 | <li><a href="../variables/KillBehaviors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>Kill<wbr/>Behaviors</span></a></li> |
| 655 | <li><a href="../variables/PoolEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Pool<wbr/>Events</span></a></li> |
| 656 | <li><a href="../variables/PoolTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Pool<wbr/>Types</span></a></li> |
| 657 | <li><a href="../variables/WorkerChoiceStrategies.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategies</span></a></li> |
| 658 | <li><a href="../variables/WorkerTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Worker<wbr/>Types</span></a></li></ul></nav></div></div></div> |
| 6c525543 |
659 | <div class="tsd-generator"> |
| 660 | <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> |
| 661 | <div class="overlay"></div></body></html> |
repositories / poolifier.git / blame