repositories / poolifier.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
chore: generate documentation
[poolifier.git] / docs / classes / ClusterWorker.html
CommitLineData
76b46937 1<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ClusterWorker | poolifier - v2.6.19</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>
76b46937 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.6.19</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="ClusterWorker.html">ClusterWorker</a></li></ul>
17<h1>Class ClusterWorker&lt;Data, Response&gt;</h1></div>
18<section class="tsd-panel tsd-comment">
19<div class="tsd-comment tsd-typography"><p>A cluster worker used by a poolifier <code>ClusterPool</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 worker.</p>
22<p>If you use a <code>DynamicClusterPool</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/Shinigami92">Christopher Quadflieg</a></p>
a76fac14 27
15d6dfaf 28<h4>Since</h4><p>2.0.0</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 worker. 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 ">Worker</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">ClusterWorker</span></li></ul></li></ul></section><aside class="tsd-sources">
49<ul>
76b46937 50<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/cluster-worker.ts#L21">src/worker/cluster-worker.ts:21</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="ClusterWorker.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="ClusterWorker.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="ClusterWorker.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="ClusterWorker.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="ClusterWorker.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>
afa30fd0 66<a href="ClusterWorker.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 67<a href="ClusterWorker.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		 68</div></section>
69<section class="tsd-index-section">
202bcb6b 70<h3 class="tsd-index-heading">Accessors</h3>
71<div class="tsd-index-list"><a href="ClusterWorker.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>
72</div></section>
73<section class="tsd-index-section">
a76fac14 74<h3 class="tsd-index-heading">Methods</h3>
52f4e813 75<div class="tsd-index-list"><a href="ClusterWorker.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>
76<a href="ClusterWorker.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 77<a href="ClusterWorker.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 78<a href="ClusterWorker.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>
79<a href="ClusterWorker.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 80<a href="ClusterWorker.html#handleError" 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>handle<wbr/>Error</span></a>
76b46937 81<a href="ClusterWorker.html#handleKillMessage" 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>handle<wbr/>Kill<wbr/>Message</span></a>
82<a href="ClusterWorker.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 83<a href="ClusterWorker.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 84<a href="ClusterWorker.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 85<a href="ClusterWorker.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 86<a href="ClusterWorker.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 87<a href="ClusterWorker.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 88<a href="ClusterWorker.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>
89<a href="ClusterWorker.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>
90<a href="ClusterWorker.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>
91<a href="ClusterWorker.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 92<a href="ClusterWorker.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 93<a href="ClusterWorker.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>
94<a href="ClusterWorker.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		 95</div></section></div></details></section></section>
96<section class="tsd-panel-group tsd-member-group">
97<h2>Constructors</h2>
3bd6a82e 98<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
15d6dfaf 99<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 100<ul class="tsd-signatures">
15d6dfaf 101<li class="tsd-signature tsd-anchor-link" id="constructor.new_ClusterWorker"><span class="tsd-kind-constructor-signature">new <wbr/>Cluster<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="ClusterWorker.html" class="tsd-signature-type tsd-kind-class">ClusterWorker</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_ClusterWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a76fac14
JB		 102<li class="tsd-description">
103<div class="tsd-comment tsd-typography"><p>Constructs a new poolifier cluster worker.</p>
104</div>
fab6d3b5 105<section class="tsd-panel">
a76fac14 106<h4>Type Parameters</h4>
fab6d3b5 107<ul class="tsd-type-parameter-list">
a76fac14 108<li>
3bd6a82e 109<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4></li>
a76fac14 110<li>
3bd6a82e 111<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section>
a76fac14
JB		 112<div class="tsd-parameters">
113<h4 class="tsd-parameters-title">Parameters</h4>
114<ul class="tsd-parameter-list">
115<li>
2c94c3a5 116<h5><span class="tsd-kind-parameter">taskFunctions</span>: <a href="../types/WorkerFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerFunction</a><span class="tsd-signature-symbol">&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>
117<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 118</div>
119<div class="tsd-comment tsd-typography"></div></li>
a76fac14 120<li>
8d1797ad 121<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 122<div class="tsd-comment tsd-typography"><p>Options for the worker.</p>
15d6dfaf 123</div>
124<div class="tsd-comment tsd-typography"></div></li></ul></div>
125<h4 class="tsd-returns-title">Returns <a href="ClusterWorker.html" class="tsd-signature-type tsd-kind-class">ClusterWorker</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>
126<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 127<p>Overrides <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#constructor">constructor</a></p>
a76fac14 128<ul>
76b46937 129<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/cluster-worker.ts#L31">src/worker/cluster-worker.ts:31</a></li></ul></aside></li></ul></section></section>
a76fac14
JB		 130<section class="tsd-panel-group tsd-member-group">
131<h2>Properties</h2>
7b88db4b 132<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="activeInterval" class="tsd-anchor"></a>
133<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>
134<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>
135<div class="tsd-comment tsd-typography"><p>Handler id of the <code>activeInterval</code> worker activity check.</p>
15d6dfaf 136</div>
137<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
7b88db4b 138<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#activeInterval">activeInterval</a></p>
a76fac14 139<ul>
76b46937 140<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L63">src/worker/abstract-worker.ts:63</a></li></ul></aside></section>
3bd6a82e 141<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="isMain" class="tsd-anchor"></a>
15d6dfaf 142<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 143<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 144<div class="tsd-comment tsd-typography"><p>Whether this is the main worker or not.</p>
15d6dfaf 145</div>
146<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 147<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#isMain">isMain</a></p>
0770fe62 148<ul>
76b46937 149<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L75">src/worker/abstract-worker.ts:75</a></li></ul></aside></section>
3bd6a82e 150<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="lastTaskTimestamp" class="tsd-anchor"></a>
15d6dfaf 151<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 152<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 153<div class="tsd-comment tsd-typography"><p>Timestamp of the last task processed by this worker.</p>
15d6dfaf 154</div>
155<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 156<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#lastTaskTimestamp">lastTaskTimestamp</a></p>
a76fac14 157<ul>
76b46937 158<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L55">src/worker/abstract-worker.ts:55</a></li></ul></aside></section>
3bd6a82e 159<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="opts" class="tsd-anchor"></a>
15d6dfaf 160<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 161<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 162<div class="tsd-comment tsd-typography"><p>Options for the worker.</p>
15d6dfaf 163</div>
164<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 165<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#opts">opts</a></p>
a76fac14 166<ul>
76b46937 167<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L80">src/worker/abstract-worker.ts:80</a></li></ul></aside></section>
afa30fd0 168<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="statistics" class="tsd-anchor"></a>
169<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 170<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 171<div class="tsd-comment tsd-typography"><p>Performance statistics computation requirements.</p>
afa30fd0 172</div>
173<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
174<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#statistics">statistics</a></p>
175<ul>
76b46937 176<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L59">src/worker/abstract-worker.ts:59</a></li></ul></aside></section>
2c94c3a5 177<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="taskFunctions" class="tsd-anchor"></a>
15d6dfaf 178<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>task<wbr/>Functions</span><a href="#taskFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
2c94c3a5 179<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/WorkerFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerFunction</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>
180<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 181</div>
182<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
2c94c3a5 183<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#taskFunctions">taskFunctions</a></p>
184<ul>
76b46937 185<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L51">src/worker/abstract-worker.ts:51</a></li></ul></aside></section></section>
202bcb6b 186<section class="tsd-panel-group tsd-member-group">
187<h2>Accessors</h2>
188<section class="tsd-panel tsd-member tsd-is-protected"><a id="id" class="tsd-anchor"></a>
189<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>
190<ul class="tsd-signatures tsd-is-protected">
191<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>
192<li class="tsd-description">
193<div class="tsd-comment tsd-typography"><p>Worker id.</p>
194</div>
195<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
196<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
197<p>Overrides AbstractWorker.id</p>
198<ul>
76b46937 199<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/cluster-worker.ts#L55">src/worker/cluster-worker.ts:55</a></li></ul></aside></li></ul></section></section>
a76fac14
JB		 200<section class="tsd-panel-group tsd-member-group">
201<h2>Methods</h2>
52f4e813 202<section class="tsd-panel tsd-member tsd-is-inherited"><a id="addTaskFunction" class="tsd-anchor"></a>
203<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>
204<ul class="tsd-signatures tsd-is-inherited">
205<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>
206<li class="tsd-description">
207<div class="tsd-comment tsd-typography"><p>Adds a task function to the worker.
208If a task function with the same name already exists, it is replaced.</p>
209</div>
210<div class="tsd-parameters">
211<h4 class="tsd-parameters-title">Parameters</h4>
212<ul class="tsd-parameter-list">
213<li>
214<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
215<div class="tsd-comment tsd-typography"><p>The name of the task function to add.</p>
216</div>
217<div class="tsd-comment tsd-typography"></div></li>
218<li>
219<h5><span class="tsd-kind-parameter">fn</span>: <a href="../types/WorkerFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerFunction</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>
220<div class="tsd-comment tsd-typography"><p>The task function to add.</p>
221</div>
222<div class="tsd-comment tsd-typography"></div></li></ul></div>
223<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the task function was added or not.</p>
224
225<div class="tsd-comment tsd-typography">
226<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>
227
228<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>
229
230<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>
231</div><aside class="tsd-sources">
232<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#addTaskFunction">addTaskFunction</a></p>
233<ul>
76b46937 234<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L186">src/worker/abstract-worker.ts:186</a></li></ul></aside></li></ul></section>
3bd6a82e 235<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="asyncId" class="tsd-anchor"></a>
15d6dfaf 236<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 237<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 238<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 239<li class="tsd-description">
fab6d3b5 240<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 241
242<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 243<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#asyncId">asyncId</a></p>
a76fac14 244<ul>
177be4a6 245<li>Defined in node_modules/.pnpm/@types+node@20.4.2/node_modules/@types/node/async_hooks.d.ts:306</li></ul></aside></li></ul></section>
3bd6a82e 246<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bind" class="tsd-anchor"></a>
15d6dfaf 247<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 248<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 249<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		 250<li class="tsd-description">
251<div class="tsd-comment tsd-typography"><p>Binds the given function to execute to this <code>AsyncResource</code>&#39;s scope.</p>
a76fac14 252</div>
fab6d3b5 253<section class="tsd-panel">
a76fac14 254<h4>Type Parameters</h4>
fab6d3b5 255<ul class="tsd-type-parameter-list">
a76fac14 256<li>
3bd6a82e 257<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		 258<div class="tsd-parameters">
259<h4 class="tsd-parameters-title">Parameters</h4>
260<ul class="tsd-parameter-list">
261<li>
3bd6a82e 262<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h5>
a76fac14 263<div class="tsd-comment tsd-typography"><p>The function to bind to the current <code>AsyncResource</code>.</p>
15d6dfaf 264</div>
265<div class="tsd-comment tsd-typography"></div></li></ul></div>
266<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h4>
267<div class="tsd-comment tsd-typography">
268<h4>Since</h4><p>v14.8.0, v12.19.0</p>
269</div><aside class="tsd-sources">
6c525543 270<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#bind">bind</a></p>
a76fac14 271<ul>
177be4a6 272<li>Defined in node_modules/.pnpm/@types+node@20.4.2/node_modules/@types/node/async_hooks.d.ts:283</li></ul></aside></li></ul></section>
3bd6a82e 273<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="emitDestroy" class="tsd-anchor"></a>
15d6dfaf 274<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 275<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 276<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="ClusterWorker.html" class="tsd-signature-type tsd-kind-class">ClusterWorker</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		 277<li class="tsd-description">
278<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		 279be thrown if it is called more than once. This <strong>must</strong> be manually called. If
280the resource is left to be collected by the GC then the <code>destroy</code> hooks will
281never be called.</p>
a76fac14 282</div>
fab6d3b5 283<h4 class="tsd-returns-title">Returns <a href="ClusterWorker.html" class="tsd-signature-type tsd-kind-class">ClusterWorker</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 284
285<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 286<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#emitDestroy">emitDestroy</a></p>
a76fac14 287<ul>
177be4a6 288<li>Defined in node_modules/.pnpm/@types+node@20.4.2/node_modules/@types/node/async_hooks.d.ts:302</li></ul></aside></li></ul></section>
3bd6a82e 289<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="getMainWorker" class="tsd-anchor"></a>
15d6dfaf 290<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 291<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 292<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 ">Worker</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		 293<li class="tsd-description">
294<div class="tsd-comment tsd-typography"><p>Returns the main worker.</p>
a76fac14 295</div>
fab6d3b5 296<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Worker</span></h4><p>Reference to the main worker.</p>
15d6dfaf 297
298<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 299<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#getMainWorker">getMainWorker</a></p>
a76fac14 300<ul>
76b46937 301<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L368">src/worker/abstract-worker.ts:368</a></li></ul></aside></li></ul></section>
202bcb6b 302<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="handleError" class="tsd-anchor"></a>
15d6dfaf 303<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 304<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 305<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 306<li class="tsd-description">
6c525543 307<div class="tsd-comment tsd-typography"><p>Handles an error and convert it to a string so it can be sent back to the main worker.</p>
6c525543 308</div>
a76fac14
JB		 309<div class="tsd-parameters">
310<h4 class="tsd-parameters-title">Parameters</h4>
311<ul class="tsd-parameter-list">
312<li>
3bd6a82e 313<h5><span class="tsd-kind-parameter">e</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></h5>
6c525543 314<div class="tsd-comment tsd-typography"><p>The error raised by the worker.</p>
15d6dfaf 315</div>
316<div class="tsd-comment tsd-typography"></div></li></ul></div>
6d6c7ed0 317<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The error message.</p>
15d6dfaf 318
319<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
202bcb6b 320<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#handleError">handleError</a></p>
a76fac14 321<ul>
76b46937 322<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L390">src/worker/abstract-worker.ts:390</a></li></ul></aside></li></ul></section>
323<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="handleKillMessage" class="tsd-anchor"></a>
324<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>
325<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
326<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>
327<li class="tsd-description">
328<div class="tsd-comment tsd-typography"><p>Handles a kill message sent by the main worker.</p>
329</div>
330<div class="tsd-parameters">
331<h4 class="tsd-parameters-title">Parameters</h4>
332<ul class="tsd-parameter-list">
333<li>
334<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>
335<div class="tsd-comment tsd-typography"><p>The kill message.</p>
336</div>
337<div class="tsd-comment tsd-typography"></div></li></ul></div>
338<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
339<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
340<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#handleKillMessage">handleKillMessage</a></p>
341<ul>
342<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L324">src/worker/abstract-worker.ts:324</a></li></ul></aside></li></ul></section>
343<section class="tsd-panel tsd-member tsd-is-protected"><a id="handleReadyMessage" class="tsd-anchor"></a>
344<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>
345<ul class="tsd-signatures tsd-is-protected">
346<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>
347<li class="tsd-description">
348<div class="tsd-comment tsd-typography"><p>Handles the ready message sent by the main worker.</p>
349</div>
350<div class="tsd-parameters">
351<h4 class="tsd-parameters-title">Parameters</h4>
352<ul class="tsd-parameter-list">
353<li>
354<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>
355<div class="tsd-comment tsd-typography"><p>The ready message.</p>
356</div>
357<div class="tsd-comment tsd-typography"></div></li></ul></div>
358<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
359<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
360<p>Overrides <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#handleReadyMessage">handleReadyMessage</a></p>
361<ul>
362<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/cluster-worker.ts#L47">src/worker/cluster-worker.ts:47</a></li></ul></aside></li></ul></section>
52f4e813 363<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hasTaskFunction" class="tsd-anchor"></a>
364<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>
365<ul class="tsd-signatures tsd-is-inherited">
366<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>
367<li class="tsd-description">
368<div class="tsd-comment tsd-typography"><p>Checks if the worker has a task function with the given name.</p>
369</div>
370<div class="tsd-parameters">
371<h4 class="tsd-parameters-title">Parameters</h4>
372<ul class="tsd-parameter-list">
373<li>
374<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
375<div class="tsd-comment tsd-typography"><p>The name of the task function to check.</p>
376</div>
377<div class="tsd-comment tsd-typography"></div></li></ul></div>
378<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>
379
380<div class="tsd-comment tsd-typography">
381<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>
382</div><aside class="tsd-sources">
383<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#hasTaskFunction">hasTaskFunction</a></p>
384<ul>
76b46937 385<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L168">src/worker/abstract-worker.ts:168</a></li></ul></aside></li></ul></section>
88499cf9 386<section class="tsd-panel tsd-member tsd-is-inherited"><a id="listTaskFunctions" class="tsd-anchor"></a>
387<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>
388<ul class="tsd-signatures tsd-is-inherited">
389<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>
390<li class="tsd-description">
391<div class="tsd-comment tsd-typography"><p>Lists the names of the worker&#39;s task functions.</p>
392</div>
393<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>
394
395<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
396<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#listTaskFunctions">listTaskFunctions</a></p>
397<ul>
76b46937 398<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L249">src/worker/abstract-worker.ts:249</a></li></ul></aside></li></ul></section>
3bd6a82e 399<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="messageListener" class="tsd-anchor"></a>
15d6dfaf 400<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 401<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
15d6dfaf 402<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 403<li class="tsd-description">
7cd8af00 404<div class="tsd-comment tsd-typography"><p>Worker message listener.</p>
405</div>
a76fac14
JB		 406<div class="tsd-parameters">
407<h4 class="tsd-parameters-title">Parameters</h4>
408<ul class="tsd-parameter-list">
409<li>
76b46937 410<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 411<div class="tsd-comment tsd-typography"><p>The received message.</p>
15d6dfaf 412</div>
413<div class="tsd-comment tsd-typography"></div></li></ul></div>
414<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
415<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 416<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#messageListener">messageListener</a></p>
a76fac14 417<ul>
76b46937 418<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L299">src/worker/abstract-worker.ts:299</a></li></ul></aside></li></ul></section>
52f4e813 419<section class="tsd-panel tsd-member tsd-is-inherited"><a id="removeTaskFunction" class="tsd-anchor"></a>
420<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>
421<ul class="tsd-signatures tsd-is-inherited">
422<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>
423<li class="tsd-description">
424<div class="tsd-comment tsd-typography"><p>Removes a task function from the worker.</p>
425</div>
426<div class="tsd-parameters">
427<h4 class="tsd-parameters-title">Parameters</h4>
428<ul class="tsd-parameter-list">
429<li>
430<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
431<div class="tsd-comment tsd-typography"><p>The name of the task function to remove.</p>
432</div>
433<div class="tsd-comment tsd-typography"></div></li></ul></div>
434<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>
435
436<div class="tsd-comment tsd-typography">
437<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>
438
439<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>
440
441<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>
442</div><aside class="tsd-sources">
443<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#removeTaskFunction">removeTaskFunction</a></p>
444<ul>
76b46937 445<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L225">src/worker/abstract-worker.ts:225</a></li></ul></aside></li></ul></section>
f33c2d55 446<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="run" class="tsd-anchor"></a>
447<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>
448<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
449<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>
450<li class="tsd-description">
451<div class="tsd-comment tsd-typography"><p>Runs the given task.</p>
452</div>
453<div class="tsd-parameters">
454<h4 class="tsd-parameters-title">Parameters</h4>
455<ul class="tsd-parameter-list">
456<li>
457<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>
458<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
459</div>
460<div class="tsd-comment tsd-typography"></div></li></ul></div>
461<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
462<div class="tsd-comment tsd-typography">
463<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>
464</div><aside class="tsd-sources">
465<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#run">run</a></p>
466<ul>
76b46937 467<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L400">src/worker/abstract-worker.ts:400</a></li></ul></aside></li></ul></section>
3bd6a82e 468<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="runAsync" class="tsd-anchor"></a>
15d6dfaf 469<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 470<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f33c2d55 471<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 472<li class="tsd-description">
08e40091 473<div class="tsd-comment tsd-typography"><p>Runs the given task function asynchronously.</p>
a76fac14
JB		 474</div>
475<div class="tsd-parameters">
476<h4 class="tsd-parameters-title">Parameters</h4>
477<ul class="tsd-parameter-list">
478<li>
8d1797ad 479<h5><span class="tsd-kind-parameter">fn</span>: <a href="../types/WorkerAsyncFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerAsyncFunction</a><span class="tsd-signature-symbol">&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 480<div class="tsd-comment tsd-typography"><p>Task function that will be executed.</p>
15d6dfaf 481</div>
482<div class="tsd-comment tsd-typography"></div></li>
a76fac14 483<li>
f33c2d55 484<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>
485<div class="tsd-comment tsd-typography"><p>Input data for the task function.</p>
15d6dfaf 486</div>
487<div class="tsd-comment tsd-typography"></div></li></ul></div>
488<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
489<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 490<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#runAsync">runAsync</a></p>
a76fac14 491<ul>
76b46937 492<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L454">src/worker/abstract-worker.ts:454</a></li></ul></aside></li></ul></section>
3bd6a82e 493<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runInAsyncScope" class="tsd-anchor"></a>
15d6dfaf 494<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 495<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 496<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		 497<li class="tsd-description">
498<div class="tsd-comment tsd-typography"><p>Call the provided function with the provided arguments in the execution context
24c3fcb4
JB		 499of the async resource. This will establish the context, trigger the AsyncHooks
500before callbacks, call the function, trigger the AsyncHooks after callbacks, and
501then restore the original execution context.</p>
a76fac14 502</div>
fab6d3b5 503<section class="tsd-panel">
a76fac14 504<h4>Type Parameters</h4>
fab6d3b5 505<ul class="tsd-type-parameter-list">
a76fac14 506<li>
3bd6a82e 507<h4><span class="tsd-kind-type-parameter">This</span></h4></li>
a76fac14 508<li>
3bd6a82e 509<h4><span class="tsd-kind-type-parameter">Result</span></h4></li></ul></section>
a76fac14
JB		 510<div class="tsd-parameters">
511<h4 class="tsd-parameters-title">Parameters</h4>
512<ul class="tsd-parameter-list">
513<li>
3bd6a82e 514<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		 515<div class="tsd-comment tsd-typography"><p>The function to call in the execution context of this async resource.</p>
516</div>
15d6dfaf 517<div class="tsd-comment tsd-typography"></div>
a76fac14
JB		 518<ul class="tsd-parameters">
519<li class="tsd-parameter-signature">
3bd6a82e 520<ul class="tsd-signatures tsd-is-external">
521<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		 522<li class="tsd-description">
523<div class="tsd-parameters">
524<h4 class="tsd-parameters-title">Parameters</h4>
525<ul class="tsd-parameter-list">
526<li>
3bd6a82e 527<h5><span class="tsd-kind-parameter">this</span>: <span class="tsd-signature-type tsd-kind-type-parameter">This</span></h5></li>
a76fac14 528<li>
3bd6a82e 529<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>
530<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Result</span></h4></li></ul></li></ul></li>
a76fac14 531<li>
3bd6a82e 532<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 533<div class="tsd-comment tsd-typography"><p>The receiver to be used for the function call.</p>
15d6dfaf 534</div>
535<div class="tsd-comment tsd-typography"></div></li>
a76fac14 536<li>
3bd6a82e 537<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 538<div class="tsd-comment tsd-typography"><p>Optional arguments to pass to the function.</p>
15d6dfaf 539</div>
540<div class="tsd-comment tsd-typography"></div></li></ul></div>
541<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Result</span></h4>
542<div class="tsd-comment tsd-typography">
543<h4>Since</h4><p>v9.6.0</p>
544</div><aside class="tsd-sources">
6c525543 545<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#runInAsyncScope">runInAsyncScope</a></p>
a76fac14 546<ul>
177be4a6 547<li>Defined in node_modules/.pnpm/@types+node@20.4.2/node_modules/@types/node/async_hooks.d.ts:294</li></ul></aside></li></ul></section>
2c94c3a5 548<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="runSync" class="tsd-anchor"></a>
15d6dfaf 549<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 550<ul class="tsd-signatures tsd-is-protected tsd-is-inherited">
f33c2d55 551<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 552<li class="tsd-description">
08e40091 553<div class="tsd-comment tsd-typography"><p>Runs the given task function synchronously.</p>
2c94c3a5 554</div>
555<div class="tsd-parameters">
556<h4 class="tsd-parameters-title">Parameters</h4>
557<ul class="tsd-parameter-list">
558<li>
559<h5><span class="tsd-kind-parameter">fn</span>: <a href="../types/WorkerSyncFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerSyncFunction</a><span class="tsd-signature-symbol">&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 560<div class="tsd-comment tsd-typography"><p>Task function that will be executed.</p>
15d6dfaf 561</div>
562<div class="tsd-comment tsd-typography"></div></li>
2c94c3a5 563<li>
f33c2d55 564<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>
565<div class="tsd-comment tsd-typography"><p>Input data for the task function.</p>
15d6dfaf 566</div>
567<div class="tsd-comment tsd-typography"></div></li></ul></div>
568<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
569<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
2c94c3a5 570<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#runSync">runSync</a></p>
571<ul>
76b46937 572<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L418">src/worker/abstract-worker.ts:418</a></li></ul></aside></li></ul></section>
3bd6a82e 573<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendToMainWorker" class="tsd-anchor"></a>
15d6dfaf 574<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 575<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 576<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 577<li class="tsd-description">
6c525543 578<div class="tsd-comment tsd-typography"><p>Sends a message to the main worker.</p>
579</div>
a76fac14
JB		 580<div class="tsd-parameters">
581<h4 class="tsd-parameters-title">Parameters</h4>
582<ul class="tsd-parameter-list">
583<li>
030eb5a3 584<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 585<div class="tsd-comment tsd-typography"><p>The response message.</p>
15d6dfaf 586</div>
587<div class="tsd-comment tsd-typography"></div></li></ul></div>
588<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
589<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 590<p>Overrides <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#sendToMainWorker">sendToMainWorker</a></p>
a76fac14 591<ul>
76b46937 592<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/cluster-worker.ts#L60">src/worker/cluster-worker.ts:60</a></li></ul></aside></li></ul></section>
52f4e813 593<section class="tsd-panel tsd-member tsd-is-inherited"><a id="setDefaultTaskFunction" class="tsd-anchor"></a>
594<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>
595<ul class="tsd-signatures tsd-is-inherited">
596<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>
597<li class="tsd-description">
88499cf9 598<div class="tsd-comment tsd-typography"><p>Sets the default task function to use in the worker.</p>
52f4e813 599</div>
600<div class="tsd-parameters">
601<h4 class="tsd-parameters-title">Parameters</h4>
602<ul class="tsd-parameter-list">
603<li>
604<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
605<div class="tsd-comment tsd-typography"><p>The name of the task function to use as default task function.</p>
606</div>
607<div class="tsd-comment tsd-typography"></div></li></ul></div>
608<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>
609
610<div class="tsd-comment tsd-typography">
611<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>
612
613<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>
614
615<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>
616</div><aside class="tsd-sources">
617<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#setDefaultTaskFunction">setDefaultTaskFunction</a></p>
618<ul>
76b46937 619<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/6248590/src/worker/abstract-worker.ts#L262">src/worker/abstract-worker.ts:262</a></li></ul></aside></li></ul></section>
3bd6a82e 620<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="triggerAsyncId" class="tsd-anchor"></a>
15d6dfaf 621<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 622<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 623<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 624<li class="tsd-description">
fab6d3b5 625<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 626
627<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 628<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#triggerAsyncId">triggerAsyncId</a></p>
a76fac14 629<ul>
177be4a6 630<li>Defined in node_modules/.pnpm/@types+node@20.4.2/node_modules/@types/node/async_hooks.d.ts:311</li></ul></aside></li></ul></section>
3bd6a82e 631<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bind-2" class="tsd-anchor"></a>
15d6dfaf 632<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 633<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 634<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		 635<li class="tsd-description">
636<div class="tsd-comment tsd-typography"><p>Binds the given function to the current execution context.</p>
a76fac14 637</div>
fab6d3b5 638<section class="tsd-panel">
a76fac14 639<h4>Type Parameters</h4>
fab6d3b5 640<ul class="tsd-type-parameter-list">
a76fac14 641<li>
3bd6a82e 642<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 643<li>
3bd6a82e 644<h4><span class="tsd-kind-type-parameter">ThisArg</span></h4></li></ul></section>
a76fac14
JB		 645<div class="tsd-parameters">
646<h4 class="tsd-parameters-title">Parameters</h4>
647<ul class="tsd-parameter-list">
648<li>
3bd6a82e 649<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h5>
a76fac14 650<div class="tsd-comment tsd-typography"><p>The function to bind to the current execution context.</p>
15d6dfaf 651</div>
652<div class="tsd-comment tsd-typography"></div></li>
a76fac14 653<li>
3bd6a82e 654<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 655<div class="tsd-comment tsd-typography"><p>An optional name to associate with the underlying <code>AsyncResource</code>.</p>
15d6dfaf 656</div>
657<div class="tsd-comment tsd-typography"></div></li>
a76fac14 658<li>
3bd6a82e 659<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 660<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h4>
661<div class="tsd-comment tsd-typography">
662<h4>Since</h4><p>v14.8.0, v12.19.0</p>
663</div><aside class="tsd-sources">
6c525543 664<p>Inherited from <a href="AbstractWorker.html">AbstractWorker</a>.<a href="AbstractWorker.html#bind-2">bind</a></p>
a76fac14 665<ul>
177be4a6 666<li>Defined in node_modules/.pnpm/@types+node@20.4.2/node_modules/@types/node/async_hooks.d.ts:277</li></ul></aside></li></ul></section></section></div>
ec06e4dd 667<div class="col-sidebar">
668<div class="page-menu">
a76fac14
JB		 669<div class="tsd-navigation settings">
670<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
15d6dfaf 671<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		 672<div class="tsd-accordion-details">
673<div class="tsd-filter-visibility">
674<h4 class="uppercase">Member Visibility</h4><form>
675<ul id="tsd-filter-options">
676<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>
677<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>
678<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>
679<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>
680<div class="tsd-theme-toggle">
3bd6a82e 681<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 682<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 683<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		 684<div class="tsd-accordion-details">
685<ul>
15d6dfaf 686<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 687<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 688<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>
689<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 690<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>
afa30fd0 691<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 692<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 693<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 694<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 695<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>
696<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 697<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>
698<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 699<li><a href="#handleError" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Error</span></a></li>
76b46937 700<li><a href="#handleKillMessage" class="tsd-is-protected tsd-is-inherited"><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>
701<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 702<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 703<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 704<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 705<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 706<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 707<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>
708<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>
709<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>
710<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 711<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 712<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>
713<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 714<div class="site-menu">
76b46937 715<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.19</span></a>
ec06e4dd 716<ul class="tsd-small-nested-navigation">
15d6dfaf 717<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>
718<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>
719<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>
720<li><a href="ClusterWorker.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cluster<wbr/>Worker</span></a></li>
721<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>
722<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>
723<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>
724<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>
725<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>
726<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>
727<li><a href="ThreadWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Thread<wbr/>Worker</span></a></li>
728<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>
729<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 730<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 731<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>
732<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>
733<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 734<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 735<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>
736<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>
737<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 738<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>
739<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>
740<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>
741<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 742<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 743<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 744<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 745<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 746<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 747<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 748<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 749<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 750<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 751<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 752<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 753<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 754<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 755<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 756<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>
757<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>
f05afd16 758<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 759<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>
760<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>
761<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>
762<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>
763<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>
15d6dfaf 764<li><a href="../types/WorkerAsyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Async<wbr/>Function</span></a></li>
765<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>
766<li><a href="../types/WorkerFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Function</span></a></li>
767<li><a href="../types/WorkerSyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Sync<wbr/>Function</span></a></li>
768<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>
769<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 770<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 771<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>
772<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>
773<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 774<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>
775<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 776<div class="tsd-generator">
a76fac14 777<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
ec06e4dd 778<div class="overlay"></div></body></html>
Fast and small Node.js thread pool implementation mirror - https://github.com/poolifier/poolifier