docs: fix typedoc warnings
[poolifier.git] / docs / classes / AbstractWorker.html
CommitLineData
f38f85c0 1<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AbstractWorker | poolifier - v2.6.12</title><meta name="description" content="Documentation for poolifier"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
6c525543 2<div class="tsd-toolbar-contents container">
3<div class="table-cell" id="tsd-search" data-base="..">
4<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5<div class="field">
6<div id="tsd-toolbar-links"></div></div>
7<ul class="results">
8<li class="state loading">Preparing search index...</li>
f38f85c0 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.6.12</a></div>
6c525543 10<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11<div class="container container-main">
12<div class="col-content">
13<div class="tsd-page-title">
14<ul class="tsd-breadcrumb">
15<li><a href="../index.html">poolifier</a></li>
16<li><a href="AbstractWorker.html">AbstractWorker</a></li></ul>
17<h1>Class AbstractWorker&lt;MainWorker, Data, Response&gt;<code class="tsd-tag ts-flagAbstract">Abstract</code> </h1></div>
18<section class="tsd-panel tsd-comment">
19<div class="tsd-comment tsd-typography"><p>Base class that implements some shared logic for all poolifier workers.</p>
15d6dfaf 20</div>
21<div class="tsd-comment tsd-typography"></div></section>
fab6d3b5 22<section class="tsd-panel">
6c525543 23<h4>Type Parameters</h4>
fab6d3b5 24<ul class="tsd-type-parameter-list">
6c525543 25<li>
3bd6a82e 26<h4><span class="tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MessagePort</span></h4>
6c525543 27<div class="tsd-comment tsd-typography"><p>Type of main worker.</p>
15d6dfaf 28</div>
29<div class="tsd-comment tsd-typography"></div></li>
6c525543 30<li>
3bd6a82e 31<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 32<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 33</div>
34<div class="tsd-comment tsd-typography"></div></li>
6c525543 35<li>
3bd6a82e 36<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4>
030eb5a3 37<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 38</div>
39<div class="tsd-comment tsd-typography"></div></li></ul></section>
6c525543 40<section class="tsd-panel tsd-hierarchy">
41<h4>Hierarchy</h4>
42<ul class="tsd-hierarchy">
3bd6a82e 43<li><span class="tsd-signature-type ">AsyncResource</span>
6c525543 44<ul class="tsd-hierarchy">
45<li><span class="target">AbstractWorker</span>
46<ul class="tsd-hierarchy">
8d1797ad 47<li><a href="ClusterWorker.html" class="tsd-signature-type tsd-kind-class">ClusterWorker</a></li>
48<li><a href="ThreadWorker.html" class="tsd-signature-type tsd-kind-class">ThreadWorker</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
6c525543 49<ul>
a109e1c6 50<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L34">src/worker/abstract-worker.ts:34</a></li></ul></aside>
6c525543 51<section class="tsd-panel-group tsd-index-group">
52<section class="tsd-panel tsd-index-panel">
53<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
54<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
55<div class="tsd-accordion-details">
56<section class="tsd-index-section">
57<h3 class="tsd-index-heading">Constructors</h3>
15d6dfaf 58<div class="tsd-index-list"><a href="AbstractWorker.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>constructor</span></a>
6c525543 59</div></section>
60<section class="tsd-index-section">
61<h3 class="tsd-index-heading">Properties</h3>
15d6dfaf 62<div class="tsd-index-list"><a href="AbstractWorker.html#aliveInterval" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>alive<wbr/>Interval?</span></a>
202bcb6b 63<a href="AbstractWorker.html#id" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>id</span></a>
15d6dfaf 64<a href="AbstractWorker.html#isMain" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>is<wbr/>Main</span></a>
65<a href="AbstractWorker.html#lastTaskTimestamp" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>last<wbr/>Task<wbr/>Timestamp</span></a>
66<a href="AbstractWorker.html#mainWorker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>main<wbr/>Worker</span></a>
67<a href="AbstractWorker.html#opts" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>opts</span></a>
afa30fd0 68<a href="AbstractWorker.html#statistics" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>statistics</span></a>
15d6dfaf 69<a href="AbstractWorker.html#taskFunctions" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>task<wbr/>Functions</span></a>
6c525543 70</div></section>
71<section class="tsd-index-section">
72<h3 class="tsd-index-heading">Methods</h3>
15d6dfaf 73<div class="tsd-index-list"><a href="AbstractWorker.html#asyncId" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>async<wbr/>Id</span></a>
afa30fd0 74<a href="AbstractWorker.html#beginTaskPerformance" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>begin<wbr/>Task<wbr/>Performance</span></a>
15d6dfaf 75<a href="AbstractWorker.html#bind" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>bind</span></a>
a6b5c73c 76<a href="AbstractWorker.html#checkAlive" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Alive</span></a>
030eb5a3 77<a href="AbstractWorker.html#checkStatistics" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Statistics</span></a>
15d6dfaf 78<a href="AbstractWorker.html#checkTaskFunctions" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Task<wbr/>Functions</span></a>
79<a href="AbstractWorker.html#checkWorkerOptions" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Worker<wbr/>Options</span></a>
80<a href="AbstractWorker.html#emitDestroy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit<wbr/>Destroy</span></a>
afa30fd0 81<a href="AbstractWorker.html#endTaskPerformance" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>end<wbr/>Task<wbr/>Performance</span></a>
15d6dfaf 82<a href="AbstractWorker.html#getMainWorker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Main<wbr/>Worker</span></a>
83<a href="AbstractWorker.html#getTaskFunction" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Task<wbr/>Function</span></a>
84<a href="AbstractWorker.html#handleError" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Error</span></a>
85<a href="AbstractWorker.html#messageListener" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>message<wbr/>Listener</span></a>
86<a href="AbstractWorker.html#runAsync" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Async</span></a>
87<a href="AbstractWorker.html#runInAsyncScope" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>In<wbr/>Async<wbr/>Scope</span></a>
88<a href="AbstractWorker.html#runSync" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Sync</span></a>
89<a href="AbstractWorker.html#sendToMainWorker" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>To<wbr/>Main<wbr/>Worker</span></a>
b667be11 90<a href="AbstractWorker.html#startCheckAlive" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>start<wbr/>Check<wbr/>Alive</span></a>
a6b5c73c 91<a href="AbstractWorker.html#stopCheckAlive" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>stop<wbr/>Check<wbr/>Alive</span></a>
15d6dfaf 92<a href="AbstractWorker.html#triggerAsyncId" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>trigger<wbr/>Async<wbr/>Id</span></a>
c914a50e 93<a href="AbstractWorker.html#workerReady" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>worker<wbr/>Ready</span></a>
15d6dfaf 94<a href="AbstractWorker.html#bind-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>bind</span></a>
6c525543 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_AbstractWorker"><span class="tsd-kind-constructor-signature">new <wbr/>Abstract<wbr/>Worker</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span>, <span class="tsd-kind-parameter">isMain</span>, <span class="tsd-kind-parameter">taskFunctions</span>, <span class="tsd-kind-parameter">mainWorker</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AbstractWorker.html" class="tsd-signature-type tsd-kind-class">AbstractWorker</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_AbstractWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 102<li class="tsd-description">
103<div class="tsd-comment tsd-typography"><p>Constructs a new poolifier worker.</p>
104</div>
fab6d3b5 105<section class="tsd-panel">
6c525543 106<h4>Type Parameters</h4>
fab6d3b5 107<ul class="tsd-type-parameter-list">
6c525543 108<li>
3bd6a82e 109<h4><span class="tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MessagePort</span></h4></li>
6c525543 110<li>
3bd6a82e 111<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4></li>
6c525543 112<li>
3bd6a82e 113<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section>
6c525543 114<div class="tsd-parameters">
115<h4 class="tsd-parameters-title">Parameters</h4>
116<ul class="tsd-parameter-list">
117<li>
3bd6a82e 118<h5><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></h5>
6c525543 119<div class="tsd-comment tsd-typography"><p>The type of async event.</p>
15d6dfaf 120</div>
121<div class="tsd-comment tsd-typography"></div></li>
6c525543 122<li>
3bd6a82e 123<h5><span class="tsd-kind-parameter">isMain</span>: <span class="tsd-signature-type">boolean</span></h5>
6c525543 124<div class="tsd-comment tsd-typography"><p>Whether this is the main worker or not.</p>
15d6dfaf 125</div>
126<div class="tsd-comment tsd-typography"></div></li>
6c525543 127<li>
2c94c3a5 128<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>
129<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. The first function is the default function.</p>
15d6dfaf 130</div>
131<div class="tsd-comment tsd-typography"></div></li>
6c525543 132<li>
030eb5a3 133<h5><span class="tsd-kind-parameter">mainWorker</span>: <span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span></h5>
6c525543 134<div class="tsd-comment tsd-typography"><p>Reference to main worker.</p>
15d6dfaf 135</div>
136<div class="tsd-comment tsd-typography"></div></li>
6c525543 137<li>
8d1797ad 138<h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/WorkerOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
6c525543 139<div class="tsd-comment tsd-typography"><p>Options for the worker.</p>
15d6dfaf 140</div>
141<div class="tsd-comment tsd-typography"></div></li></ul></div>
142<h4 class="tsd-returns-title">Returns <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 tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span></h4>
143<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 144<p>Overrides AsyncResource.constructor</p>
145<ul>
a109e1c6 146<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L68">src/worker/abstract-worker.ts:68</a></li></ul></aside></li></ul></section></section>
6c525543 147<section class="tsd-panel-group tsd-member-group">
148<h2>Properties</h2>
3bd6a82e 149<section class="tsd-panel tsd-member tsd-is-protected"><a id="aliveInterval" class="tsd-anchor"></a>
b667be11 150<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>alive<wbr/>Interval</span><a href="#aliveInterval" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
8d1797ad 151<div class="tsd-signature"><span class="tsd-kind-property">alive<wbr/>Interval</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Timeout</span></div>
6c525543 152<div class="tsd-comment tsd-typography"><p>Handler id of the <code>aliveInterval</code> worker alive check.</p>
15d6dfaf 153</div>
154<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 155<ul>
a109e1c6 156<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L58">src/worker/abstract-worker.ts:58</a></li></ul></aside></section>
202bcb6b 157<section class="tsd-panel tsd-member tsd-is-protected"><a id="id" class="tsd-anchor"></a>
158<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</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>
159<div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
160<div class="tsd-comment tsd-typography"><p>Worker id.</p>
161</div>
162<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
163<ul>
a109e1c6 164<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L42">src/worker/abstract-worker.ts:42</a></li></ul></aside></section>
3bd6a82e 165<section class="tsd-panel tsd-member tsd-is-protected"><a id="isMain" class="tsd-anchor"></a>
15d6dfaf 166<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 167<div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Main</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
6c525543 168<div class="tsd-comment tsd-typography"><p>Whether this is the main worker or not.</p>
15d6dfaf 169</div>
170<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 171<ul>
a109e1c6 172<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L70">src/worker/abstract-worker.ts:70</a></li></ul></aside></section>
3bd6a82e 173<section class="tsd-panel tsd-member tsd-is-protected"><a id="lastTaskTimestamp" class="tsd-anchor"></a>
15d6dfaf 174<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 175<div class="tsd-signature"><span class="tsd-kind-property">last<wbr/>Task<wbr/>Timestamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
6c525543 176<div class="tsd-comment tsd-typography"><p>Timestamp of the last task processed by this worker.</p>
15d6dfaf 177</div>
178<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 179<ul>
a109e1c6 180<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L50">src/worker/abstract-worker.ts:50</a></li></ul></aside></section>
3bd6a82e 181<section class="tsd-panel tsd-member tsd-is-protected"><a id="mainWorker" class="tsd-anchor"></a>
a6d9dccf 182<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>main<wbr/>Worker</span><a href="#mainWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
030eb5a3 183<div class="tsd-signature"><span class="tsd-kind-property">main<wbr/>Worker</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span></div>
6c525543 184<div class="tsd-comment tsd-typography"><p>Reference to main worker.</p>
15d6dfaf 185</div>
186<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 187<ul>
a109e1c6 188<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L74">src/worker/abstract-worker.ts:74</a></li></ul></aside></section>
3bd6a82e 189<section class="tsd-panel tsd-member tsd-is-protected"><a id="opts" class="tsd-anchor"></a>
15d6dfaf 190<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 191<div class="tsd-signature"><span class="tsd-kind-property">opts</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/WorkerOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerOptions</a><span class="tsd-signature-symbol"> = ...</span></div>
6c525543 192<div class="tsd-comment tsd-typography"><p>Options for the worker.</p>
15d6dfaf 193</div>
194<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 195<ul>
a109e1c6 196<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L75">src/worker/abstract-worker.ts:75</a></li></ul></aside></section>
afa30fd0 197<section class="tsd-panel tsd-member tsd-is-protected"><a id="statistics" class="tsd-anchor"></a>
198<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 199<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 200<div class="tsd-comment tsd-typography"><p>Performance statistics computation requirements.</p>
afa30fd0 201</div>
202<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
203<ul>
a109e1c6 204<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L54">src/worker/abstract-worker.ts:54</a></li></ul></aside></section>
2c94c3a5 205<section class="tsd-panel tsd-member tsd-is-protected"><a id="taskFunctions" class="tsd-anchor"></a>
15d6dfaf 206<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 207<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>
208<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 209</div>
210<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
2c94c3a5 211<ul>
a109e1c6 212<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L46">src/worker/abstract-worker.ts:46</a></li></ul></aside></section></section>
6c525543 213<section class="tsd-panel-group tsd-member-group">
214<h2>Methods</h2>
3bd6a82e 215<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="asyncId" class="tsd-anchor"></a>
15d6dfaf 216<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 217<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 218<li class="tsd-signature tsd-anchor-link" id="asyncId.asyncId-1"><span class="tsd-kind-call-signature">async<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#asyncId.asyncId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 219<li class="tsd-description">
fab6d3b5 220<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 221
222<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 223<p>Inherited from AsyncResource.asyncId</p>
224<ul>
47c9cec4 225<li>Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:306</li></ul></aside></li></ul></section>
afa30fd0 226<section class="tsd-panel tsd-member tsd-is-private"><a id="beginTaskPerformance" class="tsd-anchor"></a>
227<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>begin<wbr/>Task<wbr/>Performance</span><a href="#beginTaskPerformance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
228<ul class="tsd-signatures tsd-is-private">
f05afd16 229<li class="tsd-signature tsd-anchor-link" id="beginTaskPerformance.beginTaskPerformance-1"><span class="tsd-kind-call-signature">begin<wbr/>Task<wbr/>Performance</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskPerformance.html" class="tsd-signature-type tsd-kind-interface">TaskPerformance</a><a href="#beginTaskPerformance.beginTaskPerformance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
afa30fd0 230<li class="tsd-description">
71056a0a 231<h4 class="tsd-returns-title">Returns <a href="../interfaces/TaskPerformance.html" class="tsd-signature-type tsd-kind-interface">TaskPerformance</a></h4><aside class="tsd-sources">
afa30fd0 232<ul>
a109e1c6 233<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L335">src/worker/abstract-worker.ts:335</a></li></ul></aside></li></ul></section>
3bd6a82e 234<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bind" class="tsd-anchor"></a>
15d6dfaf 235<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 236<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 237<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>
6c525543 238<li class="tsd-description">
239<div class="tsd-comment tsd-typography"><p>Binds the given function to execute to this <code>AsyncResource</code>&#39;s scope.</p>
6c525543 240</div>
fab6d3b5 241<section class="tsd-panel">
6c525543 242<h4>Type Parameters</h4>
fab6d3b5 243<ul class="tsd-type-parameter-list">
6c525543 244<li>
3bd6a82e 245<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>
6c525543 246<div class="tsd-parameters">
247<h4 class="tsd-parameters-title">Parameters</h4>
248<ul class="tsd-parameter-list">
249<li>
3bd6a82e 250<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h5>
6c525543 251<div class="tsd-comment tsd-typography"><p>The function to bind to the current <code>AsyncResource</code>.</p>
15d6dfaf 252</div>
253<div class="tsd-comment tsd-typography"></div></li></ul></div>
254<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h4>
255<div class="tsd-comment tsd-typography">
256<h4>Since</h4><p>v14.8.0, v12.19.0</p>
257</div><aside class="tsd-sources">
6c525543 258<p>Inherited from AsyncResource.bind</p>
259<ul>
47c9cec4 260<li>Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:283</li></ul></aside></li></ul></section>
a6b5c73c 261<section class="tsd-panel tsd-member tsd-is-private"><a id="checkAlive" class="tsd-anchor"></a>
262<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Alive</span><a href="#checkAlive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
263<ul class="tsd-signatures tsd-is-private">
15d6dfaf 264<li class="tsd-signature tsd-anchor-link" id="checkAlive.checkAlive-1"><span class="tsd-kind-call-signature">check<wbr/>Alive</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkAlive.checkAlive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 265<li class="tsd-description">
266<div class="tsd-comment tsd-typography"><p>Checks if the worker should be terminated, because its living too long.</p>
267</div>
15d6dfaf 268<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
269<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 270<ul>
a109e1c6 271<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L203">src/worker/abstract-worker.ts:203</a></li></ul></aside></li></ul></section>
030eb5a3 272<section class="tsd-panel tsd-member tsd-is-private"><a id="checkStatistics" class="tsd-anchor"></a>
273<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Statistics</span><a href="#checkStatistics" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
274<ul class="tsd-signatures tsd-is-private">
275<li class="tsd-signature tsd-anchor-link" id="checkStatistics.checkStatistics-1"><span class="tsd-kind-call-signature">check<wbr/>Statistics</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkStatistics.checkStatistics-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
276<li class="tsd-description">
277<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
278<ul>
a109e1c6 279<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L358">src/worker/abstract-worker.ts:358</a></li></ul></aside></li></ul></section>
2c94c3a5 280<section class="tsd-panel tsd-member tsd-is-private"><a id="checkTaskFunctions" class="tsd-anchor"></a>
15d6dfaf 281<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Task<wbr/>Functions</span><a href="#checkTaskFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 282<ul class="tsd-signatures tsd-is-private">
15d6dfaf 283<li class="tsd-signature tsd-anchor-link" id="checkTaskFunctions.checkTaskFunctions-1"><span class="tsd-kind-call-signature">check<wbr/>Task<wbr/>Functions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskFunctions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkTaskFunctions.checkTaskFunctions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 284<li class="tsd-description">
2c94c3a5 285<div class="tsd-comment tsd-typography"><p>Checks if the <code>taskFunctions</code> parameter is passed to the constructor.</p>
6c525543 286</div>
287<div class="tsd-parameters">
288<h4 class="tsd-parameters-title">Parameters</h4>
289<ul class="tsd-parameter-list">
290<li>
2c94c3a5 291<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>
292<div class="tsd-comment tsd-typography"><p>The task function(s) parameter that should be checked.</p>
15d6dfaf 293</div>
294<div class="tsd-comment tsd-typography"></div></li></ul></div>
295<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
296<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 297<ul>
a109e1c6 298<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L107">src/worker/abstract-worker.ts:107</a></li></ul></aside></li></ul></section>
3bd6a82e 299<section class="tsd-panel tsd-member tsd-is-private"><a id="checkWorkerOptions" class="tsd-anchor"></a>
15d6dfaf 300<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Worker<wbr/>Options</span><a href="#checkWorkerOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 301<ul class="tsd-signatures tsd-is-private">
15d6dfaf 302<li class="tsd-signature tsd-anchor-link" id="checkWorkerOptions.checkWorkerOptions-1"><span class="tsd-kind-call-signature">check<wbr/>Worker<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkWorkerOptions.checkWorkerOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 303<li class="tsd-description">
304<div class="tsd-parameters">
305<h4 class="tsd-parameters-title">Parameters</h4>
306<ul class="tsd-parameter-list">
307<li>
8d1797ad 308<h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/WorkerOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerOptions</a></h5></li></ul></div>
6c525543 309<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
310<ul>
a109e1c6 311<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L95">src/worker/abstract-worker.ts:95</a></li></ul></aside></li></ul></section>
3bd6a82e 312<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="emitDestroy" class="tsd-anchor"></a>
15d6dfaf 313<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 314<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 315<li class="tsd-signature tsd-anchor-link" id="emitDestroy.emitDestroy-1"><span class="tsd-kind-call-signature">emit<wbr/>Destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AbstractWorker.html" class="tsd-signature-type tsd-kind-class">AbstractWorker</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&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>
6c525543 316<li class="tsd-description">
317<div class="tsd-comment tsd-typography"><p>Call all <code>destroy</code> hooks. This should only ever be called once. An error will
318be thrown if it is called more than once. This <strong>must</strong> be manually called. If
319the resource is left to be collected by the GC then the <code>destroy</code> hooks will
320never be called.</p>
6c525543 321</div>
fab6d3b5 322<h4 class="tsd-returns-title">Returns <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 tsd-kind-type-parameter">MainWorker</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A reference to <code>asyncResource</code>.</p>
15d6dfaf 323
324<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 325<p>Inherited from AsyncResource.emitDestroy</p>
326<ul>
47c9cec4 327<li>Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:302</li></ul></aside></li></ul></section>
afa30fd0 328<section class="tsd-panel tsd-member tsd-is-private"><a id="endTaskPerformance" class="tsd-anchor"></a>
329<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>end<wbr/>Task<wbr/>Performance</span><a href="#endTaskPerformance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
330<ul class="tsd-signatures tsd-is-private">
71056a0a 331<li class="tsd-signature tsd-anchor-link" id="endTaskPerformance.endTaskPerformance-1"><span class="tsd-kind-call-signature">end<wbr/>Task<wbr/>Performance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">taskPerformance</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/TaskPerformance.html" class="tsd-signature-type tsd-kind-interface">TaskPerformance</a><a href="#endTaskPerformance.endTaskPerformance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
afa30fd0 332<li class="tsd-description">
333<div class="tsd-parameters">
334<h4 class="tsd-parameters-title">Parameters</h4>
335<ul class="tsd-parameter-list">
336<li>
71056a0a 337<h5><span class="tsd-kind-parameter">taskPerformance</span>: <a href="../interfaces/TaskPerformance.html" class="tsd-signature-type tsd-kind-interface">TaskPerformance</a></h5></li></ul></div>
338<h4 class="tsd-returns-title">Returns <a href="../interfaces/TaskPerformance.html" class="tsd-signature-type tsd-kind-interface">TaskPerformance</a></h4><aside class="tsd-sources">
afa30fd0 339<ul>
a109e1c6 340<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L343">src/worker/abstract-worker.ts:343</a></li></ul></aside></li></ul></section>
3bd6a82e 341<section class="tsd-panel tsd-member tsd-is-protected"><a id="getMainWorker" class="tsd-anchor"></a>
15d6dfaf 342<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 343<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 344<li class="tsd-signature tsd-anchor-link" id="getMainWorker.getMainWorker-1"><span class="tsd-kind-call-signature">get<wbr/>Main<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span><a href="#getMainWorker.getMainWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 345<li class="tsd-description">
346<div class="tsd-comment tsd-typography"><p>Returns the main worker.</p>
6c525543 347</div>
fab6d3b5 348<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span></h4><p>Reference to the main worker.</p>
15d6dfaf 349
350<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 351<ul>
a109e1c6 352<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L217">src/worker/abstract-worker.ts:217</a></li></ul></aside></li></ul></section>
2c94c3a5 353<section class="tsd-panel tsd-member tsd-is-private"><a id="getTaskFunction" class="tsd-anchor"></a>
15d6dfaf 354<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>get<wbr/>Task<wbr/>Function</span><a href="#getTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
2c94c3a5 355<ul class="tsd-signatures tsd-is-private">
15d6dfaf 356<li class="tsd-signature tsd-anchor-link" id="getTaskFunction.getTaskFunction-1"><span class="tsd-kind-call-signature">get<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/WorkerFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerFunction</a><span class="tsd-signature-symbol">&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="#getTaskFunction.getTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
2c94c3a5 357<li class="tsd-description">
358<div class="tsd-comment tsd-typography"><p>Gets the task function in the given scope.</p>
359</div>
360<div class="tsd-parameters">
361<h4 class="tsd-parameters-title">Parameters</h4>
362<ul class="tsd-parameter-list">
363<li>
364<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
365<div class="tsd-comment tsd-typography"><p>Name of the function that will be returned.</p>
15d6dfaf 366</div>
367<div class="tsd-comment tsd-typography"></div></li></ul></div>
368<h4 class="tsd-returns-title">Returns <a href="../types/WorkerFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerFunction</a><span class="tsd-signature-symbol">&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>
369<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
2c94c3a5 370<ul>
a109e1c6 371<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L326">src/worker/abstract-worker.ts:326</a></li></ul></aside></li></ul></section>
3bd6a82e 372<section class="tsd-panel tsd-member tsd-is-protected"><a id="handleError" class="tsd-anchor"></a>
15d6dfaf 373<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>handle<wbr/>Error</span><a href="#handleError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 374<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 375<li class="tsd-signature tsd-anchor-link" id="handleError.handleError-1"><span class="tsd-kind-call-signature">handle<wbr/>Error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">e</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#handleError.handleError-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 376<li class="tsd-description">
377<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 378</div>
379<div class="tsd-parameters">
380<h4 class="tsd-parameters-title">Parameters</h4>
381<ul class="tsd-parameter-list">
382<li>
3bd6a82e 383<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 384<div class="tsd-comment tsd-typography"><p>The error raised by the worker.</p>
15d6dfaf 385</div>
386<div class="tsd-comment tsd-typography"></div></li></ul></div>
6d6c7ed0 387<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The error message.</p>
15d6dfaf 388
389<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 390<ul>
a109e1c6 391<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L239">src/worker/abstract-worker.ts:239</a></li></ul></aside></li></ul></section>
3bd6a82e 392<section class="tsd-panel tsd-member tsd-is-protected"><a id="messageListener" class="tsd-anchor"></a>
15d6dfaf 393<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 394<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 395<li class="tsd-signature tsd-anchor-link" id="messageListener.messageListener-1"><span class="tsd-kind-call-signature">message<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#messageListener.messageListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 396<li class="tsd-description">
397<div class="tsd-comment tsd-typography"><p>Worker message listener.</p>
398</div>
399<div class="tsd-parameters">
400<h4 class="tsd-parameters-title">Parameters</h4>
401<ul class="tsd-parameter-list">
402<li>
030eb5a3 403<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 tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span></h5>
6c525543 404<div class="tsd-comment tsd-typography"><p>Message received.</p>
15d6dfaf 405</div>
406<div class="tsd-comment tsd-typography"></div></li></ul></div>
407<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
408<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 409<ul>
a109e1c6 410<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L147">src/worker/abstract-worker.ts:147</a></li></ul></aside></li></ul></section>
3bd6a82e 411<section class="tsd-panel tsd-member tsd-is-protected"><a id="runAsync" class="tsd-anchor"></a>
15d6dfaf 412<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 413<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 414<li class="tsd-signature tsd-anchor-link" id="runAsync.runAsync-1"><span class="tsd-kind-call-signature">run<wbr/>Async</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#runAsync.runAsync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 415<li class="tsd-description">
416<div class="tsd-comment tsd-typography"><p>Runs the given function asynchronously.</p>
417</div>
418<div class="tsd-parameters">
419<h4 class="tsd-parameters-title">Parameters</h4>
420<ul class="tsd-parameter-list">
421<li>
8d1797ad 422<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>
6c525543 423<div class="tsd-comment tsd-typography"><p>Function that will be executed.</p>
15d6dfaf 424</div>
425<div class="tsd-comment tsd-typography"></div></li>
6c525543 426<li>
030eb5a3 427<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>
6c525543 428<div class="tsd-comment tsd-typography"><p>Input data for the given function.</p>
15d6dfaf 429</div>
430<div class="tsd-comment tsd-typography"></div></li></ul></div>
431<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
432<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 433<ul>
a109e1c6 434<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L286">src/worker/abstract-worker.ts:286</a></li></ul></aside></li></ul></section>
3bd6a82e 435<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runInAsyncScope" class="tsd-anchor"></a>
15d6dfaf 436<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 437<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 438<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>
6c525543 439<li class="tsd-description">
440<div class="tsd-comment tsd-typography"><p>Call the provided function with the provided arguments in the execution context
441of the async resource. This will establish the context, trigger the AsyncHooks
442before callbacks, call the function, trigger the AsyncHooks after callbacks, and
443then restore the original execution context.</p>
6c525543 444</div>
fab6d3b5 445<section class="tsd-panel">
6c525543 446<h4>Type Parameters</h4>
fab6d3b5 447<ul class="tsd-type-parameter-list">
6c525543 448<li>
3bd6a82e 449<h4><span class="tsd-kind-type-parameter">This</span></h4></li>
6c525543 450<li>
3bd6a82e 451<h4><span class="tsd-kind-type-parameter">Result</span></h4></li></ul></section>
6c525543 452<div class="tsd-parameters">
453<h4 class="tsd-parameters-title">Parameters</h4>
454<ul class="tsd-parameter-list">
455<li>
3bd6a82e 456<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>
6c525543 457<div class="tsd-comment tsd-typography"><p>The function to call in the execution context of this async resource.</p>
458</div>
15d6dfaf 459<div class="tsd-comment tsd-typography"></div>
6c525543 460<ul class="tsd-parameters">
461<li class="tsd-parameter-signature">
3bd6a82e 462<ul class="tsd-signatures tsd-is-external">
463<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">Result</span></li>
6c525543 464<li class="tsd-description">
465<div class="tsd-parameters">
466<h4 class="tsd-parameters-title">Parameters</h4>
467<ul class="tsd-parameter-list">
468<li>
3bd6a82e 469<h5><span class="tsd-kind-parameter">this</span>: <span class="tsd-signature-type tsd-kind-type-parameter">This</span></h5></li>
6c525543 470<li>
3bd6a82e 471<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>
472<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Result</span></h4></li></ul></li></ul></li>
6c525543 473<li>
3bd6a82e 474<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type tsd-kind-type-parameter">This</span></h5>
6c525543 475<div class="tsd-comment tsd-typography"><p>The receiver to be used for the function call.</p>
15d6dfaf 476</div>
477<div class="tsd-comment tsd-typography"></div></li>
6c525543 478<li>
3bd6a82e 479<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
6c525543 480<div class="tsd-comment tsd-typography"><p>Optional arguments to pass to the function.</p>
15d6dfaf 481</div>
482<div class="tsd-comment tsd-typography"></div></li></ul></div>
483<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Result</span></h4>
484<div class="tsd-comment tsd-typography">
485<h4>Since</h4><p>v9.6.0</p>
486</div><aside class="tsd-sources">
6c525543 487<p>Inherited from AsyncResource.runInAsyncScope</p>
488<ul>
47c9cec4 489<li>Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:294</li></ul></aside></li></ul></section>
2c94c3a5 490<section class="tsd-panel tsd-member tsd-is-protected"><a id="runSync" class="tsd-anchor"></a>
15d6dfaf 491<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 492<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 493<li class="tsd-signature tsd-anchor-link" id="runSync.runSync-1"><span class="tsd-kind-call-signature">run<wbr/>Sync</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#runSync.runSync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
2c94c3a5 494<li class="tsd-description">
495<div class="tsd-comment tsd-typography"><p>Runs the given function synchronously.</p>
496</div>
497<div class="tsd-parameters">
498<h4 class="tsd-parameters-title">Parameters</h4>
499<ul class="tsd-parameter-list">
500<li>
501<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>
502<div class="tsd-comment tsd-typography"><p>Function that will be executed.</p>
15d6dfaf 503</div>
504<div class="tsd-comment tsd-typography"></div></li>
2c94c3a5 505<li>
030eb5a3 506<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>
2c94c3a5 507<div class="tsd-comment tsd-typography"><p>Input data for the given function.</p>
15d6dfaf 508</div>
509<div class="tsd-comment tsd-typography"></div></li></ul></div>
510<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
511<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
2c94c3a5 512<ul>
a109e1c6 513<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L249">src/worker/abstract-worker.ts:249</a></li></ul></aside></li></ul></section>
3bd6a82e 514<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendToMainWorker" class="tsd-anchor"></a>
15d6dfaf 515<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagAbstract">Abstract</code> <span>send<wbr/>To<wbr/>Main<wbr/>Worker</span><a href="#sendToMainWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
3bd6a82e 516<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 517<li class="tsd-signature tsd-anchor-link" id="sendToMainWorker.sendToMainWorker-1"><span class="tsd-kind-call-signature">send<wbr/>To<wbr/>Main<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sendToMainWorker.sendToMainWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 518<li class="tsd-description">
519<div class="tsd-comment tsd-typography"><p>Sends a message to the main worker.</p>
520</div>
521<div class="tsd-parameters">
522<h4 class="tsd-parameters-title">Parameters</h4>
523<ul class="tsd-parameter-list">
524<li>
030eb5a3 525<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 tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span></h5>
6c525543 526<div class="tsd-comment tsd-typography"><p>The response message.</p>
15d6dfaf 527</div>
528<div class="tsd-comment tsd-typography"></div></li></ul></div>
529<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
530<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 531<ul>
a109e1c6 532<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L229">src/worker/abstract-worker.ts:229</a></li></ul></aside></li></ul></section>
b667be11 533<section class="tsd-panel tsd-member tsd-is-private"><a id="startCheckAlive" class="tsd-anchor"></a>
534<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>start<wbr/>Check<wbr/>Alive</span><a href="#startCheckAlive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
535<ul class="tsd-signatures tsd-is-private">
536<li class="tsd-signature tsd-anchor-link" id="startCheckAlive.startCheckAlive-1"><span class="tsd-kind-call-signature">start<wbr/>Check<wbr/>Alive</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#startCheckAlive.startCheckAlive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
537<li class="tsd-description">
a6b5c73c 538<div class="tsd-comment tsd-typography"><p>Starts the worker alive check interval.</p>
539</div>
540<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
541<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
542<ul>
a109e1c6 543<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L184">src/worker/abstract-worker.ts:184</a></li></ul></aside></li></ul></section>
a6b5c73c 544<section class="tsd-panel tsd-member tsd-is-private"><a id="stopCheckAlive" class="tsd-anchor"></a>
545<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>stop<wbr/>Check<wbr/>Alive</span><a href="#stopCheckAlive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
546<ul class="tsd-signatures tsd-is-private">
547<li class="tsd-signature tsd-anchor-link" id="stopCheckAlive.stopCheckAlive-1"><span class="tsd-kind-call-signature">stop<wbr/>Check<wbr/>Alive</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#stopCheckAlive.stopCheckAlive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
548<li class="tsd-description">
549<div class="tsd-comment tsd-typography"><p>Stops the worker alive check interval.</p>
550</div>
551<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
552<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
b667be11 553<ul>
a109e1c6 554<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L196">src/worker/abstract-worker.ts:196</a></li></ul></aside></li></ul></section>
3bd6a82e 555<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="triggerAsyncId" class="tsd-anchor"></a>
15d6dfaf 556<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 557<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 558<li class="tsd-signature tsd-anchor-link" id="triggerAsyncId.triggerAsyncId-1"><span class="tsd-kind-call-signature">trigger<wbr/>Async<wbr/>Id</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#triggerAsyncId.triggerAsyncId-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 559<li class="tsd-description">
fab6d3b5 560<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 561
562<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 563<p>Inherited from AsyncResource.triggerAsyncId</p>
564<ul>
47c9cec4 565<li>Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:311</li></ul></aside></li></ul></section>
c914a50e 566<section class="tsd-panel tsd-member tsd-is-protected"><a id="workerReady" class="tsd-anchor"></a>
567<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>worker<wbr/>Ready</span><a href="#workerReady" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
568<ul class="tsd-signatures tsd-is-protected">
569<li class="tsd-signature tsd-anchor-link" id="workerReady.workerReady-1"><span class="tsd-kind-call-signature">worker<wbr/>Ready</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#workerReady.workerReady-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
570<li class="tsd-description">
571<div class="tsd-comment tsd-typography"><p>Notifies the main worker that this worker is ready to process tasks.</p>
572</div>
573<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
574<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
575<ul>
a109e1c6 576<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/922a735/src/worker/abstract-worker.ts#L177">src/worker/abstract-worker.ts:177</a></li></ul></aside></li></ul></section>
3bd6a82e 577<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bind-2" class="tsd-anchor"></a>
15d6dfaf 578<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 579<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 580<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>
6c525543 581<li class="tsd-description">
582<div class="tsd-comment tsd-typography"><p>Binds the given function to the current execution context.</p>
6c525543 583</div>
fab6d3b5 584<section class="tsd-panel">
6c525543 585<h4>Type Parameters</h4>
fab6d3b5 586<ul class="tsd-type-parameter-list">
6c525543 587<li>
3bd6a82e 588<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>
6c525543 589<li>
3bd6a82e 590<h4><span class="tsd-kind-type-parameter">ThisArg</span></h4></li></ul></section>
6c525543 591<div class="tsd-parameters">
592<h4 class="tsd-parameters-title">Parameters</h4>
593<ul class="tsd-parameter-list">
594<li>
3bd6a82e 595<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h5>
6c525543 596<div class="tsd-comment tsd-typography"><p>The function to bind to the current execution context.</p>
15d6dfaf 597</div>
598<div class="tsd-comment tsd-typography"></div></li>
6c525543 599<li>
3bd6a82e 600<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></h5>
6c525543 601<div class="tsd-comment tsd-typography"><p>An optional name to associate with the underlying <code>AsyncResource</code>.</p>
15d6dfaf 602</div>
603<div class="tsd-comment tsd-typography"></div></li>
6c525543 604<li>
3bd6a82e 605<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 606<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h4>
607<div class="tsd-comment tsd-typography">
608<h4>Since</h4><p>v14.8.0, v12.19.0</p>
609</div><aside class="tsd-sources">
6c525543 610<p>Inherited from AsyncResource.bind</p>
611<ul>
47c9cec4 612<li>Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:277</li></ul></aside></li></ul></section></section></div>
6c525543 613<div class="col-sidebar">
614<div class="page-menu">
615<div class="tsd-navigation settings">
616<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
15d6dfaf 617<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
6c525543 618<div class="tsd-accordion-details">
619<div class="tsd-filter-visibility">
620<h4 class="uppercase">Member Visibility</h4><form>
621<ul id="tsd-filter-options">
622<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>
623<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>
624<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>
625<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>
626<div class="tsd-theme-toggle">
3bd6a82e 627<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
6c525543 628<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 629<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
6c525543 630<div class="tsd-accordion-details">
631<ul>
15d6dfaf 632<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>
633<li><a href="#aliveInterval" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>alive<wbr/>Interval</span></a></li>
202bcb6b 634<li><a href="#id" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>id</span></a></li>
15d6dfaf 635<li><a href="#isMain" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>is<wbr/>Main</span></a></li>
636<li><a href="#lastTaskTimestamp" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>last<wbr/>Task<wbr/>Timestamp</span></a></li>
637<li><a href="#mainWorker" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>main<wbr/>Worker</span></a></li>
638<li><a href="#opts" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>opts</span></a></li>
afa30fd0 639<li><a href="#statistics" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>statistics</span></a></li>
15d6dfaf 640<li><a href="#taskFunctions" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>task<wbr/>Functions</span></a></li>
641<li><a href="#asyncId" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>async<wbr/>Id</span></a></li>
afa30fd0 642<li><a href="#beginTaskPerformance" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>begin<wbr/>Task<wbr/>Performance</span></a></li>
15d6dfaf 643<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>
a6b5c73c 644<li><a href="#checkAlive" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Alive</span></a></li>
030eb5a3 645<li><a href="#checkStatistics" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Statistics</span></a></li>
15d6dfaf 646<li><a href="#checkTaskFunctions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Task<wbr/>Functions</span></a></li>
647<li><a href="#checkWorkerOptions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Worker<wbr/>Options</span></a></li>
648<li><a href="#emitDestroy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit<wbr/>Destroy</span></a></li>
afa30fd0 649<li><a href="#endTaskPerformance" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>end<wbr/>Task<wbr/>Performance</span></a></li>
15d6dfaf 650<li><a href="#getMainWorker" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Main<wbr/>Worker</span></a></li>
651<li><a href="#getTaskFunction" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Task<wbr/>Function</span></a></li>
652<li><a href="#handleError" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>Error</span></a></li>
653<li><a href="#messageListener" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>message<wbr/>Listener</span></a></li>
654<li><a href="#runAsync" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Async</span></a></li>
655<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>
656<li><a href="#runSync" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run<wbr/>Sync</span></a></li>
657<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>
b667be11 658<li><a href="#startCheckAlive" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>start<wbr/>Check<wbr/>Alive</span></a></li>
a6b5c73c 659<li><a href="#stopCheckAlive" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>stop<wbr/>Check<wbr/>Alive</span></a></li>
15d6dfaf 660<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>
c914a50e 661<li><a href="#workerReady" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>worker<wbr/>Ready</span></a></li>
15d6dfaf 662<li><a href="#bind-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>bind</span></a></li></ul></div></details></div>
6c525543 663<div class="site-menu">
f38f85c0 664<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.12</span></a>
6c525543 665<ul class="tsd-small-nested-navigation">
15d6dfaf 666<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>
667<li><a href="AbstractWorker.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Abstract<wbr/>Worker</span></a></li>
668<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>
669<li><a href="ClusterWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cluster<wbr/>Worker</span></a></li>
670<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>
671<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>
672<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>
673<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>
674<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>
675<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>
676<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>
677<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>
678<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 679<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 680<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>
681<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>
682<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 683<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 684<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>
685<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>
686<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 687<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>
688<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>
689<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>
690<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 691<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 692<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 693<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 694<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 695<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 696<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 697<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 698<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 699<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 700<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 701<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 702<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 703<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 704<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 705<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>
706<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 707<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 708<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>
709<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>
710<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>
711<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>
712<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 713<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>
714<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>
715<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>
716<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>
717<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>
718<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 719<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 720<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>
721<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>
722<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 723<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>
724<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>
6c525543 725<div class="tsd-generator">
726<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
727<div class="overlay"></div></body></html>