chore: generate documentation
[poolifier.git] / docs / classes / ThreadWorker.html
CommitLineData
013a4697 1<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ThreadWorker | poolifier - v2.6.26</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">
a76fac14
JB
2<div class="tsd-toolbar-contents container">
3<div class="table-cell" id="tsd-search" data-base="..">
41015374
JB
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>
a76fac14
JB
7<ul class="results">
8<li class="state loading">Preparing search index...</li>
013a4697 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.6.26</a></div>
41015374 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>
a76fac14 11<div class="container container-main">
ec06e4dd 12<div class="col-content">
a76fac14
JB
13<div class="tsd-page-title">
14<ul class="tsd-breadcrumb">
15<li><a href="../index.html">poolifier</a></li>
16<li><a href="ThreadWorker.html">ThreadWorker</a></li></ul>
17<h1>Class ThreadWorker&lt;Data, Response&gt;</h1></div>
18<section class="tsd-panel tsd-comment">
19<div class="tsd-comment tsd-typography"><p>A thread worker used by a poolifier <code>ThreadPool</code>.</p>
20<p>When this worker is inactive for more than the given <code>maxInactiveTime</code>,
24c3fcb4
JB
21it will send a termination request to its main thread.</p>
22<p>If you use a <code>DynamicThreadPool</code> the extra workers that were created will be terminated,
23but the minimum number of workers will be guaranteed.</p>
15d6dfaf 24</div>
25<div class="tsd-comment tsd-typography">
26<h4>Author</h4><p><a href="https://github.com/pioardi">Alessandro Pio Ardizio</a></p>
a76fac14 27
15d6dfaf 28<h4>Since</h4><p>0.0.1</p>
a76fac14 29</div></section>
fab6d3b5 30<section class="tsd-panel">
a76fac14 31<h4>Type Parameters</h4>
fab6d3b5 32<ul class="tsd-type-parameter-list">
a76fac14 33<li>
3bd6a82e 34<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 35<div class="tsd-comment tsd-typography"><p>Type of data this worker receives from pool&#39;s execution. This can only be structured-cloneable data.</p>
15d6dfaf 36</div>
37<div class="tsd-comment tsd-typography"></div></li>
a76fac14 38<li>
3bd6a82e 39<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 40<div class="tsd-comment tsd-typography"><p>Type of response the worker sends back to the main thread. This can only be structured-cloneable data.</p>
15d6dfaf 41</div>
42<div class="tsd-comment tsd-typography"></div></li></ul></section>
a76fac14
JB
43<section class="tsd-panel tsd-hierarchy">
44<h4>Hierarchy</h4>
45<ul class="tsd-hierarchy">
8d1797ad 46<li><a href="AbstractWorker.html" class="tsd-signature-type tsd-kind-class">AbstractWorker</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">MessagePort</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">&gt;</span>
a76fac14
JB
47<ul class="tsd-hierarchy">
48<li><span class="target">ThreadWorker</span></li></ul></li></ul></section><aside class="tsd-sources">
49<ul>
0e16e60a 50<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/thread-worker.ts#L26">src/worker/thread-worker.ts:26</a></li></ul></aside>
a76fac14
JB
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="ThreadWorker.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>
a76fac14
JB
59</div></section>
60<section class="tsd-index-section">
61<h3 class="tsd-index-heading">Properties</h3>
7b88db4b 62<div class="tsd-index-list"><a href="ThreadWorker.html#activeInterval" class="tsd-index-link tsd-is-protected tsd-is-inherited"><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>active<wbr/>Interval?</span></a>
15d6dfaf 63<a href="ThreadWorker.html#isMain" class="tsd-index-link tsd-is-protected tsd-is-inherited"><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="ThreadWorker.html#lastTaskTimestamp" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>last<wbr/>Task<wbr/>Timestamp</span></a>
15d6dfaf 65<a href="ThreadWorker.html#opts" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>opts</span></a>
76b46937 66<a href="ThreadWorker.html#port" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>port</span></a>
afa30fd0 67<a href="ThreadWorker.html#statistics" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>statistics</span></a>
15d6dfaf 68<a href="ThreadWorker.html#taskFunctions" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>task<wbr/>Functions</span></a>
a76fac14
JB
69</div></section>
70<section class="tsd-index-section">
202bcb6b 71<h3 class="tsd-index-heading">Accessors</h3>
72<div class="tsd-index-list"><a href="ThreadWorker.html#id" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g></svg><span>id</span></a>
73</div></section>
74<section class="tsd-index-section">
a76fac14 75<h3 class="tsd-index-heading">Methods</h3>
52f4e813 76<div class="tsd-index-list"><a href="ThreadWorker.html#addTaskFunction" class="tsd-index-link tsd-is-inherited"><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>add<wbr/>Task<wbr/>Function</span></a>
77<a href="ThreadWorker.html#asyncId" 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>async<wbr/>Id</span></a>
15d6dfaf 78<a href="ThreadWorker.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>
15d6dfaf 79<a href="ThreadWorker.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>
80<a href="ThreadWorker.html#getMainWorker" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Main<wbr/>Worker</span></a>
202bcb6b 81<a href="ThreadWorker.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>
76b46937 82<a href="ThreadWorker.html#handleKillMessage" 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/>Kill<wbr/>Message</span></a>
83<a href="ThreadWorker.html#handleReadyMessage" 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/>Ready<wbr/>Message</span></a>
52f4e813 84<a href="ThreadWorker.html#hasTaskFunction" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Task<wbr/>Function</span></a>
88499cf9 85<a href="ThreadWorker.html#listTaskFunctions" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Task<wbr/>Functions</span></a>
15d6dfaf 86<a href="ThreadWorker.html#messageListener" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>message<wbr/>Listener</span></a>
52f4e813 87<a href="ThreadWorker.html#removeTaskFunction" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Task<wbr/>Function</span></a>
f33c2d55 88<a href="ThreadWorker.html#run" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run</span></a>
15d6dfaf 89<a href="ThreadWorker.html#runAsync" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Async</span></a>
90<a href="ThreadWorker.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>
91<a href="ThreadWorker.html#runSync" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Sync</span></a>
013a4697 92<a href="ThreadWorker.html#sendTaskFunctionsListToMainWorker" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Task<wbr/>Functions<wbr/>List<wbr/>To<wbr/>Main<wbr/>Worker</span></a>
15d6dfaf 93<a href="ThreadWorker.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>
52f4e813 94<a href="ThreadWorker.html#setDefaultTaskFunction" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Task<wbr/>Function</span></a>
15d6dfaf 95<a href="ThreadWorker.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>
96<a href="ThreadWorker.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>
a76fac14
JB
97</div></section></div></details></section></section>
98<section class="tsd-panel-group tsd-member-group">
99<h2>Constructors</h2>
3bd6a82e 100<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
15d6dfaf 101<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 102<ul class="tsd-signatures">
15d6dfaf 103<li class="tsd-signature tsd-anchor-link" id="constructor.new_ThreadWorker"><span class="tsd-kind-constructor-signature">new <wbr/>Thread<wbr/>Worker</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskFunctions</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="ThreadWorker.html" class="tsd-signature-type tsd-kind-class">ThreadWorker</a><span class="tsd-signature-symbol">&lt;</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">&gt;</span><a href="#constructor.new_ThreadWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14
JB
104<li class="tsd-description">
105<div class="tsd-comment tsd-typography"><p>Constructs a new poolifier thread worker.</p>
106</div>
fab6d3b5 107<section class="tsd-panel">
a76fac14 108<h4>Type Parameters</h4>
fab6d3b5 109<ul class="tsd-type-parameter-list">
a76fac14 110<li>
3bd6a82e 111<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4></li>
a76fac14 112<li>
3bd6a82e 113<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section>
a76fac14
JB
114<div class="tsd-parameters">
115<h4 class="tsd-parameters-title">Parameters</h4>
116<ul class="tsd-parameter-list">
117<li>
3c7c9bd1 118<h5><span class="tsd-kind-parameter">taskFunctions</span>: <a href="../types/TaskFunction.html" class="tsd-signature-type tsd-kind-type-alias">TaskFunction</a><span class="tsd-signature-symbol">&lt;</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">&gt;</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">&lt;</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">&gt;</span></h5>
2c94c3a5 119<div class="tsd-comment tsd-typography"><p>Task function(s) processed by the worker when the pool&#39;s <code>execution</code> function is invoked.</p>
15d6dfaf 120</div>
121<div class="tsd-comment tsd-typography"></div></li>
a76fac14 122<li>
8d1797ad 123<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>
a76fac14 124<div class="tsd-comment tsd-typography"><p>Options for the worker.</p>
15d6dfaf 125</div>
126<div class="tsd-comment tsd-typography"></div></li></ul></div>
127<h4 class="tsd-returns-title">Returns <a href="ThreadWorker.html" class="tsd-signature-type tsd-kind-class">ThreadWorker</a><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4>
128<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 129<p>Overrides <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#constructor">constructor</a></p>
a76fac14 130<ul>
0e16e60a 131<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/thread-worker.ts#L40">src/worker/thread-worker.ts:40</a></li></ul></aside></li></ul></section></section>
a76fac14
JB
132<section class="tsd-panel-group tsd-member-group">
133<h2>Properties</h2>
7b88db4b 134<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="activeInterval" class="tsd-anchor"></a>
135<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>active<wbr/>Interval</span><a href="#activeInterval" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
136<div class="tsd-signature"><span class="tsd-kind-property">active<wbr/>Interval</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Timeout</span></div>
137<div class="tsd-comment tsd-typography"><p>Handler id of the <code>activeInterval</code> worker activity check.</p>
15d6dfaf 138</div>
139<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
7b88db4b 140<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#activeInterval">activeInterval</a></p>
a76fac14 141<ul>
0e16e60a 142<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L63">src/worker/abstract-worker.ts:63</a></li></ul></aside></section>
3bd6a82e 143<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="isMain" class="tsd-anchor"></a>
15d6dfaf 144<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 145<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>
0770fe62 146<div class="tsd-comment tsd-typography"><p>Whether this is the main worker or not.</p>
15d6dfaf 147</div>
148<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 149<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#isMain">isMain</a></p>
0770fe62 150<ul>
0e16e60a 151<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L75">src/worker/abstract-worker.ts:75</a></li></ul></aside></section>
3bd6a82e 152<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="lastTaskTimestamp" class="tsd-anchor"></a>
15d6dfaf 153<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 154<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>
a76fac14 155<div class="tsd-comment tsd-typography"><p>Timestamp of the last task processed by this worker.</p>
15d6dfaf 156</div>
157<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 158<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#lastTaskTimestamp">lastTaskTimestamp</a></p>
a76fac14 159<ul>
0e16e60a 160<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L55">src/worker/abstract-worker.ts:55</a></li></ul></aside></section>
3bd6a82e 161<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="opts" class="tsd-anchor"></a>
15d6dfaf 162<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 163<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>
a76fac14 164<div class="tsd-comment tsd-typography"><p>Options for the worker.</p>
15d6dfaf 165</div>
166<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 167<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#opts">opts</a></p>
a76fac14 168<ul>
0e16e60a 169<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L78">src/worker/abstract-worker.ts:78</a></li></ul></aside></section>
76b46937 170<section class="tsd-panel tsd-member tsd-is-private"><a id="port" class="tsd-anchor"></a>
171<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>port</span><a href="#port" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
172<div class="tsd-signature"><span class="tsd-kind-property">port</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">MessagePort</span></div>
f04db52f 173<div class="tsd-comment tsd-typography"><p>Message port used to communicate with the main worker.</p>
76b46937 174</div>
175<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
176<ul>
0e16e60a 177<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/thread-worker.ts#L33">src/worker/thread-worker.ts:33</a></li></ul></aside></section>
afa30fd0 178<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="statistics" class="tsd-anchor"></a>
179<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>
71056a0a 180<div class="tsd-signature"><span class="tsd-kind-property">statistics</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/WorkerStatistics.html" class="tsd-signature-type tsd-kind-interface">WorkerStatistics</a></div>
030eb5a3 181<div class="tsd-comment tsd-typography"><p>Performance statistics computation requirements.</p>
afa30fd0 182</div>
183<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
184<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#statistics">statistics</a></p>
185<ul>
0e16e60a 186<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L59">src/worker/abstract-worker.ts:59</a></li></ul></aside></section>
2c94c3a5 187<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="taskFunctions" class="tsd-anchor"></a>
15d6dfaf 188<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>
3c7c9bd1 189<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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../types/TaskFunction.html" class="tsd-signature-type tsd-kind-type-alias">TaskFunction</a><span class="tsd-signature-symbol">&lt;</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">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div>
2c94c3a5 190<div class="tsd-comment tsd-typography"><p>Task function(s) processed by the worker when the pool&#39;s <code>execution</code> function is invoked.</p>
15d6dfaf 191</div>
192<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
2c94c3a5 193<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#taskFunctions">taskFunctions</a></p>
194<ul>
0e16e60a 195<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L51">src/worker/abstract-worker.ts:51</a></li></ul></aside></section></section>
202bcb6b 196<section class="tsd-panel-group tsd-member-group">
197<h2>Accessors</h2>
198<section class="tsd-panel tsd-member tsd-is-protected"><a id="id" class="tsd-anchor"></a>
199<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
200<ul class="tsd-signatures tsd-is-protected">
201<li class="tsd-signature" id="id.id-1"><span class="tsd-signature-symbol">get</span> id<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></li>
202<li class="tsd-description">
203<div class="tsd-comment tsd-typography"><p>Worker id.</p>
204</div>
205<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
206<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
207<p>Overrides AbstractWorker.id</p>
208<ul>
0e16e60a 209<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/thread-worker.ts#L75">src/worker/thread-worker.ts:75</a></li></ul></aside></li></ul></section></section>
a76fac14
JB
210<section class="tsd-panel-group tsd-member-group">
211<h2>Methods</h2>
52f4e813 212<section class="tsd-panel tsd-member tsd-is-inherited"><a id="addTaskFunction" class="tsd-anchor"></a>
213<h3 class="tsd-anchor-link"><span>add<wbr/>Task<wbr/>Function</span><a href="#addTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
214<ul class="tsd-signatures tsd-is-inherited">
215<li class="tsd-signature tsd-anchor-link" id="addTaskFunction.addTaskFunction-1"><span class="tsd-kind-call-signature">add<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</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">boolean</span><a href="#addTaskFunction.addTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
216<li class="tsd-description">
217<div class="tsd-comment tsd-typography"><p>Adds a task function to the worker.
218If a task function with the same name already exists, it is replaced.</p>
219</div>
220<div class="tsd-parameters">
221<h4 class="tsd-parameters-title">Parameters</h4>
222<ul class="tsd-parameter-list">
223<li>
224<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
225<div class="tsd-comment tsd-typography"><p>The name of the task function to add.</p>
226</div>
227<div class="tsd-comment tsd-typography"></div></li>
228<li>
3c7c9bd1 229<h5><span class="tsd-kind-parameter">fn</span>: <a href="../types/TaskFunction.html" class="tsd-signature-type tsd-kind-type-alias">TaskFunction</a><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h5>
52f4e813 230<div class="tsd-comment tsd-typography"><p>The task function to add.</p>
231</div>
232<div class="tsd-comment tsd-typography"></div></li></ul></div>
233<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the task function was added or not.</p>
234
235<div class="tsd-comment tsd-typography">
236<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror</a> If the <code>name</code> parameter is not a string.</p>
237
238<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the <code>name</code> parameter is the default task function reserved name.</p>
239
240<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror</a> If the <code>fn</code> parameter is not a function.</p>
241</div><aside class="tsd-sources">
242<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#addTaskFunction">addTaskFunction</a></p>
243<ul>
0e16e60a 244<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L195">src/worker/abstract-worker.ts:195</a></li></ul></aside></li></ul></section>
3bd6a82e 245<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="asyncId" class="tsd-anchor"></a>
15d6dfaf 246<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 247<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 248<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>
a76fac14 249<li class="tsd-description">
fab6d3b5 250<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 251
252<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 253<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#asyncId">asyncId</a></p>
a76fac14 254<ul>
1d9f69fa 255<li>Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:306</li></ul></aside></li></ul></section>
3bd6a82e 256<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bind" class="tsd-anchor"></a>
15d6dfaf 257<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 258<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 259<li class="tsd-signature tsd-anchor-link" id="bind.bind-1"><span class="tsd-kind-call-signature">bind</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Func</span><span class="tsd-signature-symbol">&gt;</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>
a76fac14
JB
260<li class="tsd-description">
261<div class="tsd-comment tsd-typography"><p>Binds the given function to execute to this <code>AsyncResource</code>&#39;s scope.</p>
a76fac14 262</div>
fab6d3b5 263<section class="tsd-panel">
a76fac14 264<h4>Type Parameters</h4>
fab6d3b5 265<ul class="tsd-type-parameter-list">
a76fac14 266<li>
3bd6a82e 267<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"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></h4></li></ul></section>
a76fac14
JB
268<div class="tsd-parameters">
269<h4 class="tsd-parameters-title">Parameters</h4>
270<ul class="tsd-parameter-list">
271<li>
3bd6a82e 272<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h5>
a76fac14 273<div class="tsd-comment tsd-typography"><p>The function to bind to the current <code>AsyncResource</code>.</p>
15d6dfaf 274</div>
275<div class="tsd-comment tsd-typography"></div></li></ul></div>
276<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h4>
277<div class="tsd-comment tsd-typography">
278<h4>Since</h4><p>v14.8.0, v12.19.0</p>
279</div><aside class="tsd-sources">
6c525543 280<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#bind">bind</a></p>
a76fac14 281<ul>
1d9f69fa 282<li>Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:283</li></ul></aside></li></ul></section>
3bd6a82e 283<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="emitDestroy" class="tsd-anchor"></a>
15d6dfaf 284<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 285<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 286<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="ThreadWorker.html" class="tsd-signature-type tsd-kind-class">ThreadWorker</a><span class="tsd-signature-symbol">&lt;</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">&gt;</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>
a76fac14
JB
287<li class="tsd-description">
288<div class="tsd-comment tsd-typography"><p>Call all <code>destroy</code> hooks. This should only ever be called once. An error will
24c3fcb4
JB
289be thrown if it is called more than once. This <strong>must</strong> be manually called. If
290the resource is left to be collected by the GC then the <code>destroy</code> hooks will
291never be called.</p>
a76fac14 292</div>
fab6d3b5 293<h4 class="tsd-returns-title">Returns <a href="ThreadWorker.html" class="tsd-signature-type tsd-kind-class">ThreadWorker</a><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h4><p>A reference to <code>asyncResource</code>.</p>
15d6dfaf 294
295<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 296<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#emitDestroy">emitDestroy</a></p>
a76fac14 297<ul>
1d9f69fa 298<li>Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:302</li></ul></aside></li></ul></section>
3bd6a82e 299<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="getMainWorker" class="tsd-anchor"></a>
15d6dfaf 300<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 301<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 302<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 ">MessagePort</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>
a76fac14
JB
303<li class="tsd-description">
304<div class="tsd-comment tsd-typography"><p>Returns the main worker.</p>
a76fac14 305</div>
fab6d3b5 306<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">MessagePort</span></h4><p>Reference to the main worker.</p>
15d6dfaf 307
308<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 309<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#getMainWorker">getMainWorker</a></p>
a76fac14 310<ul>
0e16e60a 311<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L415">src/worker/abstract-worker.ts:415</a></li></ul></aside></li></ul></section>
202bcb6b 312<section class="tsd-panel tsd-member tsd-is-protected"><a id="handleError" class="tsd-anchor"></a>
15d6dfaf 313<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>
202bcb6b 314<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 315<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>
a76fac14 316<li class="tsd-description">
301c53e7 317<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>
a76fac14
JB
318</div>
319<div class="tsd-parameters">
320<h4 class="tsd-parameters-title">Parameters</h4>
321<ul class="tsd-parameter-list">
322<li>
3bd6a82e 323<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>
a76fac14 324<div class="tsd-comment tsd-typography"><p>The error raised by the worker.</p>
15d6dfaf 325</div>
326<div class="tsd-comment tsd-typography"></div></li></ul></div>
6d6c7ed0 327<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The error message.</p>
15d6dfaf 328
329<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
202bcb6b 330<p>Overrides <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#handleError">handleError</a></p>
a76fac14 331<ul>
0e16e60a 332<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/thread-worker.ts#L85">src/worker/thread-worker.ts:85</a></li></ul></aside></li></ul></section>
76b46937 333<section class="tsd-panel tsd-member tsd-is-protected"><a id="handleKillMessage" class="tsd-anchor"></a>
334<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>handle<wbr/>Kill<wbr/>Message</span><a href="#handleKillMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
335<ul class="tsd-signatures tsd-is-protected">
336<li class="tsd-signature tsd-anchor-link" id="handleKillMessage.handleKillMessage-1"><span class="tsd-kind-call-signature">handle<wbr/>Kill<wbr/>Message</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="#handleKillMessage.handleKillMessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
337<li class="tsd-description">
338<div class="tsd-comment tsd-typography"><p>Handles a kill message sent by the main worker.</p>
339</div>
340<div class="tsd-parameters">
341<h4 class="tsd-parameters-title">Parameters</h4>
342<ul class="tsd-parameter-list">
343<li>
344<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">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h5>
345<div class="tsd-comment tsd-typography"><p>The kill message.</p>
346</div>
347<div class="tsd-comment tsd-typography"></div></li></ul></div>
348<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
349<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
350<p>Overrides <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#handleKillMessage">handleKillMessage</a></p>
351<ul>
0e16e60a 352<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/thread-worker.ts#L68">src/worker/thread-worker.ts:68</a></li></ul></aside></li></ul></section>
76b46937 353<section class="tsd-panel tsd-member tsd-is-protected"><a id="handleReadyMessage" class="tsd-anchor"></a>
354<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>handle<wbr/>Ready<wbr/>Message</span><a href="#handleReadyMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
355<ul class="tsd-signatures tsd-is-protected">
356<li class="tsd-signature tsd-anchor-link" id="handleReadyMessage.handleReadyMessage-1"><span class="tsd-kind-call-signature">handle<wbr/>Ready<wbr/>Message</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="#handleReadyMessage.handleReadyMessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
357<li class="tsd-description">
358<div class="tsd-comment tsd-typography"><p>Handles the ready message sent by the main worker.</p>
359</div>
360<div class="tsd-parameters">
361<h4 class="tsd-parameters-title">Parameters</h4>
362<ul class="tsd-parameter-list">
363<li>
364<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">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h5>
365<div class="tsd-comment tsd-typography"><p>The ready message.</p>
366</div>
367<div class="tsd-comment tsd-typography"></div></li></ul></div>
368<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
369<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
370<p>Overrides <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#handleReadyMessage">handleReadyMessage</a></p>
371<ul>
0e16e60a 372<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/thread-worker.ts#L54">src/worker/thread-worker.ts:54</a></li></ul></aside></li></ul></section>
52f4e813 373<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hasTaskFunction" class="tsd-anchor"></a>
374<h3 class="tsd-anchor-link"><span>has<wbr/>Task<wbr/>Function</span><a href="#hasTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
375<ul class="tsd-signatures tsd-is-inherited">
376<li class="tsd-signature tsd-anchor-link" id="hasTaskFunction.hasTaskFunction-1"><span class="tsd-kind-call-signature">has<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-type">boolean</span><a href="#hasTaskFunction.hasTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
377<li class="tsd-description">
378<div class="tsd-comment tsd-typography"><p>Checks if the worker has a task function with the given name.</p>
379</div>
380<div class="tsd-parameters">
381<h4 class="tsd-parameters-title">Parameters</h4>
382<ul class="tsd-parameter-list">
383<li>
384<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
385<div class="tsd-comment tsd-typography"><p>The name of the task function to check.</p>
386</div>
387<div class="tsd-comment tsd-typography"></div></li></ul></div>
388<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the worker has a task function with the given name or not.</p>
389
390<div class="tsd-comment tsd-typography">
391<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror</a> If the <code>name</code> parameter is not a string.</p>
392</div><aside class="tsd-sources">
393<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#hasTaskFunction">hasTaskFunction</a></p>
394<ul>
0e16e60a 395<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L174">src/worker/abstract-worker.ts:174</a></li></ul></aside></li></ul></section>
88499cf9 396<section class="tsd-panel tsd-member tsd-is-inherited"><a id="listTaskFunctions" class="tsd-anchor"></a>
397<h3 class="tsd-anchor-link"><span>list<wbr/>Task<wbr/>Functions</span><a href="#listTaskFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
398<ul class="tsd-signatures tsd-is-inherited">
399<li class="tsd-signature tsd-anchor-link" id="listTaskFunctions.listTaskFunctions-1"><span class="tsd-kind-call-signature">list<wbr/>Task<wbr/>Functions</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#listTaskFunctions.listTaskFunctions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
400<li class="tsd-description">
401<div class="tsd-comment tsd-typography"><p>Lists the names of the worker&#39;s task functions.</p>
402</div>
403<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><p>The names of the worker&#39;s task functions.</p>
404
405<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
406<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#listTaskFunctions">listTaskFunctions</a></p>
407<ul>
0e16e60a 408<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L267">src/worker/abstract-worker.ts:267</a></li></ul></aside></li></ul></section>
3bd6a82e 409<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="messageListener" class="tsd-anchor"></a>
15d6dfaf 410<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 411<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 412<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>
a76fac14 413<li class="tsd-description">
7cd8af00 414<div class="tsd-comment tsd-typography"><p>Worker message listener.</p>
415</div>
a76fac14
JB
416<div class="tsd-parameters">
417<h4 class="tsd-parameters-title">Parameters</h4>
418<ul class="tsd-parameter-list">
419<li>
76b46937 420<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">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h5>
7b88db4b 421<div class="tsd-comment tsd-typography"><p>The received message.</p>
15d6dfaf 422</div>
423<div class="tsd-comment tsd-typography"></div></li></ul></div>
424<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
425<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 426<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#messageListener">messageListener</a></p>
a76fac14 427<ul>
0e16e60a 428<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L320">src/worker/abstract-worker.ts:320</a></li></ul></aside></li></ul></section>
52f4e813 429<section class="tsd-panel tsd-member tsd-is-inherited"><a id="removeTaskFunction" class="tsd-anchor"></a>
430<h3 class="tsd-anchor-link"><span>remove<wbr/>Task<wbr/>Function</span><a href="#removeTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
431<ul class="tsd-signatures tsd-is-inherited">
432<li class="tsd-signature tsd-anchor-link" id="removeTaskFunction.removeTaskFunction-1"><span class="tsd-kind-call-signature">remove<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-type">boolean</span><a href="#removeTaskFunction.removeTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
433<li class="tsd-description">
434<div class="tsd-comment tsd-typography"><p>Removes a task function from the worker.</p>
435</div>
436<div class="tsd-parameters">
437<h4 class="tsd-parameters-title">Parameters</h4>
438<ul class="tsd-parameter-list">
439<li>
440<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
441<div class="tsd-comment tsd-typography"><p>The name of the task function to remove.</p>
442</div>
443<div class="tsd-comment tsd-typography"></div></li></ul></div>
444<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the task function existed and was removed or not.</p>
445
446<div class="tsd-comment tsd-typography">
447<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror</a> If the <code>name</code> parameter is not a string.</p>
448
449<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the <code>name</code> parameter is the default task function reserved name.</p>
450
451<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the <code>name</code> parameter is the task function used as default task function.</p>
452</div><aside class="tsd-sources">
453<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#removeTaskFunction">removeTaskFunction</a></p>
454<ul>
0e16e60a 455<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L238">src/worker/abstract-worker.ts:238</a></li></ul></aside></li></ul></section>
f33c2d55 456<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="run" class="tsd-anchor"></a>
457<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>run</span><a href="#run" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
458<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
459<li class="tsd-signature tsd-anchor-link" id="run.run-1"><span class="tsd-kind-call-signature">run</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#run.run-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
460<li class="tsd-description">
461<div class="tsd-comment tsd-typography"><p>Runs the given task.</p>
462</div>
463<div class="tsd-parameters">
464<h4 class="tsd-parameters-title">Parameters</h4>
465<ul class="tsd-parameter-list">
466<li>
467<h5><span class="tsd-kind-parameter">task</span>: <a href="../interfaces/Task.html" class="tsd-signature-type tsd-kind-interface">Task</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span></h5>
468<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
469</div>
470<div class="tsd-comment tsd-typography"></div></li></ul></div>
471<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
472<div class="tsd-comment tsd-typography">
473<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the task function is not found.</p>
474</div><aside class="tsd-sources">
475<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#run">run</a></p>
476<ul>
0e16e60a 477<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L457">src/worker/abstract-worker.ts:457</a></li></ul></aside></li></ul></section>
3bd6a82e 478<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="runAsync" class="tsd-anchor"></a>
15d6dfaf 479<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 480<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f33c2d55 481<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">task</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>
a76fac14 482<li class="tsd-description">
08e40091 483<div class="tsd-comment tsd-typography"><p>Runs the given task function asynchronously.</p>
a76fac14
JB
484</div>
485<div class="tsd-parameters">
486<h4 class="tsd-parameters-title">Parameters</h4>
487<ul class="tsd-parameter-list">
488<li>
3c7c9bd1 489<h5><span class="tsd-kind-parameter">fn</span>: <a href="../types/TaskAsyncFunction.html" class="tsd-signature-type tsd-kind-type-alias">TaskAsyncFunction</a><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h5>
f33c2d55 490<div class="tsd-comment tsd-typography"><p>Task function that will be executed.</p>
15d6dfaf 491</div>
492<div class="tsd-comment tsd-typography"></div></li>
a76fac14 493<li>
f33c2d55 494<h5><span class="tsd-kind-parameter">task</span>: <a href="../interfaces/Task.html" class="tsd-signature-type tsd-kind-interface">Task</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span></h5>
495<div class="tsd-comment tsd-typography"><p>Input data for the task function.</p>
15d6dfaf 496</div>
497<div class="tsd-comment tsd-typography"></div></li></ul></div>
498<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
499<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 500<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#runAsync">runAsync</a></p>
a76fac14 501<ul>
0e16e60a 502<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L508">src/worker/abstract-worker.ts:508</a></li></ul></aside></li></ul></section>
3bd6a82e 503<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runInAsyncScope" class="tsd-anchor"></a>
15d6dfaf 504<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 505<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 506<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">&lt;</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">&gt;</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>
a76fac14
JB
507<li class="tsd-description">
508<div class="tsd-comment tsd-typography"><p>Call the provided function with the provided arguments in the execution context
24c3fcb4
JB
509of the async resource. This will establish the context, trigger the AsyncHooks
510before callbacks, call the function, trigger the AsyncHooks after callbacks, and
511then restore the original execution context.</p>
a76fac14 512</div>
fab6d3b5 513<section class="tsd-panel">
a76fac14 514<h4>Type Parameters</h4>
fab6d3b5 515<ul class="tsd-type-parameter-list">
a76fac14 516<li>
3bd6a82e 517<h4><span class="tsd-kind-type-parameter">This</span></h4></li>
a76fac14 518<li>
3bd6a82e 519<h4><span class="tsd-kind-type-parameter">Result</span></h4></li></ul></section>
a76fac14
JB
520<div class="tsd-parameters">
521<h4 class="tsd-parameters-title">Parameters</h4>
522<ul class="tsd-parameter-list">
523<li>
3bd6a82e 524<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"> =&gt; </span><span class="tsd-signature-type tsd-kind-type-parameter">Result</span><span class="tsd-signature-symbol">)</span></h5>
a76fac14
JB
525<div class="tsd-comment tsd-typography"><p>The function to call in the execution context of this async resource.</p>
526</div>
15d6dfaf 527<div class="tsd-comment tsd-typography"></div>
a76fac14
JB
528<ul class="tsd-parameters">
529<li class="tsd-parameter-signature">
3bd6a82e 530<ul class="tsd-signatures tsd-is-external">
531<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>
a76fac14
JB
532<li class="tsd-description">
533<div class="tsd-parameters">
534<h4 class="tsd-parameters-title">Parameters</h4>
535<ul class="tsd-parameter-list">
536<li>
3bd6a82e 537<h5><span class="tsd-kind-parameter">this</span>: <span class="tsd-signature-type tsd-kind-type-parameter">This</span></h5></li>
a76fac14 538<li>
3bd6a82e 539<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>
540<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Result</span></h4></li></ul></li></ul></li>
a76fac14 541<li>
3bd6a82e 542<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>
a76fac14 543<div class="tsd-comment tsd-typography"><p>The receiver to be used for the function call.</p>
15d6dfaf 544</div>
545<div class="tsd-comment tsd-typography"></div></li>
a76fac14 546<li>
3bd6a82e 547<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>
a76fac14 548<div class="tsd-comment tsd-typography"><p>Optional arguments to pass to the function.</p>
15d6dfaf 549</div>
550<div class="tsd-comment tsd-typography"></div></li></ul></div>
551<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Result</span></h4>
552<div class="tsd-comment tsd-typography">
553<h4>Since</h4><p>v9.6.0</p>
554</div><aside class="tsd-sources">
6c525543 555<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#runInAsyncScope">runInAsyncScope</a></p>
a76fac14 556<ul>
1d9f69fa 557<li>Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:294</li></ul></aside></li></ul></section>
2c94c3a5 558<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="runSync" class="tsd-anchor"></a>
15d6dfaf 559<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 560<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f33c2d55 561<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">task</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 562<li class="tsd-description">
08e40091 563<div class="tsd-comment tsd-typography"><p>Runs the given task function synchronously.</p>
2c94c3a5 564</div>
565<div class="tsd-parameters">
566<h4 class="tsd-parameters-title">Parameters</h4>
567<ul class="tsd-parameter-list">
568<li>
3c7c9bd1 569<h5><span class="tsd-kind-parameter">fn</span>: <a href="../types/TaskSyncFunction.html" class="tsd-signature-type tsd-kind-type-alias">TaskSyncFunction</a><span class="tsd-signature-symbol">&lt;</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">&gt;</span></h5>
f33c2d55 570<div class="tsd-comment tsd-typography"><p>Task function that will be executed.</p>
15d6dfaf 571</div>
572<div class="tsd-comment tsd-typography"></div></li>
2c94c3a5 573<li>
f33c2d55 574<h5><span class="tsd-kind-parameter">task</span>: <a href="../interfaces/Task.html" class="tsd-signature-type tsd-kind-interface">Task</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span></h5>
575<div class="tsd-comment tsd-typography"><p>Input data for the task function.</p>
15d6dfaf 576</div>
577<div class="tsd-comment tsd-typography"></div></li></ul></div>
578<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
579<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
2c94c3a5 580<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#runSync">runSync</a></p>
581<ul>
0e16e60a 582<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L472">src/worker/abstract-worker.ts:472</a></li></ul></aside></li></ul></section>
013a4697 583<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="sendTaskFunctionsListToMainWorker" class="tsd-anchor"></a>
584<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>send<wbr/>Task<wbr/>Functions<wbr/>List<wbr/>To<wbr/>Main<wbr/>Worker</span><a href="#sendTaskFunctionsListToMainWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
585<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
586<li class="tsd-signature tsd-anchor-link" id="sendTaskFunctionsListToMainWorker.sendTaskFunctionsListToMainWorker-1"><span class="tsd-kind-call-signature">send<wbr/>Task<wbr/>Functions<wbr/>List<wbr/>To<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">void</span><a href="#sendTaskFunctionsListToMainWorker.sendTaskFunctionsListToMainWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
587<li class="tsd-description">
588<div class="tsd-comment tsd-typography"><p>Sends the list of task function names to the main worker.</p>
589</div>
590<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
591<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
592<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#sendTaskFunctionsListToMainWorker">sendTaskFunctionsListToMainWorker</a></p>
593<ul>
0e16e60a 594<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L434">src/worker/abstract-worker.ts:434</a></li></ul></aside></li></ul></section>
3bd6a82e 595<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendToMainWorker" class="tsd-anchor"></a>
15d6dfaf 596<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</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 597<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 598<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>
a76fac14 599<li class="tsd-description">
f04db52f 600<div class="tsd-comment tsd-typography"><p>Sends a message to main worker.</p>
6c525543 601</div>
a76fac14
JB
602<div class="tsd-parameters">
603<h4 class="tsd-parameters-title">Parameters</h4>
604<ul class="tsd-parameter-list">
605<li>
030eb5a3 606<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">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h5>
6c525543 607<div class="tsd-comment tsd-typography"><p>The response message.</p>
15d6dfaf 608</div>
609<div class="tsd-comment tsd-typography"></div></li></ul></div>
610<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
611<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 612<p>Overrides <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#sendToMainWorker">sendToMainWorker</a></p>
a76fac14 613<ul>
0e16e60a 614<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/thread-worker.ts#L80">src/worker/thread-worker.ts:80</a></li></ul></aside></li></ul></section>
52f4e813 615<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setDefaultTaskFunction" class="tsd-anchor"></a>
616<h3 class="tsd-anchor-link"><span>set<wbr/>Default<wbr/>Task<wbr/>Function</span><a href="#setDefaultTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
617<ul class="tsd-signatures tsd-is-inherited">
618<li class="tsd-signature tsd-anchor-link" id="setDefaultTaskFunction.setDefaultTaskFunction-1"><span class="tsd-kind-call-signature">set<wbr/>Default<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-type">boolean</span><a href="#setDefaultTaskFunction.setDefaultTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
619<li class="tsd-description">
88499cf9 620<div class="tsd-comment tsd-typography"><p>Sets the default task function to use in the worker.</p>
52f4e813 621</div>
622<div class="tsd-parameters">
623<h4 class="tsd-parameters-title">Parameters</h4>
624<ul class="tsd-parameter-list">
625<li>
626<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
627<div class="tsd-comment tsd-typography"><p>The name of the task function to use as default task function.</p>
628</div>
629<div class="tsd-comment tsd-typography"></div></li></ul></div>
630<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the default task function was set or not.</p>
631
632<div class="tsd-comment tsd-typography">
633<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror</a> If the <code>name</code> parameter is not a string.</p>
634
635<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the <code>name</code> parameter is the default task function reserved name.</p>
636
637<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the <code>name</code> parameter is a non-existing task function.</p>
638</div><aside class="tsd-sources">
639<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#setDefaultTaskFunction">setDefaultTaskFunction</a></p>
640<ul>
0e16e60a 641<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8975790/src/worker/abstract-worker.ts#L280">src/worker/abstract-worker.ts:280</a></li></ul></aside></li></ul></section>
3bd6a82e 642<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="triggerAsyncId" class="tsd-anchor"></a>
15d6dfaf 643<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 644<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 645<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>
a76fac14 646<li class="tsd-description">
fab6d3b5 647<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 648
649<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 650<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#triggerAsyncId">triggerAsyncId</a></p>
a76fac14 651<ul>
1d9f69fa 652<li>Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:311</li></ul></aside></li></ul></section>
3bd6a82e 653<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bind-2" class="tsd-anchor"></a>
15d6dfaf 654<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 655<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 656<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">&lt;</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">&gt;</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>
a76fac14
JB
657<li class="tsd-description">
658<div class="tsd-comment tsd-typography"><p>Binds the given function to the current execution context.</p>
a76fac14 659</div>
fab6d3b5 660<section class="tsd-panel">
a76fac14 661<h4>Type Parameters</h4>
fab6d3b5 662<ul class="tsd-type-parameter-list">
a76fac14 663<li>
3bd6a82e 664<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"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></h4></li>
a76fac14 665<li>
3bd6a82e 666<h4><span class="tsd-kind-type-parameter">ThisArg</span></h4></li></ul></section>
a76fac14
JB
667<div class="tsd-parameters">
668<h4 class="tsd-parameters-title">Parameters</h4>
669<ul class="tsd-parameter-list">
670<li>
3bd6a82e 671<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h5>
a76fac14 672<div class="tsd-comment tsd-typography"><p>The function to bind to the current execution context.</p>
15d6dfaf 673</div>
674<div class="tsd-comment tsd-typography"></div></li>
a76fac14 675<li>
3bd6a82e 676<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></h5>
a76fac14 677<div class="tsd-comment tsd-typography"><p>An optional name to associate with the underlying <code>AsyncResource</code>.</p>
15d6dfaf 678</div>
679<div class="tsd-comment tsd-typography"></div></li>
a76fac14 680<li>
3bd6a82e 681<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 682<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h4>
683<div class="tsd-comment tsd-typography">
684<h4>Since</h4><p>v14.8.0, v12.19.0</p>
685</div><aside class="tsd-sources">
6c525543 686<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#bind-2">bind</a></p>
a76fac14 687<ul>
1d9f69fa 688<li>Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:277</li></ul></aside></li></ul></section></section></div>
ec06e4dd 689<div class="col-sidebar">
690<div class="page-menu">
a76fac14
JB
691<div class="tsd-navigation settings">
692<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
15d6dfaf 693<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>
a76fac14
JB
694<div class="tsd-accordion-details">
695<div class="tsd-filter-visibility">
696<h4 class="uppercase">Member Visibility</h4><form>
697<ul id="tsd-filter-options">
698<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>
699<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>
700<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>
701<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>
702<div class="tsd-theme-toggle">
3bd6a82e 703<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>
ec06e4dd 704<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 705<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
a76fac14
JB
706<div class="tsd-accordion-details">
707<ul>
15d6dfaf 708<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>
7b88db4b 709<li><a href="#activeInterval" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>active<wbr/>Interval</span></a></li>
15d6dfaf 710<li><a href="#isMain" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>is<wbr/>Main</span></a></li>
711<li><a href="#lastTaskTimestamp" class="tsd-is-protected tsd-is-inherited"><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>
15d6dfaf 712<li><a href="#opts" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>opts</span></a></li>
76b46937 713<li><a href="#port" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>port</span></a></li>
afa30fd0 714<li><a href="#statistics" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>statistics</span></a></li>
15d6dfaf 715<li><a href="#taskFunctions" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>task<wbr/>Functions</span></a></li>
202bcb6b 716<li><a href="#id" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>id</span></a></li>
52f4e813 717<li><a href="#addTaskFunction" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Task<wbr/>Function</span></a></li>
15d6dfaf 718<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>
719<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>
15d6dfaf 720<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>
721<li><a href="#getMainWorker" class="tsd-is-protected tsd-is-inherited"><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>
202bcb6b 722<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>
76b46937 723<li><a href="#handleKillMessage" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Kill<wbr/>Message</span></a></li>
724<li><a href="#handleReadyMessage" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Ready<wbr/>Message</span></a></li>
52f4e813 725<li><a href="#hasTaskFunction" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Task<wbr/>Function</span></a></li>
88499cf9 726<li><a href="#listTaskFunctions" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Task<wbr/>Functions</span></a></li>
15d6dfaf 727<li><a href="#messageListener" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>message<wbr/>Listener</span></a></li>
52f4e813 728<li><a href="#removeTaskFunction" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Task<wbr/>Function</span></a></li>
f33c2d55 729<li><a href="#run" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run</span></a></li>
15d6dfaf 730<li><a href="#runAsync" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Async</span></a></li>
731<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>
732<li><a href="#runSync" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Sync</span></a></li>
013a4697 733<li><a href="#sendTaskFunctionsListToMainWorker" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Task<wbr/>Functions<wbr/>List<wbr/>To<wbr/>Main<wbr/>Worker</span></a></li>
15d6dfaf 734<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>
52f4e813 735<li><a href="#setDefaultTaskFunction" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Task<wbr/>Function</span></a></li>
15d6dfaf 736<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>
737<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>
ec06e4dd 738<div class="site-menu">
013a4697 739<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 -<wbr/> v2.6.26</span></a>
ec06e4dd 740<ul class="tsd-small-nested-navigation">
15d6dfaf 741<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>
742<li><a href="AbstractWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Abstract<wbr/>Worker</span></a></li>
743<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>
744<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>
745<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>
746<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>
747<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>
748<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>
749<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>
750<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>
751<li><a href="ThreadWorker.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Thread<wbr/>Worker</span></a></li>
752<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>
753<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>
f05afd16 754<li><a href="../interfaces/EventLoopUtilizationMeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Event<wbr/>Loop<wbr/>Utilization<wbr/>Measurement<wbr/>Statistics</span></a></li>
15d6dfaf 755<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>
756<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>
757<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>
a6b5c73c 758<li><a href="../interfaces/IWorkerNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker<wbr/>Node</span></a></li>
f05afd16 759<li><a href="../interfaces/MeasurementOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Measurement<wbr/>Options</span></a></li>
760<li><a href="../interfaces/MeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Measurement<wbr/>Statistics</span></a></li>
761<li><a href="../interfaces/MeasurementStatisticsRequirements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Measurement<wbr/>Statistics<wbr/>Requirements</span></a></li>
15d6dfaf 762<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>
763<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>
764<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>
765<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>
aba8d9bd 766<li><a href="../interfaces/StrategyPolicy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Strategy<wbr/>Policy</span></a></li>
15d6dfaf 767<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>
f05afd16 768<li><a href="../interfaces/TaskError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Error</span></a></li>
71056a0a 769<li><a href="../interfaces/TaskPerformance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Performance</span></a></li>
afa30fd0 770<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>
f05afd16 771<li><a href="../interfaces/TaskStatisticsRequirements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Statistics<wbr/>Requirements</span></a></li>
15d6dfaf 772<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>
f45a3823 773<li><a href="../interfaces/ThreadPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Thread<wbr/>Pool<wbr/>Options</span></a></li>
15d6dfaf 774<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>
ac2cb9e2 775<li><a href="../interfaces/WorkerInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Info</span></a></li>
15d6dfaf 776<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>
71056a0a 777<li><a href="../interfaces/WorkerStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Statistics</span></a></li>
f05afd16 778<li><a href="../interfaces/WorkerUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Usage</span></a></li>
030eb5a3 779<li><a href="../types/ErrorHandler.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>Error<wbr/>Handler</span></a></li>
15d6dfaf 780<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>
781<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>
0e16e60a 782<li><a href="../types/KillHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Kill<wbr/>Handler</span></a></li>
f05afd16 783<li><a href="../types/Measurement.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Measurement</span></a></li>
15d6dfaf 784<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>
785<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>
786<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>
787<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>
3c7c9bd1 788<li><a href="../types/TaskAsyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Async<wbr/>Function</span></a></li>
789<li><a href="../types/TaskFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Function</span></a></li>
15d6dfaf 790<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>
3c7c9bd1 791<li><a href="../types/TaskSyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Sync<wbr/>Function</span></a></li>
15d6dfaf 792<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>
15d6dfaf 793<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>
794<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>
f05afd16 795<li><a href="../variables/Measurements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Measurements</span></a></li>
15d6dfaf 796<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>
797<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>
798<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>
a97f9c80 799<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>
800<li><a href="../functions/availableParallelism.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>available<wbr/>Parallelism</span></a></li></ul></nav></div></div></div>
ec06e4dd 801<div class="tsd-generator">
a76fac14 802<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
ec06e4dd 803<div class="overlay"></div></body></html>