repositories / poolifier.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge branch 'master' of github.com:poolifier/poolifier
[poolifier.git] / docs / classes / AbstractWorker.html
CommitLineData
c065162c 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.18</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>
c065162c 9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.6.18</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>
c065162c 50<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L39">src/worker/abstract-worker.ts:39</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>
7b88db4b 62<div class="tsd-index-list"><a href="AbstractWorker.html#activeInterval" 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>active<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>
52f4e813 73<div class="tsd-index-list"><a href="AbstractWorker.html#addTaskFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>add<wbr/>Task<wbr/>Function</span></a>
74<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"><use href="#icon-2048"></use></svg><span>async<wbr/>Id</span></a>
afa30fd0 75<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 76<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>
7b88db4b 77<a href="AbstractWorker.html#checkActive" 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/>Active</span></a>
030eb5a3 78<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 79<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>
80<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>
81<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 82<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 83<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>
84<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>
85<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>
52f4e813 86<a href="AbstractWorker.html#hasTaskFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Task<wbr/>Function</span></a>
88499cf9 87<a href="AbstractWorker.html#listTaskFunctions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Task<wbr/>Functions</span></a>
15d6dfaf 88<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>
52f4e813 89<a href="AbstractWorker.html#removeTaskFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Task<wbr/>Function</span></a>
f33c2d55 90<a href="AbstractWorker.html#run" 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</span></a>
15d6dfaf 91<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>
92<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>
93<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>
7b88db4b 94<a href="AbstractWorker.html#sendReadyResponse" 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/>Ready<wbr/>Response</span></a>
15d6dfaf 95<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>
52f4e813 96<a href="AbstractWorker.html#setDefaultTaskFunction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Task<wbr/>Function</span></a>
7b88db4b 97<a href="AbstractWorker.html#startCheckActive" 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/>Active</span></a>
98<a href="AbstractWorker.html#stopCheckActive" 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/>Active</span></a>
15d6dfaf 99<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>
c065162c 100<a href="AbstractWorker.html#updateLastTaskTimestamp" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Last<wbr/>Task<wbr/>Timestamp</span></a>
15d6dfaf 101<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 102</div></section></div></details></section></section>
103<section class="tsd-panel-group tsd-member-group">
104<h2>Constructors</h2>
3bd6a82e 105<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
15d6dfaf 106<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 107<ul class="tsd-signatures">
15d6dfaf 108<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 109<li class="tsd-description">
110<div class="tsd-comment tsd-typography"><p>Constructs a new poolifier worker.</p>
111</div>
fab6d3b5 112<section class="tsd-panel">
6c525543 113<h4>Type Parameters</h4>
fab6d3b5 114<ul class="tsd-type-parameter-list">
6c525543 115<li>
3bd6a82e 116<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 117<li>
3bd6a82e 118<h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4></li>
6c525543 119<li>
3bd6a82e 120<h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section>
6c525543 121<div class="tsd-parameters">
122<h4 class="tsd-parameters-title">Parameters</h4>
123<ul class="tsd-parameter-list">
124<li>
3bd6a82e 125<h5><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></h5>
6c525543 126<div class="tsd-comment tsd-typography"><p>The type of async event.</p>
15d6dfaf 127</div>
128<div class="tsd-comment tsd-typography"></div></li>
6c525543 129<li>
3bd6a82e 130<h5><span class="tsd-kind-parameter">isMain</span>: <span class="tsd-signature-type">boolean</span></h5>
6c525543 131<div class="tsd-comment tsd-typography"><p>Whether this is the main worker or not.</p>
15d6dfaf 132</div>
133<div class="tsd-comment tsd-typography"></div></li>
6c525543 134<li>
2c94c3a5 135<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>
136<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 137</div>
138<div class="tsd-comment tsd-typography"></div></li>
6c525543 139<li>
030eb5a3 140<h5><span class="tsd-kind-parameter">mainWorker</span>: <span class="tsd-signature-type tsd-kind-type-parameter">MainWorker</span></h5>
6c525543 141<div class="tsd-comment tsd-typography"><p>Reference to main worker.</p>
15d6dfaf 142</div>
143<div class="tsd-comment tsd-typography"></div></li>
6c525543 144<li>
8d1797ad 145<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 146<div class="tsd-comment tsd-typography"><p>Options for the worker.</p>
15d6dfaf 147</div>
148<div class="tsd-comment tsd-typography"></div></li></ul></div>
149<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>
150<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 151<p>Overrides AsyncResource.constructor</p>
152<ul>
c065162c 153<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L73">src/worker/abstract-worker.ts:73</a></li></ul></aside></li></ul></section></section>
6c525543 154<section class="tsd-panel-group tsd-member-group">
155<h2>Properties</h2>
7b88db4b 156<section class="tsd-panel tsd-member tsd-is-protected"><a id="activeInterval" class="tsd-anchor"></a>
157<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>active<wbr/>Interval</span><a href="#activeInterval" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
158<div class="tsd-signature"><span class="tsd-kind-property">active<wbr/>Interval</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Timeout</span></div>
159<div class="tsd-comment tsd-typography"><p>Handler id of the <code>activeInterval</code> worker activity check.</p>
15d6dfaf 160</div>
161<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 162<ul>
c065162c 163<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L63">src/worker/abstract-worker.ts:63</a></li></ul></aside></section>
202bcb6b 164<section class="tsd-panel tsd-member tsd-is-protected"><a id="id" class="tsd-anchor"></a>
165<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>
166<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>
167<div class="tsd-comment tsd-typography"><p>Worker id.</p>
168</div>
169<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
170<ul>
c065162c 171<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L47">src/worker/abstract-worker.ts:47</a></li></ul></aside></section>
3bd6a82e 172<section class="tsd-panel tsd-member tsd-is-protected"><a id="isMain" class="tsd-anchor"></a>
15d6dfaf 173<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 174<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 175<div class="tsd-comment tsd-typography"><p>Whether this is the main worker or not.</p>
15d6dfaf 176</div>
177<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 178<ul>
c065162c 179<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L75">src/worker/abstract-worker.ts:75</a></li></ul></aside></section>
3bd6a82e 180<section class="tsd-panel tsd-member tsd-is-protected"><a id="lastTaskTimestamp" class="tsd-anchor"></a>
15d6dfaf 181<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 182<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 183<div class="tsd-comment tsd-typography"><p>Timestamp of the last task processed by this worker.</p>
15d6dfaf 184</div>
185<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 186<ul>
c065162c 187<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L55">src/worker/abstract-worker.ts:55</a></li></ul></aside></section>
3bd6a82e 188<section class="tsd-panel tsd-member tsd-is-protected"><a id="mainWorker" class="tsd-anchor"></a>
a6d9dccf 189<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 190<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 191<div class="tsd-comment tsd-typography"><p>Reference to main worker.</p>
15d6dfaf 192</div>
193<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 194<ul>
c065162c 195<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L79">src/worker/abstract-worker.ts:79</a></li></ul></aside></section>
3bd6a82e 196<section class="tsd-panel tsd-member tsd-is-protected"><a id="opts" class="tsd-anchor"></a>
15d6dfaf 197<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 198<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 199<div class="tsd-comment tsd-typography"><p>Options for the worker.</p>
15d6dfaf 200</div>
201<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 202<ul>
c065162c 203<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L80">src/worker/abstract-worker.ts:80</a></li></ul></aside></section>
afa30fd0 204<section class="tsd-panel tsd-member tsd-is-protected"><a id="statistics" class="tsd-anchor"></a>
205<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 206<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 207<div class="tsd-comment tsd-typography"><p>Performance statistics computation requirements.</p>
afa30fd0 208</div>
209<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
210<ul>
c065162c 211<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L59">src/worker/abstract-worker.ts:59</a></li></ul></aside></section>
2c94c3a5 212<section class="tsd-panel tsd-member tsd-is-protected"><a id="taskFunctions" class="tsd-anchor"></a>
15d6dfaf 213<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 214<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>
215<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 216</div>
217<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
2c94c3a5 218<ul>
c065162c 219<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L51">src/worker/abstract-worker.ts:51</a></li></ul></aside></section></section>
6c525543 220<section class="tsd-panel-group tsd-member-group">
221<h2>Methods</h2>
52f4e813 222<section class="tsd-panel tsd-member"><a id="addTaskFunction" class="tsd-anchor"></a>
223<h3 class="tsd-anchor-link"><span>add<wbr/>Task<wbr/>Function</span><a href="#addTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
224<ul class="tsd-signatures">
225<li class="tsd-signature tsd-anchor-link" id="addTaskFunction.addTaskFunction-1"><span class="tsd-kind-call-signature">add<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#addTaskFunction.addTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
226<li class="tsd-description">
227<div class="tsd-comment tsd-typography"><p>Adds a task function to the worker.
228If a task function with the same name already exists, it is replaced.</p>
229</div>
230<div class="tsd-parameters">
231<h4 class="tsd-parameters-title">Parameters</h4>
232<ul class="tsd-parameter-list">
233<li>
234<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
235<div class="tsd-comment tsd-typography"><p>The name of the task function to add.</p>
236</div>
237<div class="tsd-comment tsd-typography"></div></li>
238<li>
239<h5><span class="tsd-kind-parameter">fn</span>: <a href="../types/WorkerFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span></h5>
240<div class="tsd-comment tsd-typography"><p>The task function to add.</p>
241</div>
242<div class="tsd-comment tsd-typography"></div></li></ul></div>
243<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the task function was added or not.</p>
244
245<div class="tsd-comment tsd-typography">
246<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror</a> If the <code>name</code> parameter is not a string.</p>
247
248<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the <code>name</code> parameter is the default task function reserved name.</p>
249
250<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror</a> If the <code>fn</code> parameter is not a function.</p>
251</div><aside class="tsd-sources">
252<ul>
c065162c 253<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L186">src/worker/abstract-worker.ts:186</a></li></ul></aside></li></ul></section>
3bd6a82e 254<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="asyncId" class="tsd-anchor"></a>
15d6dfaf 255<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 256<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 257<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 258<li class="tsd-description">
fab6d3b5 259<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 260
261<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 262<p>Inherited from AsyncResource.asyncId</p>
263<ul>
177be4a6 264<li>Defined in node_modules/.pnpm/@types+node@20.4.2/node_modules/@types/node/async_hooks.d.ts:306</li></ul></aside></li></ul></section>
afa30fd0 265<section class="tsd-panel tsd-member tsd-is-private"><a id="beginTaskPerformance" class="tsd-anchor"></a>
266<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>
267<ul class="tsd-signatures tsd-is-private">
52f4e813 268<li class="tsd-signature tsd-anchor-link" id="beginTaskPerformance.beginTaskPerformance-1"><span class="tsd-kind-call-signature">begin<wbr/>Task<wbr/>Performance</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</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 269<li class="tsd-description">
52f4e813 270<div class="tsd-parameters">
271<h4 class="tsd-parameters-title">Parameters</h4>
272<ul class="tsd-parameter-list">
273<li>
274<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
71056a0a 275<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 276<ul>
c065162c 277<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L497">src/worker/abstract-worker.ts:497</a></li></ul></aside></li></ul></section>
3bd6a82e 278<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bind" class="tsd-anchor"></a>
15d6dfaf 279<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 280<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 281<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 282<li class="tsd-description">
283<div class="tsd-comment tsd-typography"><p>Binds the given function to execute to this <code>AsyncResource</code>&#39;s scope.</p>
6c525543 284</div>
fab6d3b5 285<section class="tsd-panel">
6c525543 286<h4>Type Parameters</h4>
fab6d3b5 287<ul class="tsd-type-parameter-list">
6c525543 288<li>
3bd6a82e 289<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 290<div class="tsd-parameters">
291<h4 class="tsd-parameters-title">Parameters</h4>
292<ul class="tsd-parameter-list">
293<li>
3bd6a82e 294<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h5>
6c525543 295<div class="tsd-comment tsd-typography"><p>The function to bind to the current <code>AsyncResource</code>.</p>
15d6dfaf 296</div>
297<div class="tsd-comment tsd-typography"></div></li></ul></div>
298<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h4>
299<div class="tsd-comment tsd-typography">
300<h4>Since</h4><p>v14.8.0, v12.19.0</p>
301</div><aside class="tsd-sources">
6c525543 302<p>Inherited from AsyncResource.bind</p>
303<ul>
177be4a6 304<li>Defined in node_modules/.pnpm/@types+node@20.4.2/node_modules/@types/node/async_hooks.d.ts:283</li></ul></aside></li></ul></section>
7b88db4b 305<section class="tsd-panel tsd-member tsd-is-private"><a id="checkActive" class="tsd-anchor"></a>
306<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Active</span><a href="#checkActive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
a6b5c73c 307<ul class="tsd-signatures tsd-is-private">
7b88db4b 308<li class="tsd-signature tsd-anchor-link" id="checkActive.checkActive-1"><span class="tsd-kind-call-signature">check<wbr/>Active</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="#checkActive.checkActive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 309<li class="tsd-description">
310<div class="tsd-comment tsd-typography"><p>Checks if the worker should be terminated, because its living too long.</p>
311</div>
15d6dfaf 312<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
313<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 314<ul>
c065162c 315<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L347">src/worker/abstract-worker.ts:347</a></li></ul></aside></li></ul></section>
030eb5a3 316<section class="tsd-panel tsd-member tsd-is-private"><a id="checkStatistics" class="tsd-anchor"></a>
317<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>
318<ul class="tsd-signatures tsd-is-private">
319<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>
320<li class="tsd-description">
321<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
322<ul>
c065162c 323<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L521">src/worker/abstract-worker.ts:521</a></li></ul></aside></li></ul></section>
2c94c3a5 324<section class="tsd-panel tsd-member tsd-is-private"><a id="checkTaskFunctions" class="tsd-anchor"></a>
15d6dfaf 325<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 326<ul class="tsd-signatures tsd-is-private">
15d6dfaf 327<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 328<li class="tsd-description">
2c94c3a5 329<div class="tsd-comment tsd-typography"><p>Checks if the <code>taskFunctions</code> parameter is passed to the constructor.</p>
6c525543 330</div>
331<div class="tsd-parameters">
332<h4 class="tsd-parameters-title">Parameters</h4>
333<ul class="tsd-parameter-list">
334<li>
2c94c3a5 335<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>
336<div class="tsd-comment tsd-typography"><p>The task function(s) parameter that should be checked.</p>
15d6dfaf 337</div>
338<div class="tsd-comment tsd-typography"></div></li></ul></div>
339<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
340<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 341<ul>
c065162c 342<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L112">src/worker/abstract-worker.ts:112</a></li></ul></aside></li></ul></section>
3bd6a82e 343<section class="tsd-panel tsd-member tsd-is-private"><a id="checkWorkerOptions" class="tsd-anchor"></a>
15d6dfaf 344<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 345<ul class="tsd-signatures tsd-is-private">
15d6dfaf 346<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 347<li class="tsd-description">
348<div class="tsd-parameters">
349<h4 class="tsd-parameters-title">Parameters</h4>
350<ul class="tsd-parameter-list">
351<li>
8d1797ad 352<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 353<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
354<ul>
c065162c 355<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L100">src/worker/abstract-worker.ts:100</a></li></ul></aside></li></ul></section>
3bd6a82e 356<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="emitDestroy" class="tsd-anchor"></a>
15d6dfaf 357<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 358<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 359<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 360<li class="tsd-description">
361<div class="tsd-comment tsd-typography"><p>Call all <code>destroy</code> hooks. This should only ever be called once. An error will
362be thrown if it is called more than once. This <strong>must</strong> be manually called. If
363the resource is left to be collected by the GC then the <code>destroy</code> hooks will
364never be called.</p>
6c525543 365</div>
fab6d3b5 366<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 367
368<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 369<p>Inherited from AsyncResource.emitDestroy</p>
370<ul>
177be4a6 371<li>Defined in node_modules/.pnpm/@types+node@20.4.2/node_modules/@types/node/async_hooks.d.ts:302</li></ul></aside></li></ul></section>
afa30fd0 372<section class="tsd-panel tsd-member tsd-is-private"><a id="endTaskPerformance" class="tsd-anchor"></a>
373<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>
374<ul class="tsd-signatures tsd-is-private">
71056a0a 375<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 376<li class="tsd-description">
377<div class="tsd-parameters">
378<h4 class="tsd-parameters-title">Parameters</h4>
379<ul class="tsd-parameter-list">
380<li>
71056a0a 381<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>
382<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 383<ul>
c065162c 384<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L506">src/worker/abstract-worker.ts:506</a></li></ul></aside></li></ul></section>
3bd6a82e 385<section class="tsd-panel tsd-member tsd-is-protected"><a id="getMainWorker" class="tsd-anchor"></a>
15d6dfaf 386<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 387<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 388<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 389<li class="tsd-description">
390<div class="tsd-comment tsd-typography"><p>Returns the main worker.</p>
6c525543 391</div>
fab6d3b5 392<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 393
394<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 395<ul>
c065162c 396<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L361">src/worker/abstract-worker.ts:361</a></li></ul></aside></li></ul></section>
2c94c3a5 397<section class="tsd-panel tsd-member tsd-is-private"><a id="getTaskFunction" class="tsd-anchor"></a>
15d6dfaf 398<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 399<ul class="tsd-signatures tsd-is-private">
15d6dfaf 400<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 401<li class="tsd-description">
f33c2d55 402<div class="tsd-comment tsd-typography"><p>Gets the task function with the given name.</p>
2c94c3a5 403</div>
404<div class="tsd-parameters">
405<h4 class="tsd-parameters-title">Parameters</h4>
406<ul class="tsd-parameter-list">
407<li>
408<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
52f4e813 409<div class="tsd-comment tsd-typography"><p>Name of the task function that will be returned.</p>
15d6dfaf 410</div>
411<div class="tsd-comment tsd-typography"></div></li></ul></div>
f33c2d55 412<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><p>The task function.</p>
413
414<div class="tsd-comment tsd-typography">
415<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the task function is not found.</p>
416</div><aside class="tsd-sources">
2c94c3a5 417<ul>
c065162c 418<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L488">src/worker/abstract-worker.ts:488</a></li></ul></aside></li></ul></section>
3bd6a82e 419<section class="tsd-panel tsd-member tsd-is-protected"><a id="handleError" class="tsd-anchor"></a>
15d6dfaf 420<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 421<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 422<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 423<li class="tsd-description">
424<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 425</div>
426<div class="tsd-parameters">
427<h4 class="tsd-parameters-title">Parameters</h4>
428<ul class="tsd-parameter-list">
429<li>
3bd6a82e 430<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 431<div class="tsd-comment tsd-typography"><p>The error raised by the worker.</p>
15d6dfaf 432</div>
433<div class="tsd-comment tsd-typography"></div></li></ul></div>
6d6c7ed0 434<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The error message.</p>
15d6dfaf 435
436<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 437<ul>
c065162c 438<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L383">src/worker/abstract-worker.ts:383</a></li></ul></aside></li></ul></section>
52f4e813 439<section class="tsd-panel tsd-member"><a id="hasTaskFunction" class="tsd-anchor"></a>
440<h3 class="tsd-anchor-link"><span>has<wbr/>Task<wbr/>Function</span><a href="#hasTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
441<ul class="tsd-signatures">
442<li class="tsd-signature tsd-anchor-link" id="hasTaskFunction.hasTaskFunction-1"><span class="tsd-kind-call-signature">has<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasTaskFunction.hasTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
443<li class="tsd-description">
444<div class="tsd-comment tsd-typography"><p>Checks if the worker has a task function with the given name.</p>
445</div>
446<div class="tsd-parameters">
447<h4 class="tsd-parameters-title">Parameters</h4>
448<ul class="tsd-parameter-list">
449<li>
450<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
451<div class="tsd-comment tsd-typography"><p>The name of the task function to check.</p>
452</div>
453<div class="tsd-comment tsd-typography"></div></li></ul></div>
454<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the worker has a task function with the given name or not.</p>
455
456<div class="tsd-comment tsd-typography">
457<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror</a> If the <code>name</code> parameter is not a string.</p>
458</div><aside class="tsd-sources">
459<ul>
c065162c 460<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L168">src/worker/abstract-worker.ts:168</a></li></ul></aside></li></ul></section>
88499cf9 461<section class="tsd-panel tsd-member"><a id="listTaskFunctions" class="tsd-anchor"></a>
462<h3 class="tsd-anchor-link"><span>list<wbr/>Task<wbr/>Functions</span><a href="#listTaskFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
463<ul class="tsd-signatures">
464<li class="tsd-signature tsd-anchor-link" id="listTaskFunctions.listTaskFunctions-1"><span class="tsd-kind-call-signature">list<wbr/>Task<wbr/>Functions</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#listTaskFunctions.listTaskFunctions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
465<li class="tsd-description">
466<div class="tsd-comment tsd-typography"><p>Lists the names of the worker&#39;s task functions.</p>
467</div>
468<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><p>The names of the worker&#39;s task functions.</p>
469
470<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
471<ul>
c065162c 472<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L249">src/worker/abstract-worker.ts:249</a></li></ul></aside></li></ul></section>
3bd6a82e 473<section class="tsd-panel tsd-member tsd-is-protected"><a id="messageListener" class="tsd-anchor"></a>
15d6dfaf 474<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 475<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 476<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 477<li class="tsd-description">
478<div class="tsd-comment tsd-typography"><p>Worker message listener.</p>
479</div>
480<div class="tsd-parameters">
481<h4 class="tsd-parameters-title">Parameters</h4>
482<ul class="tsd-parameter-list">
483<li>
030eb5a3 484<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>
7b88db4b 485<div class="tsd-comment tsd-typography"><p>The received message.</p>
15d6dfaf 486</div>
487<div class="tsd-comment tsd-typography"></div></li></ul></div>
488<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
489<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 490<ul>
c065162c 491<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L292">src/worker/abstract-worker.ts:292</a></li></ul></aside></li></ul></section>
52f4e813 492<section class="tsd-panel tsd-member"><a id="removeTaskFunction" class="tsd-anchor"></a>
493<h3 class="tsd-anchor-link"><span>remove<wbr/>Task<wbr/>Function</span><a href="#removeTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
494<ul class="tsd-signatures">
495<li class="tsd-signature tsd-anchor-link" id="removeTaskFunction.removeTaskFunction-1"><span class="tsd-kind-call-signature">remove<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#removeTaskFunction.removeTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
496<li class="tsd-description">
497<div class="tsd-comment tsd-typography"><p>Removes a task function from the worker.</p>
498</div>
499<div class="tsd-parameters">
500<h4 class="tsd-parameters-title">Parameters</h4>
501<ul class="tsd-parameter-list">
502<li>
503<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
504<div class="tsd-comment tsd-typography"><p>The name of the task function to remove.</p>
505</div>
506<div class="tsd-comment tsd-typography"></div></li></ul></div>
507<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the task function existed and was removed or not.</p>
508
509<div class="tsd-comment tsd-typography">
510<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror</a> If the <code>name</code> parameter is not a string.</p>
511
512<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the <code>name</code> parameter is the default task function reserved name.</p>
513
514<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the <code>name</code> parameter is the task function used as default task function.</p>
515</div><aside class="tsd-sources">
516<ul>
c065162c 517<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L225">src/worker/abstract-worker.ts:225</a></li></ul></aside></li></ul></section>
f33c2d55 518<section class="tsd-panel tsd-member tsd-is-protected"><a id="run" class="tsd-anchor"></a>
519<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>run</span><a href="#run" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
520<ul class="tsd-signatures tsd-is-protected">
521<li class="tsd-signature tsd-anchor-link" id="run.run-1"><span class="tsd-kind-call-signature">run</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#run.run-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
522<li class="tsd-description">
523<div class="tsd-comment tsd-typography"><p>Runs the given task.</p>
524</div>
525<div class="tsd-parameters">
526<h4 class="tsd-parameters-title">Parameters</h4>
527<ul class="tsd-parameter-list">
528<li>
529<h5><span class="tsd-kind-parameter">task</span>: <a href="../interfaces/Task.html" class="tsd-signature-type tsd-kind-interface">Task</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span></h5>
530<div class="tsd-comment tsd-typography"><p>The task to execute.</p>
531</div>
532<div class="tsd-comment tsd-typography"></div></li></ul></div>
533<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
534<div class="tsd-comment tsd-typography">
535<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the task function is not found.</p>
536</div><aside class="tsd-sources">
537<ul>
c065162c 538<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L393">src/worker/abstract-worker.ts:393</a></li></ul></aside></li></ul></section>
3bd6a82e 539<section class="tsd-panel tsd-member tsd-is-protected"><a id="runAsync" class="tsd-anchor"></a>
15d6dfaf 540<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 541<ul class="tsd-signatures tsd-is-protected">
f33c2d55 542<li class="tsd-signature tsd-anchor-link" id="runAsync.runAsync-1"><span class="tsd-kind-call-signature">run<wbr/>Async</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#runAsync.runAsync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
6c525543 543<li class="tsd-description">
08e40091 544<div class="tsd-comment tsd-typography"><p>Runs the given task function asynchronously.</p>
6c525543 545</div>
546<div class="tsd-parameters">
547<h4 class="tsd-parameters-title">Parameters</h4>
548<ul class="tsd-parameter-list">
549<li>
8d1797ad 550<h5><span class="tsd-kind-parameter">fn</span>: <a href="../types/WorkerAsyncFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerAsyncFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span></h5>
f33c2d55 551<div class="tsd-comment tsd-typography"><p>Task function that will be executed.</p>
15d6dfaf 552</div>
553<div class="tsd-comment tsd-typography"></div></li>
6c525543 554<li>
f33c2d55 555<h5><span class="tsd-kind-parameter">task</span>: <a href="../interfaces/Task.html" class="tsd-signature-type tsd-kind-interface">Task</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span></h5>
556<div class="tsd-comment tsd-typography"><p>Input data for the task function.</p>
15d6dfaf 557</div>
558<div class="tsd-comment tsd-typography"></div></li></ul></div>
559<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
560<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 561<ul>
c065162c 562<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L447">src/worker/abstract-worker.ts:447</a></li></ul></aside></li></ul></section>
3bd6a82e 563<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="runInAsyncScope" class="tsd-anchor"></a>
15d6dfaf 564<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 565<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 566<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 567<li class="tsd-description">
568<div class="tsd-comment tsd-typography"><p>Call the provided function with the provided arguments in the execution context
569of the async resource. This will establish the context, trigger the AsyncHooks
570before callbacks, call the function, trigger the AsyncHooks after callbacks, and
571then restore the original execution context.</p>
6c525543 572</div>
fab6d3b5 573<section class="tsd-panel">
6c525543 574<h4>Type Parameters</h4>
fab6d3b5 575<ul class="tsd-type-parameter-list">
6c525543 576<li>
3bd6a82e 577<h4><span class="tsd-kind-type-parameter">This</span></h4></li>
6c525543 578<li>
3bd6a82e 579<h4><span class="tsd-kind-type-parameter">Result</span></h4></li></ul></section>
6c525543 580<div class="tsd-parameters">
581<h4 class="tsd-parameters-title">Parameters</h4>
582<ul class="tsd-parameter-list">
583<li>
3bd6a82e 584<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 585<div class="tsd-comment tsd-typography"><p>The function to call in the execution context of this async resource.</p>
586</div>
15d6dfaf 587<div class="tsd-comment tsd-typography"></div>
6c525543 588<ul class="tsd-parameters">
589<li class="tsd-parameter-signature">
3bd6a82e 590<ul class="tsd-signatures tsd-is-external">
591<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 592<li class="tsd-description">
593<div class="tsd-parameters">
594<h4 class="tsd-parameters-title">Parameters</h4>
595<ul class="tsd-parameter-list">
596<li>
3bd6a82e 597<h5><span class="tsd-kind-parameter">this</span>: <span class="tsd-signature-type tsd-kind-type-parameter">This</span></h5></li>
6c525543 598<li>
3bd6a82e 599<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>
600<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Result</span></h4></li></ul></li></ul></li>
6c525543 601<li>
3bd6a82e 602<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 603<div class="tsd-comment tsd-typography"><p>The receiver to be used for the function call.</p>
15d6dfaf 604</div>
605<div class="tsd-comment tsd-typography"></div></li>
6c525543 606<li>
3bd6a82e 607<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 608<div class="tsd-comment tsd-typography"><p>Optional arguments to pass to the function.</p>
15d6dfaf 609</div>
610<div class="tsd-comment tsd-typography"></div></li></ul></div>
611<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Result</span></h4>
612<div class="tsd-comment tsd-typography">
613<h4>Since</h4><p>v9.6.0</p>
614</div><aside class="tsd-sources">
6c525543 615<p>Inherited from AsyncResource.runInAsyncScope</p>
616<ul>
177be4a6 617<li>Defined in node_modules/.pnpm/@types+node@20.4.2/node_modules/@types/node/async_hooks.d.ts:294</li></ul></aside></li></ul></section>
2c94c3a5 618<section class="tsd-panel tsd-member tsd-is-protected"><a id="runSync" class="tsd-anchor"></a>
15d6dfaf 619<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 620<ul class="tsd-signatures tsd-is-protected">
f33c2d55 621<li class="tsd-signature tsd-anchor-link" id="runSync.runSync-1"><span class="tsd-kind-call-signature">run<wbr/>Sync</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">task</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#runSync.runSync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
2c94c3a5 622<li class="tsd-description">
08e40091 623<div class="tsd-comment tsd-typography"><p>Runs the given task function synchronously.</p>
2c94c3a5 624</div>
625<div class="tsd-parameters">
626<h4 class="tsd-parameters-title">Parameters</h4>
627<ul class="tsd-parameter-list">
628<li>
629<h5><span class="tsd-kind-parameter">fn</span>: <a href="../types/WorkerSyncFunction.html" class="tsd-signature-type tsd-kind-type-alias">WorkerSyncFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">&gt;</span></h5>
f33c2d55 630<div class="tsd-comment tsd-typography"><p>Task function that will be executed.</p>
15d6dfaf 631</div>
632<div class="tsd-comment tsd-typography"></div></li>
2c94c3a5 633<li>
f33c2d55 634<h5><span class="tsd-kind-parameter">task</span>: <a href="../interfaces/Task.html" class="tsd-signature-type tsd-kind-interface">Task</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">&gt;</span></h5>
635<div class="tsd-comment tsd-typography"><p>Input data for the task function.</p>
15d6dfaf 636</div>
637<div class="tsd-comment tsd-typography"></div></li></ul></div>
638<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
639<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
2c94c3a5 640<ul>
c065162c 641<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L411">src/worker/abstract-worker.ts:411</a></li></ul></aside></li></ul></section>
7b88db4b 642<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendReadyResponse" class="tsd-anchor"></a>
643<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>send<wbr/>Ready<wbr/>Response</span><a href="#sendReadyResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
644<ul class="tsd-signatures tsd-is-protected">
645<li class="tsd-signature tsd-anchor-link" id="sendReadyResponse.sendReadyResponse-1"><span class="tsd-kind-call-signature">send<wbr/>Ready<wbr/>Response</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="#sendReadyResponse.sendReadyResponse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
646<li class="tsd-description">
44b95861 647<div class="tsd-comment tsd-typography"><p>Sends the ready response to the main worker.</p>
7b88db4b 648</div>
649<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
650<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
651<ul>
c065162c 652<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L319">src/worker/abstract-worker.ts:319</a></li></ul></aside></li></ul></section>
3bd6a82e 653<section class="tsd-panel tsd-member tsd-is-protected"><a id="sendToMainWorker" class="tsd-anchor"></a>
15d6dfaf 654<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 655<ul class="tsd-signatures tsd-is-protected">
15d6dfaf 656<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 657<li class="tsd-description">
658<div class="tsd-comment tsd-typography"><p>Sends a message to the main worker.</p>
659</div>
660<div class="tsd-parameters">
661<h4 class="tsd-parameters-title">Parameters</h4>
662<ul class="tsd-parameter-list">
663<li>
030eb5a3 664<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 665<div class="tsd-comment tsd-typography"><p>The response message.</p>
15d6dfaf 666</div>
667<div class="tsd-comment tsd-typography"></div></li></ul></div>
668<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
669<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 670<ul>
c065162c 671<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L373">src/worker/abstract-worker.ts:373</a></li></ul></aside></li></ul></section>
52f4e813 672<section class="tsd-panel tsd-member"><a id="setDefaultTaskFunction" class="tsd-anchor"></a>
673<h3 class="tsd-anchor-link"><span>set<wbr/>Default<wbr/>Task<wbr/>Function</span><a href="#setDefaultTaskFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
674<ul class="tsd-signatures">
675<li class="tsd-signature tsd-anchor-link" id="setDefaultTaskFunction.setDefaultTaskFunction-1"><span class="tsd-kind-call-signature">set<wbr/>Default<wbr/>Task<wbr/>Function</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#setDefaultTaskFunction.setDefaultTaskFunction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
676<li class="tsd-description">
88499cf9 677<div class="tsd-comment tsd-typography"><p>Sets the default task function to use in the worker.</p>
52f4e813 678</div>
679<div class="tsd-parameters">
680<h4 class="tsd-parameters-title">Parameters</h4>
681<ul class="tsd-parameter-list">
682<li>
683<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
684<div class="tsd-comment tsd-typography"><p>The name of the task function to use as default task function.</p>
685</div>
686<div class="tsd-comment tsd-typography"></div></li></ul></div>
687<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>Whether the default task function was set or not.</p>
688
689<div class="tsd-comment tsd-typography">
690<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-typeerror">https://nodejs.org/api/errors.html#class-typeerror</a> If the <code>name</code> parameter is not a string.</p>
691
692<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the <code>name</code> parameter is the default task function reserved name.</p>
693
694<h4>Throws</h4><p><a href="https://nodejs.org/api/errors.html#class-error">https://nodejs.org/api/errors.html#class-error</a> If the <code>name</code> parameter is a non-existing task function.</p>
695</div><aside class="tsd-sources">
696<ul>
c065162c 697<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L262">src/worker/abstract-worker.ts:262</a></li></ul></aside></li></ul></section>
7b88db4b 698<section class="tsd-panel tsd-member tsd-is-private"><a id="startCheckActive" class="tsd-anchor"></a>
699<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>start<wbr/>Check<wbr/>Active</span><a href="#startCheckActive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
b667be11 700<ul class="tsd-signatures tsd-is-private">
7b88db4b 701<li class="tsd-signature tsd-anchor-link" id="startCheckActive.startCheckActive-1"><span class="tsd-kind-call-signature">start<wbr/>Check<wbr/>Active</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="#startCheckActive.startCheckActive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
b667be11 702<li class="tsd-description">
7b88db4b 703<div class="tsd-comment tsd-typography"><p>Starts the worker check active interval.</p>
a6b5c73c 704</div>
705<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
706<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
707<ul>
c065162c 708<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L326">src/worker/abstract-worker.ts:326</a></li></ul></aside></li></ul></section>
7b88db4b 709<section class="tsd-panel tsd-member tsd-is-private"><a id="stopCheckActive" class="tsd-anchor"></a>
710<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>stop<wbr/>Check<wbr/>Active</span><a href="#stopCheckActive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
a6b5c73c 711<ul class="tsd-signatures tsd-is-private">
7b88db4b 712<li class="tsd-signature tsd-anchor-link" id="stopCheckActive.stopCheckActive-1"><span class="tsd-kind-call-signature">stop<wbr/>Check<wbr/>Active</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="#stopCheckActive.stopCheckActive-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
a6b5c73c 713<li class="tsd-description">
7b88db4b 714<div class="tsd-comment tsd-typography"><p>Stops the worker check active interval.</p>
a6b5c73c 715</div>
716<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
717<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
b667be11 718<ul>
c065162c 719<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L337">src/worker/abstract-worker.ts:337</a></li></ul></aside></li></ul></section>
3bd6a82e 720<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="triggerAsyncId" class="tsd-anchor"></a>
15d6dfaf 721<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 722<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 723<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 724<li class="tsd-description">
fab6d3b5 725<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 726
727<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
6c525543 728<p>Inherited from AsyncResource.triggerAsyncId</p>
729<ul>
177be4a6 730<li>Defined in node_modules/.pnpm/@types+node@20.4.2/node_modules/@types/node/async_hooks.d.ts:311</li></ul></aside></li></ul></section>
c065162c 731<section class="tsd-panel tsd-member tsd-is-private"><a id="updateLastTaskTimestamp" class="tsd-anchor"></a>
732<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>update<wbr/>Last<wbr/>Task<wbr/>Timestamp</span><a href="#updateLastTaskTimestamp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
733<ul class="tsd-signatures tsd-is-private">
734<li class="tsd-signature tsd-anchor-link" id="updateLastTaskTimestamp.updateLastTaskTimestamp-1"><span class="tsd-kind-call-signature">update<wbr/>Last<wbr/>Task<wbr/>Timestamp</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="#updateLastTaskTimestamp.updateLastTaskTimestamp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
735<li class="tsd-description">
736<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
737<ul>
738<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/8f4c949/src/worker/abstract-worker.ts#L527">src/worker/abstract-worker.ts:527</a></li></ul></aside></li></ul></section>
3bd6a82e 739<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="bind-2" class="tsd-anchor"></a>
15d6dfaf 740<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 741<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
15d6dfaf 742<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 743<li class="tsd-description">
744<div class="tsd-comment tsd-typography"><p>Binds the given function to the current execution context.</p>
6c525543 745</div>
fab6d3b5 746<section class="tsd-panel">
6c525543 747<h4>Type Parameters</h4>
fab6d3b5 748<ul class="tsd-type-parameter-list">
6c525543 749<li>
3bd6a82e 750<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 751<li>
3bd6a82e 752<h4><span class="tsd-kind-type-parameter">ThisArg</span></h4></li></ul></section>
6c525543 753<div class="tsd-parameters">
754<h4 class="tsd-parameters-title">Parameters</h4>
755<ul class="tsd-parameter-list">
756<li>
3bd6a82e 757<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h5>
6c525543 758<div class="tsd-comment tsd-typography"><p>The function to bind to the current execution context.</p>
15d6dfaf 759</div>
760<div class="tsd-comment tsd-typography"></div></li>
6c525543 761<li>
3bd6a82e 762<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 763<div class="tsd-comment tsd-typography"><p>An optional name to associate with the underlying <code>AsyncResource</code>.</p>
15d6dfaf 764</div>
765<div class="tsd-comment tsd-typography"></div></li>
6c525543 766<li>
3bd6a82e 767<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 768<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">Func</span></h4>
769<div class="tsd-comment tsd-typography">
770<h4>Since</h4><p>v14.8.0, v12.19.0</p>
771</div><aside class="tsd-sources">
6c525543 772<p>Inherited from AsyncResource.bind</p>
773<ul>
177be4a6 774<li>Defined in node_modules/.pnpm/@types+node@20.4.2/node_modules/@types/node/async_hooks.d.ts:277</li></ul></aside></li></ul></section></section></div>
6c525543 775<div class="col-sidebar">
776<div class="page-menu">
777<div class="tsd-navigation settings">
778<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
15d6dfaf 779<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 780<div class="tsd-accordion-details">
781<div class="tsd-filter-visibility">
782<h4 class="uppercase">Member Visibility</h4><form>
783<ul id="tsd-filter-options">
784<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>
785<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>
786<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>
787<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>
788<div class="tsd-theme-toggle">
3bd6a82e 789<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 790<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
15d6dfaf 791<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 792<div class="tsd-accordion-details">
793<ul>
15d6dfaf 794<li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
7b88db4b 795<li><a href="#activeInterval" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>active<wbr/>Interval</span></a></li>
202bcb6b 796<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 797<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>
798<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>
799<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>
800<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 801<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 802<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>
52f4e813 803<li><a href="#addTaskFunction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Task<wbr/>Function</span></a></li>
15d6dfaf 804<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 805<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 806<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>
7b88db4b 807<li><a href="#checkActive" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Active</span></a></li>
030eb5a3 808<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 809<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>
810<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>
811<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 812<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 813<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>
814<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>
815<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>
52f4e813 816<li><a href="#hasTaskFunction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Task<wbr/>Function</span></a></li>
88499cf9 817<li><a href="#listTaskFunctions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>list<wbr/>Task<wbr/>Functions</span></a></li>
15d6dfaf 818<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>
52f4e813 819<li><a href="#removeTaskFunction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Task<wbr/>Function</span></a></li>
f33c2d55 820<li><a href="#run" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>run</span></a></li>
15d6dfaf 821<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>
822<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>
823<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>
7b88db4b 824<li><a href="#sendReadyResponse" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Ready<wbr/>Response</span></a></li>
15d6dfaf 825<li><a href="#sendToMainWorker" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>To<wbr/>Main<wbr/>Worker</span></a></li>
52f4e813 826<li><a href="#setDefaultTaskFunction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Task<wbr/>Function</span></a></li>
7b88db4b 827<li><a href="#startCheckActive" 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/>Active</span></a></li>
828<li><a href="#stopCheckActive" 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/>Active</span></a></li>
15d6dfaf 829<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>
c065162c 830<li><a href="#updateLastTaskTimestamp" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Last<wbr/>Task<wbr/>Timestamp</span></a></li>
15d6dfaf 831<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 832<div class="site-menu">
c065162c 833<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.18</span></a>
6c525543 834<ul class="tsd-small-nested-navigation">
15d6dfaf 835<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>
836<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>
837<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>
838<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>
839<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>
840<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>
841<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>
842<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>
843<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>
844<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>
845<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>
846<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>
847<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 848<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 849<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>
850<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>
851<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 852<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 853<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>
854<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>
855<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 856<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>
857<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>
858<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>
859<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 860<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 861<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 862<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 863<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 864<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 865<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 866<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 867<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 868<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 869<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 870<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 871<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 872<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 873<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 874<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>
875<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 876<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 877<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>
878<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>
879<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>
880<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>
881<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 882<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>
883<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>
884<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>
885<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>
886<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>
887<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 888<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 889<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>
890<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>
891<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 892<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>
893<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 894<div class="tsd-generator">
895<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
896<div class="overlay"></div></body></html>
Fast and small Node.js thread pool implementation mirror - https://github.com/poolifier/poolifier