Merge branch 'master' of github.com:poolifier/poolifier
[poolifier.git] / docs / classes / CircularArray.html
CommitLineData
3bd6a82e 1<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CircularArray | poolifier</title><meta name="description" content="Documentation for poolifier"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
842d8918 2<div class="tsd-toolbar-contents container">
3<div class="table-cell" id="tsd-search" data-base="..">
4<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5<div class="field">
6<div id="tsd-toolbar-links"></div></div>
7<ul class="results">
8<li class="state loading">Preparing search index...</li>
9<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier</a></div>
10<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11<div class="container container-main">
12<div class="col-content">
13<div class="tsd-page-title">
14<ul class="tsd-breadcrumb">
15<li><a href="../index.html">poolifier</a></li>
16<li><a href="CircularArray.html">CircularArray</a></li></ul>
17<h1>Class CircularArray&lt;T&gt;</h1></div>
18<section class="tsd-panel tsd-comment">
19<div class="tsd-comment tsd-typography"><p>Array with a maximum length and shifting items when full.</p>
20</div></section>
fab6d3b5 21<section class="tsd-panel">
842d8918 22<h4>Type Parameters</h4>
fab6d3b5 23<ul class="tsd-type-parameter-list">
842d8918 24<li>
3bd6a82e 25<h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
842d8918 26<section class="tsd-panel tsd-hierarchy">
27<h4>Hierarchy</h4>
28<ul class="tsd-hierarchy">
3bd6a82e 29<li><span class="tsd-signature-type ">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span>
842d8918 30<ul class="tsd-hierarchy">
31<li><span class="target">CircularArray</span></li></ul></li></ul></section><aside class="tsd-sources">
32<ul>
ccb7d1a7 33<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/414339e/src/circular-array.ts#L8">src/circular-array.ts:8</a></li></ul></aside>
842d8918 34<section class="tsd-panel-group tsd-index-group">
35<section class="tsd-panel tsd-index-panel">
36<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
37<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>
38<div class="tsd-accordion-details">
39<section class="tsd-index-section">
40<h3 class="tsd-index-heading">Constructors</h3>
3bd6a82e 41<div class="tsd-index-list"><a href="CircularArray.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-512-path"></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)" id="icon-512-text"></path></svg><span>constructor</span></a>
842d8918 42</div></section>
43<section class="tsd-index-section">
44<h3 class="tsd-index-heading">Properties</h3>
3bd6a82e 45<div class="tsd-index-list"><a href="CircularArray.html#_unscopables_" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></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)" id="icon-1024-text"></path></svg><span>[unscopables]</span></a>
46<a href="CircularArray.html#length-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>length</span></a>
47<a href="CircularArray.html#size" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>size</span></a>
48<a href="CircularArray.html#_species_" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>[species]</span></a>
842d8918 49</div></section>
50<section class="tsd-index-section">
51<h3 class="tsd-index-heading">Methods</h3>
3bd6a82e 52<div class="tsd-index-list"><a href="CircularArray.html#_iterator_-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></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)" id="icon-2048-text"></path></svg><span>[iterator]</span></a>
53<a href="CircularArray.html#at-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>at</span></a>
54<a href="CircularArray.html#checkSize" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>check<wbr/>Size</span></a>
55<a href="CircularArray.html#concat-1" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>concat</span></a>
56<a href="CircularArray.html#copyWithin-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>copy<wbr/>Within</span></a>
57<a href="CircularArray.html#empty" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>empty</span></a>
58<a href="CircularArray.html#entries-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>entries</span></a>
59<a href="CircularArray.html#every-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>every</span></a>
60<a href="CircularArray.html#fill-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>fill</span></a>
61<a href="CircularArray.html#filter-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>filter</span></a>
62<a href="CircularArray.html#find-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>find</span></a>
63<a href="CircularArray.html#findIndex-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>find<wbr/>Index</span></a>
64<a href="CircularArray.html#flat-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>flat</span></a>
65<a href="CircularArray.html#flatMap-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>flat<wbr/>Map</span></a>
66<a href="CircularArray.html#forEach-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>for<wbr/>Each</span></a>
67<a href="CircularArray.html#full" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>full</span></a>
68<a href="CircularArray.html#includes-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>includes</span></a>
69<a href="CircularArray.html#indexOf-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>index<wbr/>Of</span></a>
70<a href="CircularArray.html#join-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>join</span></a>
71<a href="CircularArray.html#keys-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>keys</span></a>
72<a href="CircularArray.html#lastIndexOf-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>last<wbr/>Index<wbr/>Of</span></a>
73<a href="CircularArray.html#map-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>map</span></a>
74<a href="CircularArray.html#pop-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>pop</span></a>
75<a href="CircularArray.html#push-1" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>push</span></a>
76<a href="CircularArray.html#reduce-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>reduce</span></a>
77<a href="CircularArray.html#reduceRight-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>reduce<wbr/>Right</span></a>
78<a href="CircularArray.html#resize" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>resize</span></a>
79<a href="CircularArray.html#reverse-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>reverse</span></a>
80<a href="CircularArray.html#shift-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>shift</span></a>
81<a href="CircularArray.html#slice-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>slice</span></a>
82<a href="CircularArray.html#some-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>some</span></a>
83<a href="CircularArray.html#sort-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>sort</span></a>
84<a href="CircularArray.html#splice-1" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>splice</span></a>
85<a href="CircularArray.html#toLocaleString-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>to<wbr/>Locale<wbr/>String</span></a>
86<a href="CircularArray.html#toString-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>to<wbr/>String</span></a>
87<a href="CircularArray.html#unshift-1" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>unshift</span></a>
88<a href="CircularArray.html#values-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>values</span></a>
89<a href="CircularArray.html#from" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>from</span></a>
90<a href="CircularArray.html#isArray" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Array</span></a>
91<a href="CircularArray.html#of" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>of</span></a>
842d8918 92</div></section></div></details></section></section>
93<section class="tsd-panel-group tsd-member-group">
94<h2>Constructors</h2>
3bd6a82e 95<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
842d8918 96<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
3bd6a82e 97<ul class="tsd-signatures">
8d1797ad 98<li class="tsd-signature tsd-anchor-link" id="constructor.new_CircularArray"><span class="tsd-kind-constructor-signature">new <wbr/>Circular<wbr/>Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">size</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_CircularArray" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 99<li class="tsd-description">
fab6d3b5 100<section class="tsd-panel">
842d8918 101<h4>Type Parameters</h4>
fab6d3b5 102<ul class="tsd-type-parameter-list">
842d8918 103<li>
3bd6a82e 104<h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
842d8918 105<div class="tsd-parameters">
106<h4 class="tsd-parameters-title">Parameters</h4>
107<ul class="tsd-parameter-list">
108<li>
3bd6a82e 109<h5><span class="tsd-kind-parameter">size</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = DEFAULT_CIRCULAR_ARRAY_SIZE</span></h5></li>
842d8918 110<li>
3bd6a82e 111<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
8d1797ad 112<h4 class="tsd-returns-title">Returns <a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
842d8918 113<p>Overrides Array&lt;T&gt;.constructor</p>
114<ul>
ccb7d1a7 115<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/414339e/src/circular-array.ts#L11">src/circular-array.ts:11</a></li></ul></aside></li></ul></section></section>
842d8918 116<section class="tsd-panel-group tsd-member-group">
117<h2>Properties</h2>
3bd6a82e 118<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_unscopables_" class="tsd-anchor"></a>
842d8918 119<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>[unscopables]</span><a href="#_unscopables_" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
8d1797ad 120<div class="tsd-signature"><span class="tsd-kind-property">[unscopables]</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">[unscopables]</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">length</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">[iterator]</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">at</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">concat</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">copyWithin</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">entries</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">every</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">fill</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">filter</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">find</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">findIndex</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">flat</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">flatMap</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">forEach</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">includes</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">indexOf</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">join</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">keys</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">lastIndexOf</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">map</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">pop</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">push</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">reduce</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">reduceRight</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">reverse</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">shift</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">slice</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">some</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">sort</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">splice</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">toLocaleString</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">toString</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">unshift</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-method">values</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
842d8918 121<div class="tsd-comment tsd-typography"><p>Is an object whose properties have the value &#39;true&#39;
122when they will be absent when used in a &#39;with&#39; statement.</p>
123</div>
124<div class="tsd-type-declaration">
125<h4>Type declaration</h4>
126<ul class="tsd-parameters">
127<li class="tsd-parameter">
8d1797ad 128<h5><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">[unscopables]</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
842d8918 129<div class="tsd-comment tsd-typography"><p>Is an object whose properties have the value &#39;true&#39;
130when they will be absent when used in a &#39;with&#39; statement.</p>
131</div></li>
132<li class="tsd-parameter">
8d1797ad 133<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">length</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
842d8918 134<div class="tsd-comment tsd-typography"><p>Gets or sets the length of the array. This is a number one higher than the highest index in the array.</p>
135</div></li></ul></div><aside class="tsd-sources">
3bd6a82e 136<p>Inherited from Array.[unscopables]</p>
842d8918 137<ul>
70353024 138<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97</li></ul></aside></section>
3bd6a82e 139<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="length-1" class="tsd-anchor"></a>
842d8918 140<h3 class="tsd-anchor-link"><span>length</span><a href="#length-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
8d1797ad 141<div class="tsd-signature"><span class="tsd-kind-property">length</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
842d8918 142<div class="tsd-comment tsd-typography"><p>Gets or sets the length of the array. This is a number one higher than the highest index in the array.</p>
143</div><aside class="tsd-sources">
144<p>Inherited from Array.length</p>
145<ul>
70353024 146<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1318</li></ul></aside></section>
3bd6a82e 147<section class="tsd-panel tsd-member"><a id="size" class="tsd-anchor"></a>
842d8918 148<h3 class="tsd-anchor-link"><span>size</span><a href="#size" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
8d1797ad 149<div class="tsd-signature"><span class="tsd-kind-property">size</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
842d8918 150<ul>
ccb7d1a7 151<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/414339e/src/circular-array.ts#L9">src/circular-array.ts:9</a></li></ul></aside></section>
3bd6a82e 152<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_species_" class="tsd-anchor"></a>
842d8918 153<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>[species]</span><a href="#_species_" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
8d1797ad 154<div class="tsd-signature"><span class="tsd-kind-property">[species]</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">ArrayConstructor</span></div><aside class="tsd-sources">
3bd6a82e 155<p>Inherited from Array.[species]</p>
842d8918 156<ul>
70353024 157<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316</li></ul></aside></section></section>
842d8918 158<section class="tsd-panel-group tsd-member-group">
159<h2>Methods</h2>
3bd6a82e 160<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_iterator_-1" class="tsd-anchor"></a>
842d8918 161<h3 class="tsd-anchor-link"><span>[iterator]</span><a href="#_iterator_-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 162<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 163<li class="tsd-signature tsd-anchor-link" id="_iterator_-1._iterator_-2"><span class="tsd-kind-call-signature">[iterator]</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><a href="#_iterator_-1._iterator_-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 164<li class="tsd-description">
165<div class="tsd-comment tsd-typography"><p>Iterator</p>
166</div>
3bd6a82e 167<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
168<p>Inherited from Array.[iterator]</p>
842d8918 169<ul>
70353024 170<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:58</li></ul></aside></li></ul></section>
3bd6a82e 171<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="at-1" class="tsd-anchor"></a>
842d8918 172<h3 class="tsd-anchor-link"><span>at</span><a href="#at-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 173<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 174<li class="tsd-signature tsd-anchor-link" id="at-1.at-2"><span class="tsd-kind-call-signature">at</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><a href="#at-1.at-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 175<li class="tsd-description">
176<div class="tsd-comment tsd-typography"><p>Returns the item located at the specified index.</p>
177</div>
178<div class="tsd-parameters">
179<h4 class="tsd-parameters-title">Parameters</h4>
180<ul class="tsd-parameter-list">
181<li>
3bd6a82e 182<h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5>
842d8918 183<div class="tsd-comment tsd-typography"><p>The zero-based index of the desired code unit. A negative index will count back from the last item.</p>
184</div></li></ul></div>
3bd6a82e 185<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><aside class="tsd-sources">
842d8918 186<p>Inherited from Array.at</p>
187<ul>
70353024 188<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2022.array.d.ts:24</li></ul></aside></li></ul></section>
3bd6a82e 189<section class="tsd-panel tsd-member tsd-is-private"><a id="checkSize" class="tsd-anchor"></a>
842d8918 190<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>check<wbr/>Size</span><a href="#checkSize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 191<ul class="tsd-signatures tsd-is-private">
8d1797ad 192<li class="tsd-signature tsd-anchor-link" id="checkSize.checkSize-1"><span class="tsd-kind-call-signature">check<wbr/>Size</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">size</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#checkSize.checkSize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 193<li class="tsd-description">
194<div class="tsd-parameters">
195<h4 class="tsd-parameters-title">Parameters</h4>
196<ul class="tsd-parameter-list">
197<li>
3bd6a82e 198<h5><span class="tsd-kind-parameter">size</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
842d8918 199<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
200<ul>
ccb7d1a7 201<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/414339e/src/circular-array.ts#L88">src/circular-array.ts:88</a></li></ul></aside></li></ul></section>
3bd6a82e 202<section class="tsd-panel tsd-member"><a id="concat-1" class="tsd-anchor"></a>
842d8918 203<h3 class="tsd-anchor-link"><span>concat</span><a href="#concat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 204<ul class="tsd-signatures">
8d1797ad 205<li class="tsd-signature tsd-anchor-link" id="concat-1.concat-2"><span class="tsd-kind-call-signature">concat</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><a href="#concat-1.concat-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 206<li class="tsd-description">
fab6d3b5 207<div class="tsd-comment tsd-typography">
208<h3>Inherit Doc</h3></div>
842d8918 209<div class="tsd-parameters">
210<h4 class="tsd-parameters-title">Parameters</h4>
211<ul class="tsd-parameter-list">
212<li>
3bd6a82e 213<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">ConcatArray</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
8d1797ad 214<h4 class="tsd-returns-title">Returns <a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
842d8918 215<p>Overrides Array.concat</p>
216<ul>
ccb7d1a7 217<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/414339e/src/circular-array.ts#L39">src/circular-array.ts:39</a></li></ul></aside></li></ul></section>
3bd6a82e 218<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="copyWithin-1" class="tsd-anchor"></a>
842d8918 219<h3 class="tsd-anchor-link"><span>copy<wbr/>Within</span><a href="#copyWithin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 220<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
70353024 221<li class="tsd-signature tsd-anchor-link" id="copyWithin-1.copyWithin-2"><span class="tsd-kind-call-signature">copy<wbr/>Within</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span>, <span class="tsd-kind-parameter">start</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">end</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><a href="#copyWithin-1.copyWithin-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 222<li class="tsd-description">
223<div class="tsd-comment tsd-typography"><p>Returns the this object after copying a section of the array identified by start and end
224to the same array starting at position target</p>
225</div>
226<div class="tsd-parameters">
227<h4 class="tsd-parameters-title">Parameters</h4>
228<ul class="tsd-parameter-list">
229<li>
3bd6a82e 230<h5><span class="tsd-kind-parameter">target</span>: <span class="tsd-signature-type">number</span></h5>
842d8918 231<div class="tsd-comment tsd-typography"><p>If target is negative, it is treated as length+target where length is the
232length of the array.</p>
233</div></li>
234<li>
70353024 235<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">start</span>: <span class="tsd-signature-type">number</span></h5>
842d8918 236<div class="tsd-comment tsd-typography"><p>If start is negative, it is treated as length+start. If end is negative, it
70353024 237is treated as length+end. If start is omitted, <code>0</code> is used.</p>
842d8918 238</div></li>
239<li>
3bd6a82e 240<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">end</span>: <span class="tsd-signature-type">number</span></h5>
842d8918 241<div class="tsd-comment tsd-typography"><p>If not specified, length of the this object is used as its default value.</p>
242</div></li></ul></div>
8d1797ad 243<h4 class="tsd-returns-title">Returns <a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
842d8918 244<p>Inherited from Array.copyWithin</p>
245<ul>
70353024 246<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.core.d.ts:62</li></ul></aside></li></ul></section>
3bd6a82e 247<section class="tsd-panel tsd-member"><a id="empty" class="tsd-anchor"></a>
842d8918 248<h3 class="tsd-anchor-link"><span>empty</span><a href="#empty" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 249<ul class="tsd-signatures">
8d1797ad 250<li class="tsd-signature tsd-anchor-link" id="empty.empty-1"><span class="tsd-kind-call-signature">empty</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#empty.empty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 251<li class="tsd-description">
252<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
253<ul>
ccb7d1a7 254<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/414339e/src/circular-array.ts#L80">src/circular-array.ts:80</a></li></ul></aside></li></ul></section>
3bd6a82e 255<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entries-1" class="tsd-anchor"></a>
842d8918 256<h3 class="tsd-anchor-link"><span>entries</span><a href="#entries-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 257<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 258<li class="tsd-signature tsd-anchor-link" id="entries-1.entries-2"><span class="tsd-kind-call-signature">entries</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><a href="#entries-1.entries-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 259<li class="tsd-description">
260<div class="tsd-comment tsd-typography"><p>Returns an iterable of key, value pairs for every entry in the array</p>
261</div>
3bd6a82e 262<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
842d8918 263<p>Inherited from Array.entries</p>
264<ul>
70353024 265<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:63</li></ul></aside></li></ul></section>
3bd6a82e 266<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="every-1" class="tsd-anchor"></a>
842d8918 267<h3 class="tsd-anchor-link"><span>every</span><a href="#every-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 268<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
fab6d3b5 269<li class="tsd-signature tsd-anchor-link" id="every-1.every-2"><span class="tsd-kind-call-signature">every</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">predicate</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-kind-parameter">this</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">[]</span><a href="#every-1.every-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 270<li class="tsd-description">
271<div class="tsd-comment tsd-typography"><p>Determines whether all the members of an array satisfy the specified test.</p>
272</div>
fab6d3b5 273<section class="tsd-panel">
842d8918 274<h4>Type Parameters</h4>
fab6d3b5 275<ul class="tsd-type-parameter-list">
842d8918 276<li>
3bd6a82e 277<h4><span class="tsd-kind-type-parameter">S</span></h4></li></ul></section>
842d8918 278<div class="tsd-parameters">
279<h4 class="tsd-parameters-title">Parameters</h4>
280<ul class="tsd-parameter-list">
281<li>
fab6d3b5 282<h5><span class="tsd-kind-parameter">predicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 283<div class="tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The every method calls
284the predicate function for each element in the array until the predicate returns a value
285which is coercible to the Boolean value false, or until the end of the array.</p>
286</div>
287<ul class="tsd-parameters">
288<li class="tsd-parameter-signature">
3bd6a82e 289<ul class="tsd-signatures tsd-is-external">
fab6d3b5 290<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span></li>
842d8918 291<li class="tsd-description">
292<div class="tsd-parameters">
293<h4 class="tsd-parameters-title">Parameters</h4>
294<ul class="tsd-parameter-list">
295<li>
3bd6a82e 296<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 297<li>
3bd6a82e 298<h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 299<li>
3bd6a82e 300<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
fab6d3b5 301<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span></h4></li></ul></li></ul></li>
842d8918 302<li>
3bd6a82e 303<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5>
842d8918 304<div class="tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the predicate function.
305If thisArg is omitted, undefined is used as the this value.</p>
306</div></li></ul></div>
fab6d3b5 307<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 308<p>Inherited from Array.every</p>
309<ul>
70353024 310<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1425</li></ul></aside></li>
8d1797ad 311<li class="tsd-signature tsd-anchor-link" id="every-1.every-3"><span class="tsd-kind-call-signature">every</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">predicate</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">boolean</span><a href="#every-1.every-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 312<li class="tsd-description">
313<div class="tsd-comment tsd-typography"><p>Determines whether all the members of an array satisfy the specified test.</p>
314</div>
315<div class="tsd-parameters">
316<h4 class="tsd-parameters-title">Parameters</h4>
317<ul class="tsd-parameter-list">
318<li>
3bd6a82e 319<h5><span class="tsd-kind-parameter">predicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 320<div class="tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The every method calls
321the predicate function for each element in the array until the predicate returns a value
322which is coercible to the Boolean value false, or until the end of the array.</p>
323</div>
324<ul class="tsd-parameters">
325<li class="tsd-parameter-signature">
3bd6a82e 326<ul class="tsd-signatures tsd-is-external">
327<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></li>
842d8918 328<li class="tsd-description">
329<div class="tsd-parameters">
330<h4 class="tsd-parameters-title">Parameters</h4>
331<ul class="tsd-parameter-list">
332<li>
3bd6a82e 333<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 334<li>
3bd6a82e 335<h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 336<li>
3bd6a82e 337<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
842d8918 338<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></li></ul></li>
339<li>
3bd6a82e 340<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5>
842d8918 341<div class="tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the predicate function.
342If thisArg is omitted, undefined is used as the this value.</p>
343</div></li></ul></div>
344<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
345<p>Inherited from Array.every</p>
346<ul>
70353024 347<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1434</li></ul></aside></li></ul></section>
3bd6a82e 348<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fill-1" class="tsd-anchor"></a>
842d8918 349<h3 class="tsd-anchor-link"><span>fill</span><a href="#fill-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 350<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 351<li class="tsd-signature tsd-anchor-link" id="fill-1.fill-2"><span class="tsd-kind-call-signature">fill</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">start</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">end</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><a href="#fill-1.fill-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 352<li class="tsd-description">
353<div class="tsd-comment tsd-typography"><p>Changes all array elements from <code>start</code> to <code>end</code> index to a static <code>value</code> and returns the modified array</p>
354</div>
355<div class="tsd-parameters">
356<h4 class="tsd-parameters-title">Parameters</h4>
357<ul class="tsd-parameter-list">
358<li>
3bd6a82e 359<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5>
842d8918 360<div class="tsd-comment tsd-typography"><p>value to fill array section with</p>
361</div></li>
362<li>
3bd6a82e 363<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">start</span>: <span class="tsd-signature-type">number</span></h5>
842d8918 364<div class="tsd-comment tsd-typography"><p>index to start filling the array at. If start is negative, it is treated as
365length+start where length is the length of the array.</p>
366</div></li>
367<li>
3bd6a82e 368<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">end</span>: <span class="tsd-signature-type">number</span></h5>
842d8918 369<div class="tsd-comment tsd-typography"><p>index to stop filling the array at. If end is negative, it is treated as
370length+end.</p>
371</div></li></ul></div>
8d1797ad 372<h4 class="tsd-returns-title">Returns <a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
842d8918 373<p>Inherited from Array.fill</p>
374<ul>
70353024 375<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.core.d.ts:51</li></ul></aside></li></ul></section>
3bd6a82e 376<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="filter-1" class="tsd-anchor"></a>
842d8918 377<h3 class="tsd-anchor-link"><span>filter</span><a href="#filter-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 378<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 379<li class="tsd-signature tsd-anchor-link" id="filter-1.filter-2"><span class="tsd-kind-call-signature">filter</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">predicate</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">S</span><span class="tsd-signature-symbol">[]</span><a href="#filter-1.filter-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 380<li class="tsd-description">
381<div class="tsd-comment tsd-typography"><p>Returns the elements of an array that meet the condition specified in a callback function.</p>
382</div>
fab6d3b5 383<section class="tsd-panel">
842d8918 384<h4>Type Parameters</h4>
fab6d3b5 385<ul class="tsd-type-parameter-list">
842d8918 386<li>
3bd6a82e 387<h4><span class="tsd-kind-type-parameter">S</span></h4></li></ul></section>
842d8918 388<div class="tsd-parameters">
389<h4 class="tsd-parameters-title">Parameters</h4>
390<ul class="tsd-parameter-list">
391<li>
fab6d3b5 392<h5><span class="tsd-kind-parameter">predicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 393<div class="tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.</p>
394</div>
395<ul class="tsd-parameters">
396<li class="tsd-parameter-signature">
3bd6a82e 397<ul class="tsd-signatures tsd-is-external">
fab6d3b5 398<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span></li>
842d8918 399<li class="tsd-description">
400<div class="tsd-parameters">
401<h4 class="tsd-parameters-title">Parameters</h4>
402<ul class="tsd-parameter-list">
403<li>
3bd6a82e 404<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 405<li>
3bd6a82e 406<h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 407<li>
3bd6a82e 408<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
fab6d3b5 409<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span></h4></li></ul></li></ul></li>
842d8918 410<li>
3bd6a82e 411<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5>
842d8918 412<div class="tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.</p>
413</div></li></ul></div>
3bd6a82e 414<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 415<p>Inherited from Array.filter</p>
416<ul>
70353024 417<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1461</li></ul></aside></li>
8d1797ad 418<li class="tsd-signature tsd-anchor-link" id="filter-1.filter-3"><span class="tsd-kind-call-signature">filter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">predicate</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">T</span><span class="tsd-signature-symbol">[]</span><a href="#filter-1.filter-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 419<li class="tsd-description">
420<div class="tsd-comment tsd-typography"><p>Returns the elements of an array that meet the condition specified in a callback function.</p>
421</div>
422<div class="tsd-parameters">
423<h4 class="tsd-parameters-title">Parameters</h4>
424<ul class="tsd-parameter-list">
425<li>
3bd6a82e 426<h5><span class="tsd-kind-parameter">predicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 427<div class="tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.</p>
428</div>
429<ul class="tsd-parameters">
430<li class="tsd-parameter-signature">
3bd6a82e 431<ul class="tsd-signatures tsd-is-external">
432<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></li>
842d8918 433<li class="tsd-description">
434<div class="tsd-parameters">
435<h4 class="tsd-parameters-title">Parameters</h4>
436<ul class="tsd-parameter-list">
437<li>
3bd6a82e 438<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 439<li>
3bd6a82e 440<h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 441<li>
3bd6a82e 442<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
842d8918 443<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></li></ul></li>
444<li>
3bd6a82e 445<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5>
842d8918 446<div class="tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.</p>
447</div></li></ul></div>
3bd6a82e 448<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 449<p>Inherited from Array.filter</p>
450<ul>
70353024 451<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1467</li></ul></aside></li></ul></section>
3bd6a82e 452<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="find-1" class="tsd-anchor"></a>
842d8918 453<h3 class="tsd-anchor-link"><span>find</span><a href="#find-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 454<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 455<li class="tsd-signature tsd-anchor-link" id="find-1.find-2"><span class="tsd-kind-call-signature">find</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">predicate</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><a href="#find-1.find-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 456<li class="tsd-description">
457<div class="tsd-comment tsd-typography"><p>Returns the value of the first element in the array where predicate is true, and undefined
458otherwise.</p>
459</div>
fab6d3b5 460<section class="tsd-panel">
842d8918 461<h4>Type Parameters</h4>
fab6d3b5 462<ul class="tsd-type-parameter-list">
842d8918 463<li>
3bd6a82e 464<h4><span class="tsd-kind-type-parameter">S</span></h4></li></ul></section>
842d8918 465<div class="tsd-parameters">
466<h4 class="tsd-parameters-title">Parameters</h4>
467<ul class="tsd-parameter-list">
468<li>
fab6d3b5 469<h5><span class="tsd-kind-parameter">predicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 470<div class="tsd-comment tsd-typography"><p>find calls predicate once for each element of the array, in ascending
471order, until it finds one where predicate returns true. If such an element is found, find
472immediately returns that element value. Otherwise, find returns undefined.</p>
473</div>
474<ul class="tsd-parameters">
475<li class="tsd-parameter-signature">
3bd6a82e 476<ul class="tsd-signatures tsd-is-external">
fab6d3b5 477<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span></li>
842d8918 478<li class="tsd-description">
479<div class="tsd-parameters">
480<h4 class="tsd-parameters-title">Parameters</h4>
481<ul class="tsd-parameter-list">
482<li>
3bd6a82e 483<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 484<li>
3bd6a82e 485<h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 486<li>
3bd6a82e 487<h5><span class="tsd-kind-parameter">obj</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
fab6d3b5 488<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span></h4></li></ul></li></ul></li>
842d8918 489<li>
3bd6a82e 490<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5>
842d8918 491<div class="tsd-comment tsd-typography"><p>If provided, it will be used as the this value for each invocation of
492predicate. If it is not provided, undefined is used instead.</p>
493</div></li></ul></div>
3bd6a82e 494<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span></h4><aside class="tsd-sources">
842d8918 495<p>Inherited from Array.find</p>
496<ul>
70353024 497<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.core.d.ts:29</li></ul></aside></li>
8d1797ad 498<li class="tsd-signature tsd-anchor-link" id="find-1.find-3"><span class="tsd-kind-call-signature">find</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">predicate</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><a href="#find-1.find-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 499<li class="tsd-description">
500<div class="tsd-parameters">
501<h4 class="tsd-parameters-title">Parameters</h4>
502<ul class="tsd-parameter-list">
503<li>
3bd6a82e 504<h5><span class="tsd-kind-parameter">predicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 505<ul class="tsd-parameters">
506<li class="tsd-parameter-signature">
3bd6a82e 507<ul class="tsd-signatures tsd-is-external">
508<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></li>
842d8918 509<li class="tsd-description">
510<div class="tsd-parameters">
511<h4 class="tsd-parameters-title">Parameters</h4>
512<ul class="tsd-parameter-list">
513<li>
3bd6a82e 514<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 515<li>
3bd6a82e 516<h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 517<li>
3bd6a82e 518<h5><span class="tsd-kind-parameter">obj</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
842d8918 519<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></li></ul></li>
520<li>
3bd6a82e 521<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
522<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><aside class="tsd-sources">
842d8918 523<p>Inherited from Array.find</p>
524<ul>
70353024 525<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.core.d.ts:30</li></ul></aside></li></ul></section>
3bd6a82e 526<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="findIndex-1" class="tsd-anchor"></a>
842d8918 527<h3 class="tsd-anchor-link"><span>find<wbr/>Index</span><a href="#findIndex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 528<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 529<li class="tsd-signature tsd-anchor-link" id="findIndex-1.findIndex-2"><span class="tsd-kind-call-signature">find<wbr/>Index</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">predicate</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">number</span><a href="#findIndex-1.findIndex-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 530<li class="tsd-description">
531<div class="tsd-comment tsd-typography"><p>Returns the index of the first element in the array where predicate is true, and -1
532otherwise.</p>
533</div>
534<div class="tsd-parameters">
535<h4 class="tsd-parameters-title">Parameters</h4>
536<ul class="tsd-parameter-list">
537<li>
3bd6a82e 538<h5><span class="tsd-kind-parameter">predicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 539<div class="tsd-comment tsd-typography"><p>find calls predicate once for each element of the array, in ascending
540order, until it finds one where predicate returns true. If such an element is found,
541findIndex immediately returns that element index. Otherwise, findIndex returns -1.</p>
542</div>
543<ul class="tsd-parameters">
544<li class="tsd-parameter-signature">
3bd6a82e 545<ul class="tsd-signatures tsd-is-external">
546<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">obj</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></li>
842d8918 547<li class="tsd-description">
548<div class="tsd-parameters">
549<h4 class="tsd-parameters-title">Parameters</h4>
550<ul class="tsd-parameter-list">
551<li>
3bd6a82e 552<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 553<li>
3bd6a82e 554<h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 555<li>
3bd6a82e 556<h5><span class="tsd-kind-parameter">obj</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
842d8918 557<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></li></ul></li>
558<li>
3bd6a82e 559<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5>
842d8918 560<div class="tsd-comment tsd-typography"><p>If provided, it will be used as the this value for each invocation of
561predicate. If it is not provided, undefined is used instead.</p>
562</div></li></ul></div>
563<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
564<p>Inherited from Array.findIndex</p>
565<ul>
70353024 566<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.core.d.ts:41</li></ul></aside></li></ul></section>
3bd6a82e 567<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="flat-1" class="tsd-anchor"></a>
842d8918 568<h3 class="tsd-anchor-link"><span>flat</span><a href="#flat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 569<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 570<li class="tsd-signature tsd-anchor-link" id="flat-1.flat-2"><span class="tsd-kind-call-signature">flat</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">A</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">depth</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">FlatArray</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">A</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><a href="#flat-1.flat-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 571<li class="tsd-description">
572<div class="tsd-comment tsd-typography"><p>Returns a new array with all sub-array elements concatenated into it recursively up to the
573specified depth.</p>
574</div>
fab6d3b5 575<section class="tsd-panel">
842d8918 576<h4>Type Parameters</h4>
fab6d3b5 577<ul class="tsd-type-parameter-list">
842d8918 578<li>
3bd6a82e 579<h4><span class="tsd-kind-type-parameter">A</span></h4></li>
842d8918 580<li>
3bd6a82e 581<h4><span class="tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">number</span> = <span class="tsd-signature-type">1</span></h4></li></ul></section>
842d8918 582<div class="tsd-parameters">
583<h4 class="tsd-parameters-title">Parameters</h4>
584<ul class="tsd-parameter-list">
585<li>
3bd6a82e 586<h5><span class="tsd-kind-parameter">this</span>: <span class="tsd-signature-type tsd-kind-type-parameter">A</span></h5></li>
842d8918 587<li>
3bd6a82e 588<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">depth</span>: <span class="tsd-signature-type tsd-kind-type-parameter">D</span></h5>
842d8918 589<div class="tsd-comment tsd-typography"><p>The maximum recursion depth</p>
590</div></li></ul></div>
3bd6a82e 591<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">FlatArray</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">A</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">D</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 592<p>Inherited from Array.flat</p>
593<ul>
70353024 594<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2019.array.d.ts:79</li></ul></aside></li></ul></section>
3bd6a82e 595<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="flatMap-1" class="tsd-anchor"></a>
842d8918 596<h3 class="tsd-anchor-link"><span>flat<wbr/>Map</span><a href="#flatMap-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 597<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 598<li class="tsd-signature tsd-anchor-link" id="flatMap-1.flatMap-2"><span class="tsd-kind-call-signature">flat<wbr/>Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">This</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</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">U</span><span class="tsd-signature-symbol">[]</span><a href="#flatMap-1.flatMap-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 599<li class="tsd-description">
600<div class="tsd-comment tsd-typography"><p>Calls a defined callback function on each element of an array. Then, flattens the result into
601a new array.
602This is identical to a map followed by flat with depth 1.</p>
603</div>
fab6d3b5 604<section class="tsd-panel">
842d8918 605<h4>Type Parameters</h4>
fab6d3b5 606<ul class="tsd-type-parameter-list">
842d8918 607<li>
3bd6a82e 608<h4><span class="tsd-kind-type-parameter">U</span></h4></li>
842d8918 609<li>
3bd6a82e 610<h4><span class="tsd-kind-type-parameter">This</span> = <span class="tsd-signature-type">undefined</span></h4></li></ul></section>
842d8918 611<div class="tsd-parameters">
612<h4 class="tsd-parameters-title">Parameters</h4>
613<ul class="tsd-parameter-list">
614<li>
3bd6a82e 615<h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 616<div class="tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The flatMap method calls the
617callback function one time for each element in the array.</p>
618</div>
619<ul class="tsd-parameters">
620<li class="tsd-parameter-signature">
3bd6a82e 621<ul class="tsd-signatures tsd-is-external">
622<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span>, <span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span></li>
842d8918 623<li class="tsd-description">
624<div class="tsd-parameters">
625<h4 class="tsd-parameters-title">Parameters</h4>
626<ul class="tsd-parameter-list">
627<li>
3bd6a82e 628<h5><span class="tsd-kind-parameter">this</span>: <span class="tsd-signature-type tsd-kind-type-parameter">This</span></h5></li>
842d8918 629<li>
3bd6a82e 630<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 631<li>
3bd6a82e 632<h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 633<li>
3bd6a82e 634<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
635<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></li></ul></li>
842d8918 636<li>
3bd6a82e 637<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>
842d8918 638<div class="tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the callback function. If
639thisArg is omitted, undefined is used as the this value.</p>
640</div></li></ul></div>
3bd6a82e 641<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 642<p>Inherited from Array.flatMap</p>
643<ul>
70353024 644<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2019.array.d.ts:68</li></ul></aside></li></ul></section>
3bd6a82e 645<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="forEach-1" class="tsd-anchor"></a>
842d8918 646<h3 class="tsd-anchor-link"><span>for<wbr/>Each</span><a href="#forEach-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 647<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 648<li class="tsd-signature tsd-anchor-link" id="forEach-1.forEach-2"><span class="tsd-kind-call-signature">for<wbr/>Each</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callbackfn</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">void</span><a href="#forEach-1.forEach-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 649<li class="tsd-description">
650<div class="tsd-comment tsd-typography"><p>Performs the specified action for each element in an array.</p>
651</div>
652<div class="tsd-parameters">
653<h4 class="tsd-parameters-title">Parameters</h4>
654<ul class="tsd-parameter-list">
655<li>
3bd6a82e 656<h5><span class="tsd-kind-parameter">callbackfn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 657<div class="tsd-comment tsd-typography"><p>A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.</p>
658</div>
659<ul class="tsd-parameters">
660<li class="tsd-parameter-signature">
3bd6a82e 661<ul class="tsd-signatures tsd-is-external">
662<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
842d8918 663<li class="tsd-description">
664<div class="tsd-parameters">
665<h4 class="tsd-parameters-title">Parameters</h4>
666<ul class="tsd-parameter-list">
667<li>
3bd6a82e 668<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 669<li>
3bd6a82e 670<h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 671<li>
3bd6a82e 672<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
842d8918 673<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li>
674<li>
3bd6a82e 675<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5>
842d8918 676<div class="tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.</p>
677</div></li></ul></div>
678<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
679<p>Inherited from Array.forEach</p>
680<ul>
70353024 681<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1449</li></ul></aside></li></ul></section>
3bd6a82e 682<section class="tsd-panel tsd-member"><a id="full" class="tsd-anchor"></a>
842d8918 683<h3 class="tsd-anchor-link"><span>full</span><a href="#full" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 684<ul class="tsd-signatures">
8d1797ad 685<li class="tsd-signature tsd-anchor-link" id="full.full-1"><span class="tsd-kind-call-signature">full</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#full.full-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 686<li class="tsd-description">
687<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
688<ul>
ccb7d1a7 689<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/414339e/src/circular-array.ts#L84">src/circular-array.ts:84</a></li></ul></aside></li></ul></section>
3bd6a82e 690<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="includes-1" class="tsd-anchor"></a>
842d8918 691<h3 class="tsd-anchor-link"><span>includes</span><a href="#includes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 692<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 693<li class="tsd-signature tsd-anchor-link" id="includes-1.includes-2"><span class="tsd-kind-call-signature">includes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">searchElement</span>, <span class="tsd-kind-parameter">fromIndex</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#includes-1.includes-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 694<li class="tsd-description">
695<div class="tsd-comment tsd-typography"><p>Determines whether an array includes a certain element, returning true or false as appropriate.</p>
696</div>
697<div class="tsd-parameters">
698<h4 class="tsd-parameters-title">Parameters</h4>
699<ul class="tsd-parameter-list">
700<li>
3bd6a82e 701<h5><span class="tsd-kind-parameter">searchElement</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5>
842d8918 702<div class="tsd-comment tsd-typography"><p>The element to search for.</p>
703</div></li>
704<li>
3bd6a82e 705<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">fromIndex</span>: <span class="tsd-signature-type">number</span></h5>
842d8918 706<div class="tsd-comment tsd-typography"><p>The position in this array at which to begin searching for searchElement.</p>
707</div></li></ul></div>
708<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
709<p>Inherited from Array.includes</p>
710<ul>
70353024 711<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2016.array.include.d.ts:25</li></ul></aside></li></ul></section>
3bd6a82e 712<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="indexOf-1" class="tsd-anchor"></a>
842d8918 713<h3 class="tsd-anchor-link"><span>index<wbr/>Of</span><a href="#indexOf-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 714<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 715<li class="tsd-signature tsd-anchor-link" id="indexOf-1.indexOf-2"><span class="tsd-kind-call-signature">index<wbr/>Of</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">searchElement</span>, <span class="tsd-kind-parameter">fromIndex</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="#indexOf-1.indexOf-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 716<li class="tsd-description">
717<div class="tsd-comment tsd-typography"><p>Returns the index of the first occurrence of a value in an array, or -1 if it is not present.</p>
718</div>
719<div class="tsd-parameters">
720<h4 class="tsd-parameters-title">Parameters</h4>
721<ul class="tsd-parameter-list">
722<li>
3bd6a82e 723<h5><span class="tsd-kind-parameter">searchElement</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5>
842d8918 724<div class="tsd-comment tsd-typography"><p>The value to locate in the array.</p>
725</div></li>
726<li>
3bd6a82e 727<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">fromIndex</span>: <span class="tsd-signature-type">number</span></h5>
842d8918 728<div class="tsd-comment tsd-typography"><p>The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.</p>
729</div></li></ul></div>
730<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
731<p>Inherited from Array.indexOf</p>
732<ul>
70353024 733<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1410</li></ul></aside></li></ul></section>
3bd6a82e 734<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="join-1" class="tsd-anchor"></a>
842d8918 735<h3 class="tsd-anchor-link"><span>join</span><a href="#join-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 736<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 737<li class="tsd-signature tsd-anchor-link" id="join-1.join-2"><span class="tsd-kind-call-signature">join</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">separator</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><a href="#join-1.join-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 738<li class="tsd-description">
739<div class="tsd-comment tsd-typography"><p>Adds all the elements of an array into a string, separated by the specified separator string.</p>
740</div>
741<div class="tsd-parameters">
742<h4 class="tsd-parameters-title">Parameters</h4>
743<ul class="tsd-parameter-list">
744<li>
3bd6a82e 745<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">separator</span>: <span class="tsd-signature-type">string</span></h5>
842d8918 746<div class="tsd-comment tsd-typography"><p>A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.</p>
747</div></li></ul></div>
748<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
749<p>Inherited from Array.join</p>
750<ul>
70353024 751<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1353</li></ul></aside></li></ul></section>
3bd6a82e 752<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="keys-1" class="tsd-anchor"></a>
842d8918 753<h3 class="tsd-anchor-link"><span>keys</span><a href="#keys-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 754<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 755<li class="tsd-signature tsd-anchor-link" id="keys-1.keys-2"><span class="tsd-kind-call-signature">keys</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><a href="#keys-1.keys-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 756<li class="tsd-description">
757<div class="tsd-comment tsd-typography"><p>Returns an iterable of keys in the array</p>
758</div>
3bd6a82e 759<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
842d8918 760<p>Inherited from Array.keys</p>
761<ul>
70353024 762<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:68</li></ul></aside></li></ul></section>
3bd6a82e 763<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lastIndexOf-1" class="tsd-anchor"></a>
842d8918 764<h3 class="tsd-anchor-link"><span>last<wbr/>Index<wbr/>Of</span><a href="#lastIndexOf-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 765<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 766<li class="tsd-signature tsd-anchor-link" id="lastIndexOf-1.lastIndexOf-2"><span class="tsd-kind-call-signature">last<wbr/>Index<wbr/>Of</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">searchElement</span>, <span class="tsd-kind-parameter">fromIndex</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="#lastIndexOf-1.lastIndexOf-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 767<li class="tsd-description">
768<div class="tsd-comment tsd-typography"><p>Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.</p>
769</div>
770<div class="tsd-parameters">
771<h4 class="tsd-parameters-title">Parameters</h4>
772<ul class="tsd-parameter-list">
773<li>
3bd6a82e 774<h5><span class="tsd-kind-parameter">searchElement</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5>
842d8918 775<div class="tsd-comment tsd-typography"><p>The value to locate in the array.</p>
776</div></li>
777<li>
3bd6a82e 778<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">fromIndex</span>: <span class="tsd-signature-type">number</span></h5>
842d8918 779<div class="tsd-comment tsd-typography"><p>The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.</p>
780</div></li></ul></div>
781<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
782<p>Inherited from Array.lastIndexOf</p>
783<ul>
70353024 784<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1416</li></ul></aside></li></ul></section>
3bd6a82e 785<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="map-1" class="tsd-anchor"></a>
842d8918 786<h3 class="tsd-anchor-link"><span>map</span><a href="#map-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 787<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 788<li class="tsd-signature tsd-anchor-link" id="map-1.map-2"><span class="tsd-kind-call-signature">map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callbackfn</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">U</span><span class="tsd-signature-symbol">[]</span><a href="#map-1.map-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 789<li class="tsd-description">
790<div class="tsd-comment tsd-typography"><p>Calls a defined callback function on each element of an array, and returns an array that contains the results.</p>
791</div>
fab6d3b5 792<section class="tsd-panel">
842d8918 793<h4>Type Parameters</h4>
fab6d3b5 794<ul class="tsd-type-parameter-list">
842d8918 795<li>
3bd6a82e 796<h4><span class="tsd-kind-type-parameter">U</span></h4></li></ul></section>
842d8918 797<div class="tsd-parameters">
798<h4 class="tsd-parameters-title">Parameters</h4>
799<ul class="tsd-parameter-list">
800<li>
3bd6a82e 801<h5><span class="tsd-kind-parameter">callbackfn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 802<div class="tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.</p>
803</div>
804<ul class="tsd-parameters">
805<li class="tsd-parameter-signature">
3bd6a82e 806<ul class="tsd-signatures tsd-is-external">
807<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span></li>
842d8918 808<li class="tsd-description">
809<div class="tsd-parameters">
810<h4 class="tsd-parameters-title">Parameters</h4>
811<ul class="tsd-parameter-list">
812<li>
3bd6a82e 813<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 814<li>
3bd6a82e 815<h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 816<li>
3bd6a82e 817<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
818<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4></li></ul></li></ul></li>
842d8918 819<li>
3bd6a82e 820<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5>
842d8918 821<div class="tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.</p>
822</div></li></ul></div>
3bd6a82e 823<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 824<p>Inherited from Array.map</p>
825<ul>
70353024 826<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1455</li></ul></aside></li></ul></section>
3bd6a82e 827<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pop-1" class="tsd-anchor"></a>
842d8918 828<h3 class="tsd-anchor-link"><span>pop</span><a href="#pop-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 829<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 830<li class="tsd-signature tsd-anchor-link" id="pop-1.pop-2"><span class="tsd-kind-call-signature">pop</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><a href="#pop-1.pop-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 831<li class="tsd-description">
832<div class="tsd-comment tsd-typography"><p>Removes the last element from an array and returns it.
833If the array is empty, undefined is returned and the array is not modified.</p>
834</div>
3bd6a82e 835<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><aside class="tsd-sources">
842d8918 836<p>Inherited from Array.pop</p>
837<ul>
70353024 838<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1331</li></ul></aside></li></ul></section>
3bd6a82e 839<section class="tsd-panel tsd-member"><a id="push-1" class="tsd-anchor"></a>
842d8918 840<h3 class="tsd-anchor-link"><span>push</span><a href="#push-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 841<ul class="tsd-signatures">
8d1797ad 842<li class="tsd-signature tsd-anchor-link" id="push-1.push-2"><span class="tsd-kind-call-signature">push</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#push-1.push-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 843<li class="tsd-description">
fab6d3b5 844<div class="tsd-comment tsd-typography">
845<h3>Inherit Doc</h3></div>
842d8918 846<div class="tsd-parameters">
847<h4 class="tsd-parameters-title">Parameters</h4>
848<ul class="tsd-parameter-list">
849<li>
3bd6a82e 850<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
842d8918 851<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
852<p>Overrides Array.push</p>
853<ul>
ccb7d1a7 854<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/414339e/src/circular-array.ts#L21">src/circular-array.ts:21</a></li></ul></aside></li></ul></section>
3bd6a82e 855<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="reduce-1" class="tsd-anchor"></a>
842d8918 856<h3 class="tsd-anchor-link"><span>reduce</span><a href="#reduce-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 857<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 858<li class="tsd-signature tsd-anchor-link" id="reduce-1.reduce-2"><span class="tsd-kind-call-signature">reduce</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callbackfn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><a href="#reduce-1.reduce-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 859<li class="tsd-description">
860<div class="tsd-comment tsd-typography"><p>Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.</p>
861</div>
862<div class="tsd-parameters">
863<h4 class="tsd-parameters-title">Parameters</h4>
864<ul class="tsd-parameter-list">
865<li>
3bd6a82e 866<h5><span class="tsd-kind-parameter">callbackfn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previousValue</span>, <span class="tsd-kind-parameter">currentValue</span>, <span class="tsd-kind-parameter">currentIndex</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 867<div class="tsd-comment tsd-typography"><p>A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.</p>
868</div>
869<ul class="tsd-parameters">
870<li class="tsd-parameter-signature">
3bd6a82e 871<ul class="tsd-signatures tsd-is-external">
872<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previousValue</span>, <span class="tsd-kind-parameter">currentValue</span>, <span class="tsd-kind-parameter">currentIndex</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></li>
842d8918 873<li class="tsd-description">
874<div class="tsd-parameters">
875<h4 class="tsd-parameters-title">Parameters</h4>
876<ul class="tsd-parameter-list">
877<li>
3bd6a82e 878<h5><span class="tsd-kind-parameter">previousValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 879<li>
3bd6a82e 880<h5><span class="tsd-kind-parameter">currentValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 881<li>
3bd6a82e 882<h5><span class="tsd-kind-parameter">currentIndex</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 883<li>
3bd6a82e 884<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
885<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4></li></ul></li></ul></li></ul></div>
886<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><aside class="tsd-sources">
842d8918 887<p>Inherited from Array.reduce</p>
888<ul>
70353024 889<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1473</li></ul></aside></li>
8d1797ad 890<li class="tsd-signature tsd-anchor-link" id="reduce-1.reduce-3"><span class="tsd-kind-call-signature">reduce</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callbackfn</span>, <span class="tsd-kind-parameter">initialValue</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><a href="#reduce-1.reduce-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 891<li class="tsd-description">
892<div class="tsd-parameters">
893<h4 class="tsd-parameters-title">Parameters</h4>
894<ul class="tsd-parameter-list">
895<li>
3bd6a82e 896<h5><span class="tsd-kind-parameter">callbackfn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previousValue</span>, <span class="tsd-kind-parameter">currentValue</span>, <span class="tsd-kind-parameter">currentIndex</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 897<ul class="tsd-parameters">
898<li class="tsd-parameter-signature">
3bd6a82e 899<ul class="tsd-signatures tsd-is-external">
900<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previousValue</span>, <span class="tsd-kind-parameter">currentValue</span>, <span class="tsd-kind-parameter">currentIndex</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></li>
842d8918 901<li class="tsd-description">
902<div class="tsd-parameters">
903<h4 class="tsd-parameters-title">Parameters</h4>
904<ul class="tsd-parameter-list">
905<li>
3bd6a82e 906<h5><span class="tsd-kind-parameter">previousValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 907<li>
3bd6a82e 908<h5><span class="tsd-kind-parameter">currentValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 909<li>
3bd6a82e 910<h5><span class="tsd-kind-parameter">currentIndex</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 911<li>
3bd6a82e 912<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
913<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4></li></ul></li></ul></li>
842d8918 914<li>
3bd6a82e 915<h5><span class="tsd-kind-parameter">initialValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div>
916<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><aside class="tsd-sources">
842d8918 917<p>Inherited from Array.reduce</p>
918<ul>
70353024 919<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1474</li></ul></aside></li>
8d1797ad 920<li class="tsd-signature tsd-anchor-link" id="reduce-1.reduce-4"><span class="tsd-kind-call-signature">reduce</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callbackfn</span>, <span class="tsd-kind-parameter">initialValue</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><a href="#reduce-1.reduce-4" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 921<li class="tsd-description">
922<div class="tsd-comment tsd-typography"><p>Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.</p>
923</div>
fab6d3b5 924<section class="tsd-panel">
842d8918 925<h4>Type Parameters</h4>
fab6d3b5 926<ul class="tsd-type-parameter-list">
842d8918 927<li>
3bd6a82e 928<h4><span class="tsd-kind-type-parameter">U</span></h4></li></ul></section>
842d8918 929<div class="tsd-parameters">
930<h4 class="tsd-parameters-title">Parameters</h4>
931<ul class="tsd-parameter-list">
932<li>
3bd6a82e 933<h5><span class="tsd-kind-parameter">callbackfn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previousValue</span>, <span class="tsd-kind-parameter">currentValue</span>, <span class="tsd-kind-parameter">currentIndex</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 934<div class="tsd-comment tsd-typography"><p>A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.</p>
935</div>
936<ul class="tsd-parameters">
937<li class="tsd-parameter-signature">
3bd6a82e 938<ul class="tsd-signatures tsd-is-external">
939<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previousValue</span>, <span class="tsd-kind-parameter">currentValue</span>, <span class="tsd-kind-parameter">currentIndex</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span></li>
842d8918 940<li class="tsd-description">
941<div class="tsd-parameters">
942<h4 class="tsd-parameters-title">Parameters</h4>
943<ul class="tsd-parameter-list">
944<li>
3bd6a82e 945<h5><span class="tsd-kind-parameter">previousValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h5></li>
842d8918 946<li>
3bd6a82e 947<h5><span class="tsd-kind-parameter">currentValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 948<li>
3bd6a82e 949<h5><span class="tsd-kind-parameter">currentIndex</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 950<li>
3bd6a82e 951<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
952<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4></li></ul></li></ul></li>
842d8918 953<li>
3bd6a82e 954<h5><span class="tsd-kind-parameter">initialValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h5>
842d8918 955<div class="tsd-comment tsd-typography"><p>If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.</p>
956</div></li></ul></div>
3bd6a82e 957<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4><aside class="tsd-sources">
842d8918 958<p>Inherited from Array.reduce</p>
959<ul>
70353024 960<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1480</li></ul></aside></li></ul></section>
3bd6a82e 961<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="reduceRight-1" class="tsd-anchor"></a>
842d8918 962<h3 class="tsd-anchor-link"><span>reduce<wbr/>Right</span><a href="#reduceRight-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 963<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 964<li class="tsd-signature tsd-anchor-link" id="reduceRight-1.reduceRight-2"><span class="tsd-kind-call-signature">reduce<wbr/>Right</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callbackfn</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><a href="#reduceRight-1.reduceRight-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 965<li class="tsd-description">
966<div class="tsd-comment tsd-typography"><p>Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.</p>
967</div>
968<div class="tsd-parameters">
969<h4 class="tsd-parameters-title">Parameters</h4>
970<ul class="tsd-parameter-list">
971<li>
3bd6a82e 972<h5><span class="tsd-kind-parameter">callbackfn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previousValue</span>, <span class="tsd-kind-parameter">currentValue</span>, <span class="tsd-kind-parameter">currentIndex</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 973<div class="tsd-comment tsd-typography"><p>A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.</p>
974</div>
975<ul class="tsd-parameters">
976<li class="tsd-parameter-signature">
3bd6a82e 977<ul class="tsd-signatures tsd-is-external">
978<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previousValue</span>, <span class="tsd-kind-parameter">currentValue</span>, <span class="tsd-kind-parameter">currentIndex</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></li>
842d8918 979<li class="tsd-description">
980<div class="tsd-parameters">
981<h4 class="tsd-parameters-title">Parameters</h4>
982<ul class="tsd-parameter-list">
983<li>
3bd6a82e 984<h5><span class="tsd-kind-parameter">previousValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 985<li>
3bd6a82e 986<h5><span class="tsd-kind-parameter">currentValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 987<li>
3bd6a82e 988<h5><span class="tsd-kind-parameter">currentIndex</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 989<li>
3bd6a82e 990<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
991<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4></li></ul></li></ul></li></ul></div>
992<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><aside class="tsd-sources">
842d8918 993<p>Inherited from Array.reduceRight</p>
994<ul>
70353024 995<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1486</li></ul></aside></li>
8d1797ad 996<li class="tsd-signature tsd-anchor-link" id="reduceRight-1.reduceRight-3"><span class="tsd-kind-call-signature">reduce<wbr/>Right</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callbackfn</span>, <span class="tsd-kind-parameter">initialValue</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><a href="#reduceRight-1.reduceRight-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 997<li class="tsd-description">
998<div class="tsd-parameters">
999<h4 class="tsd-parameters-title">Parameters</h4>
1000<ul class="tsd-parameter-list">
1001<li>
3bd6a82e 1002<h5><span class="tsd-kind-parameter">callbackfn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previousValue</span>, <span class="tsd-kind-parameter">currentValue</span>, <span class="tsd-kind-parameter">currentIndex</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 1003<ul class="tsd-parameters">
1004<li class="tsd-parameter-signature">
3bd6a82e 1005<ul class="tsd-signatures tsd-is-external">
1006<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previousValue</span>, <span class="tsd-kind-parameter">currentValue</span>, <span class="tsd-kind-parameter">currentIndex</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></li>
842d8918 1007<li class="tsd-description">
1008<div class="tsd-parameters">
1009<h4 class="tsd-parameters-title">Parameters</h4>
1010<ul class="tsd-parameter-list">
1011<li>
3bd6a82e 1012<h5><span class="tsd-kind-parameter">previousValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 1013<li>
3bd6a82e 1014<h5><span class="tsd-kind-parameter">currentValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 1015<li>
3bd6a82e 1016<h5><span class="tsd-kind-parameter">currentIndex</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 1017<li>
3bd6a82e 1018<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
1019<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4></li></ul></li></ul></li>
842d8918 1020<li>
3bd6a82e 1021<h5><span class="tsd-kind-parameter">initialValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div>
1022<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><aside class="tsd-sources">
842d8918 1023<p>Inherited from Array.reduceRight</p>
1024<ul>
70353024 1025<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1487</li></ul></aside></li>
8d1797ad 1026<li class="tsd-signature tsd-anchor-link" id="reduceRight-1.reduceRight-4"><span class="tsd-kind-call-signature">reduce<wbr/>Right</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callbackfn</span>, <span class="tsd-kind-parameter">initialValue</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><a href="#reduceRight-1.reduceRight-4" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1027<li class="tsd-description">
1028<div class="tsd-comment tsd-typography"><p>Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.</p>
1029</div>
fab6d3b5 1030<section class="tsd-panel">
842d8918 1031<h4>Type Parameters</h4>
fab6d3b5 1032<ul class="tsd-type-parameter-list">
842d8918 1033<li>
3bd6a82e 1034<h4><span class="tsd-kind-type-parameter">U</span></h4></li></ul></section>
842d8918 1035<div class="tsd-parameters">
1036<h4 class="tsd-parameters-title">Parameters</h4>
1037<ul class="tsd-parameter-list">
1038<li>
3bd6a82e 1039<h5><span class="tsd-kind-parameter">callbackfn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previousValue</span>, <span class="tsd-kind-parameter">currentValue</span>, <span class="tsd-kind-parameter">currentIndex</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 1040<div class="tsd-comment tsd-typography"><p>A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.</p>
1041</div>
1042<ul class="tsd-parameters">
1043<li class="tsd-parameter-signature">
3bd6a82e 1044<ul class="tsd-signatures tsd-is-external">
1045<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previousValue</span>, <span class="tsd-kind-parameter">currentValue</span>, <span class="tsd-kind-parameter">currentIndex</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span></li>
842d8918 1046<li class="tsd-description">
1047<div class="tsd-parameters">
1048<h4 class="tsd-parameters-title">Parameters</h4>
1049<ul class="tsd-parameter-list">
1050<li>
3bd6a82e 1051<h5><span class="tsd-kind-parameter">previousValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h5></li>
842d8918 1052<li>
3bd6a82e 1053<h5><span class="tsd-kind-parameter">currentValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 1054<li>
3bd6a82e 1055<h5><span class="tsd-kind-parameter">currentIndex</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 1056<li>
3bd6a82e 1057<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
1058<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4></li></ul></li></ul></li>
842d8918 1059<li>
3bd6a82e 1060<h5><span class="tsd-kind-parameter">initialValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h5>
842d8918 1061<div class="tsd-comment tsd-typography"><p>If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.</p>
1062</div></li></ul></div>
3bd6a82e 1063<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4><aside class="tsd-sources">
842d8918 1064<p>Inherited from Array.reduceRight</p>
1065<ul>
70353024 1066<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1493</li></ul></aside></li></ul></section>
3bd6a82e 1067<section class="tsd-panel tsd-member"><a id="resize" class="tsd-anchor"></a>
842d8918 1068<h3 class="tsd-anchor-link"><span>resize</span><a href="#resize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1069<ul class="tsd-signatures">
8d1797ad 1070<li class="tsd-signature tsd-anchor-link" id="resize.resize-1"><span class="tsd-kind-call-signature">resize</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">size</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#resize.resize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1071<li class="tsd-description">
1072<div class="tsd-parameters">
1073<h4 class="tsd-parameters-title">Parameters</h4>
1074<ul class="tsd-parameter-list">
1075<li>
3bd6a82e 1076<h5><span class="tsd-kind-parameter">size</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
842d8918 1077<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1078<ul>
ccb7d1a7 1079<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/414339e/src/circular-array.ts#L68">src/circular-array.ts:68</a></li></ul></aside></li></ul></section>
3bd6a82e 1080<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="reverse-1" class="tsd-anchor"></a>
842d8918 1081<h3 class="tsd-anchor-link"><span>reverse</span><a href="#reverse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1082<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 1083<li class="tsd-signature tsd-anchor-link" id="reverse-1.reverse-2"><span class="tsd-kind-call-signature">reverse</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">T</span><span class="tsd-signature-symbol">[]</span><a href="#reverse-1.reverse-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1084<li class="tsd-description">
1085<div class="tsd-comment tsd-typography"><p>Reverses the elements in an array in place.
1086This method mutates the array and returns a reference to the same array.</p>
1087</div>
3bd6a82e 1088<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 1089<p>Inherited from Array.reverse</p>
1090<ul>
70353024 1091<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1358</li></ul></aside></li></ul></section>
3bd6a82e 1092<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="shift-1" class="tsd-anchor"></a>
842d8918 1093<h3 class="tsd-anchor-link"><span>shift</span><a href="#shift-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1094<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 1095<li class="tsd-signature tsd-anchor-link" id="shift-1.shift-2"><span class="tsd-kind-call-signature">shift</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><a href="#shift-1.shift-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1096<li class="tsd-description">
1097<div class="tsd-comment tsd-typography"><p>Removes the first element from an array and returns it.
1098If the array is empty, undefined is returned and the array is not modified.</p>
1099</div>
3bd6a82e 1100<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><aside class="tsd-sources">
842d8918 1101<p>Inherited from Array.shift</p>
1102<ul>
70353024 1103<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1363</li></ul></aside></li></ul></section>
3bd6a82e 1104<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="slice-1" class="tsd-anchor"></a>
842d8918 1105<h3 class="tsd-anchor-link"><span>slice</span><a href="#slice-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1106<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 1107<li class="tsd-signature tsd-anchor-link" id="slice-1.slice-2"><span class="tsd-kind-call-signature">slice</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">start</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">end</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">T</span><span class="tsd-signature-symbol">[]</span><a href="#slice-1.slice-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1108<li class="tsd-description">
1109<div class="tsd-comment tsd-typography"><p>Returns a copy of a section of an array.
1110For both start and end, a negative index can be used to indicate an offset from the end of the array.
1111For example, -2 refers to the second to last element of the array.</p>
1112</div>
1113<div class="tsd-parameters">
1114<h4 class="tsd-parameters-title">Parameters</h4>
1115<ul class="tsd-parameter-list">
1116<li>
3bd6a82e 1117<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">start</span>: <span class="tsd-signature-type">number</span></h5>
842d8918 1118<div class="tsd-comment tsd-typography"><p>The beginning index of the specified portion of the array.
1119If start is undefined, then the slice begins at index 0.</p>
1120</div></li>
1121<li>
3bd6a82e 1122<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">end</span>: <span class="tsd-signature-type">number</span></h5>
842d8918 1123<div class="tsd-comment tsd-typography"><p>The end index of the specified portion of the array. This is exclusive of the element at the index &#39;end&#39;.
1124If end is undefined, then the slice extends to the end of the array.</p>
1125</div></li></ul></div>
3bd6a82e 1126<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 1127<p>Inherited from Array.slice</p>
1128<ul>
70353024 1129<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1373</li></ul></aside></li></ul></section>
3bd6a82e 1130<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="some-1" class="tsd-anchor"></a>
842d8918 1131<h3 class="tsd-anchor-link"><span>some</span><a href="#some-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1132<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 1133<li class="tsd-signature tsd-anchor-link" id="some-1.some-2"><span class="tsd-kind-call-signature">some</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">predicate</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">boolean</span><a href="#some-1.some-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1134<li class="tsd-description">
1135<div class="tsd-comment tsd-typography"><p>Determines whether the specified callback function returns true for any element of an array.</p>
1136</div>
1137<div class="tsd-parameters">
1138<h4 class="tsd-parameters-title">Parameters</h4>
1139<ul class="tsd-parameter-list">
1140<li>
3bd6a82e 1141<h5><span class="tsd-kind-parameter">predicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 1142<div class="tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The some method calls
1143the predicate function for each element in the array until the predicate returns a value
1144which is coercible to the Boolean value true, or until the end of the array.</p>
1145</div>
1146<ul class="tsd-parameters">
1147<li class="tsd-parameter-signature">
3bd6a82e 1148<ul class="tsd-signatures tsd-is-external">
1149<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span>, <span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></li>
842d8918 1150<li class="tsd-description">
1151<div class="tsd-parameters">
1152<h4 class="tsd-parameters-title">Parameters</h4>
1153<ul class="tsd-parameter-list">
1154<li>
3bd6a82e 1155<h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 1156<li>
3bd6a82e 1157<h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 1158<li>
3bd6a82e 1159<h5><span class="tsd-kind-parameter">array</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
842d8918 1160<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></li></ul></li>
1161<li>
3bd6a82e 1162<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5>
842d8918 1163<div class="tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the predicate function.
1164If thisArg is omitted, undefined is used as the this value.</p>
1165</div></li></ul></div>
1166<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
1167<p>Inherited from Array.some</p>
1168<ul>
70353024 1169<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1443</li></ul></aside></li></ul></section>
3bd6a82e 1170<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="sort-1" class="tsd-anchor"></a>
842d8918 1171<h3 class="tsd-anchor-link"><span>sort</span><a href="#sort-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1172<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 1173<li class="tsd-signature tsd-anchor-link" id="sort-1.sort-2"><span class="tsd-kind-call-signature">sort</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">compareFn</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><a href="#sort-1.sort-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1174<li class="tsd-description">
1175<div class="tsd-comment tsd-typography"><p>Sorts an array in place.
1176This method mutates the array and returns a reference to the same array.</p>
1177</div>
1178<div class="tsd-parameters">
1179<h4 class="tsd-parameters-title">Parameters</h4>
1180<ul class="tsd-parameter-list">
1181<li>
3bd6a82e 1182<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">compareFn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">a</span>, <span class="tsd-kind-parameter">b</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 1183<div class="tsd-comment tsd-typography"><p>Function used to determine the order of the elements. It is expected to return
1184a negative value if the first argument is less than the second argument, zero if they&#39;re equal, and a positive
1185value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.</p>
1186<pre><code class="language-ts"><span class="hl-0">[</span><span class="hl-1">11</span><span class="hl-0">,</span><span class="hl-1">2</span><span class="hl-0">,</span><span class="hl-1">22</span><span class="hl-0">,</span><span class="hl-1">1</span><span class="hl-0">].</span><span class="hl-2">sort</span><span class="hl-0">((</span><span class="hl-3">a</span><span class="hl-0">, </span><span class="hl-3">b</span><span class="hl-0">) </span><span class="hl-4">=&gt;</span><span class="hl-0"> </span><span class="hl-3">a</span><span class="hl-0"> - </span><span class="hl-3">b</span><span class="hl-0">)</span>
fab6d3b5 1187</code><button>Copy</button></pre>
842d8918 1188</div>
1189<ul class="tsd-parameters">
1190<li class="tsd-parameter-signature">
3bd6a82e 1191<ul class="tsd-signatures tsd-is-external">
1192<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">a</span>, <span class="tsd-kind-parameter">b</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
842d8918 1193<li class="tsd-description">
1194<div class="tsd-parameters">
1195<h4 class="tsd-parameters-title">Parameters</h4>
1196<ul class="tsd-parameter-list">
1197<li>
3bd6a82e 1198<h5><span class="tsd-kind-parameter">a</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 1199<li>
3bd6a82e 1200<h5><span class="tsd-kind-parameter">b</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div>
842d8918 1201<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></li></ul></li></ul></div>
8d1797ad 1202<h4 class="tsd-returns-title">Returns <a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
842d8918 1203<p>Inherited from Array.sort</p>
1204<ul>
70353024 1205<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1384</li></ul></aside></li></ul></section>
3bd6a82e 1206<section class="tsd-panel tsd-member"><a id="splice-1" class="tsd-anchor"></a>
842d8918 1207<h3 class="tsd-anchor-link"><span>splice</span><a href="#splice-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1208<ul class="tsd-signatures">
8d1797ad 1209<li class="tsd-signature tsd-anchor-link" id="splice-1.splice-2"><span class="tsd-kind-call-signature">splice</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">start</span>, <span class="tsd-kind-parameter">deleteCount</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><a href="#splice-1.splice-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1210<li class="tsd-description">
fab6d3b5 1211<div class="tsd-comment tsd-typography">
1212<h3>Inherit Doc</h3></div>
842d8918 1213<div class="tsd-parameters">
1214<h4 class="tsd-parameters-title">Parameters</h4>
1215<ul class="tsd-parameter-list">
1216<li>
3bd6a82e 1217<h5><span class="tsd-kind-parameter">start</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 1218<li>
3bd6a82e 1219<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">deleteCount</span>: <span class="tsd-signature-type">number</span></h5></li>
842d8918 1220<li>
3bd6a82e 1221<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
1222<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 1223<p>Overrides Array.splice</p>
1224<ul>
ccb7d1a7 1225<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/414339e/src/circular-array.ts#L54">src/circular-array.ts:54</a></li></ul></aside></li></ul></section>
3bd6a82e 1226<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toLocaleString-1" class="tsd-anchor"></a>
842d8918 1227<h3 class="tsd-anchor-link"><span>to<wbr/>Locale<wbr/>String</span><a href="#toLocaleString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1228<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 1229<li class="tsd-signature tsd-anchor-link" id="toLocaleString-1.toLocaleString-2"><span class="tsd-kind-call-signature">to<wbr/>Locale<wbr/>String</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><a href="#toLocaleString-1.toLocaleString-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1230<li class="tsd-description">
1231<div class="tsd-comment tsd-typography"><p>Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.</p>
1232</div>
1233<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
1234<p>Inherited from Array.toLocaleString</p>
1235<ul>
70353024 1236<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1326</li></ul></aside></li></ul></section>
3bd6a82e 1237<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toString-1" class="tsd-anchor"></a>
842d8918 1238<h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1239<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 1240<li class="tsd-signature tsd-anchor-link" id="toString-1.toString-2"><span class="tsd-kind-call-signature">to<wbr/>String</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><a href="#toString-1.toString-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1241<li class="tsd-description">
1242<div class="tsd-comment tsd-typography"><p>Returns a string representation of an array.</p>
1243</div>
1244<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
1245<p>Inherited from Array.toString</p>
1246<ul>
70353024 1247<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1322</li></ul></aside></li></ul></section>
3bd6a82e 1248<section class="tsd-panel tsd-member"><a id="unshift-1" class="tsd-anchor"></a>
842d8918 1249<h3 class="tsd-anchor-link"><span>unshift</span><a href="#unshift-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1250<ul class="tsd-signatures">
8d1797ad 1251<li class="tsd-signature tsd-anchor-link" id="unshift-1.unshift-2"><span class="tsd-kind-call-signature">unshift</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#unshift-1.unshift-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1252<li class="tsd-description">
fab6d3b5 1253<div class="tsd-comment tsd-typography">
1254<h3>Inherit Doc</h3></div>
842d8918 1255<div class="tsd-parameters">
1256<h4 class="tsd-parameters-title">Parameters</h4>
1257<ul class="tsd-parameter-list">
1258<li>
3bd6a82e 1259<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
842d8918 1260<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
1261<p>Overrides Array.unshift</p>
1262<ul>
ccb7d1a7 1263<li>Defined in <a href="https://github.com/poolifier/poolifier/blob/414339e/src/circular-array.ts#L30">src/circular-array.ts:30</a></li></ul></aside></li></ul></section>
3bd6a82e 1264<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="values-1" class="tsd-anchor"></a>
842d8918 1265<h3 class="tsd-anchor-link"><span>values</span><a href="#values-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1266<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 1267<li class="tsd-signature tsd-anchor-link" id="values-1.values-2"><span class="tsd-kind-call-signature">values</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><a href="#values-1.values-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1268<li class="tsd-description">
1269<div class="tsd-comment tsd-typography"><p>Returns an iterable of values in the array</p>
1270</div>
3bd6a82e 1271<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
842d8918 1272<p>Inherited from Array.values</p>
1273<ul>
70353024 1274<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:73</li></ul></aside></li></ul></section>
3bd6a82e 1275<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a>
842d8918 1276<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1277<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 1278<li class="tsd-signature tsd-anchor-link" id="from.from-1"><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arrayLike</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1279<li class="tsd-description">
1280<div class="tsd-comment tsd-typography"><p>Creates an array from an array-like object.</p>
1281</div>
fab6d3b5 1282<section class="tsd-panel">
842d8918 1283<h4>Type Parameters</h4>
fab6d3b5 1284<ul class="tsd-type-parameter-list">
842d8918 1285<li>
3bd6a82e 1286<h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
842d8918 1287<div class="tsd-parameters">
1288<h4 class="tsd-parameters-title">Parameters</h4>
1289<ul class="tsd-parameter-list">
1290<li>
3bd6a82e 1291<h5><span class="tsd-kind-parameter">arrayLike</span>: <span class="tsd-signature-type ">ArrayLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
842d8918 1292<div class="tsd-comment tsd-typography"><p>An array-like object to convert to an array.</p>
1293</div></li></ul></div>
3bd6a82e 1294<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 1295<p>Inherited from Array.from</p>
1296<ul>
70353024 1297<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.core.d.ts:70</li></ul></aside></li>
8d1797ad 1298<li class="tsd-signature tsd-anchor-link" id="from.from-2"><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arrayLike</span>, <span class="tsd-kind-parameter">mapfn</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">U</span><span class="tsd-signature-symbol">[]</span><a href="#from.from-2" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1299<li class="tsd-description">
1300<div class="tsd-comment tsd-typography"><p>Creates an array from an iterable object.</p>
1301</div>
fab6d3b5 1302<section class="tsd-panel">
842d8918 1303<h4>Type Parameters</h4>
fab6d3b5 1304<ul class="tsd-type-parameter-list">
842d8918 1305<li>
3bd6a82e 1306<h4><span class="tsd-kind-type-parameter">T</span></h4></li>
842d8918 1307<li>
3bd6a82e 1308<h4><span class="tsd-kind-type-parameter">U</span></h4></li></ul></section>
842d8918 1309<div class="tsd-parameters">
1310<h4 class="tsd-parameters-title">Parameters</h4>
1311<ul class="tsd-parameter-list">
1312<li>
3bd6a82e 1313<h5><span class="tsd-kind-parameter">arrayLike</span>: <span class="tsd-signature-type ">ArrayLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
842d8918 1314<div class="tsd-comment tsd-typography"><p>An array-like object to convert to an array.</p>
1315</div></li>
1316<li>
3bd6a82e 1317<h5><span class="tsd-kind-parameter">mapfn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">v</span>, <span class="tsd-kind-parameter">k</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 1318<div class="tsd-comment tsd-typography"><p>A mapping function to call on every element of the array.</p>
1319</div>
1320<ul class="tsd-parameters">
1321<li class="tsd-parameter-signature">
3bd6a82e 1322<ul class="tsd-signatures tsd-is-external">
1323<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">v</span>, <span class="tsd-kind-parameter">k</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span></li>
842d8918 1324<li class="tsd-description">
1325<div class="tsd-parameters">
1326<h4 class="tsd-parameters-title">Parameters</h4>
1327<ul class="tsd-parameter-list">
1328<li>
3bd6a82e 1329<h5><span class="tsd-kind-parameter">v</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 1330<li>
3bd6a82e 1331<h5><span class="tsd-kind-parameter">k</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
1332<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4></li></ul></li></ul></li>
842d8918 1333<li>
3bd6a82e 1334<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5>
842d8918 1335<div class="tsd-comment tsd-typography"><p>Value of &#39;this&#39; used to invoke the mapfn.</p>
1336</div></li></ul></div>
3bd6a82e 1337<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 1338<p>Inherited from Array.from</p>
1339<ul>
70353024 1340<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.core.d.ts:78</li></ul></aside></li>
8d1797ad 1341<li class="tsd-signature tsd-anchor-link" id="from.from-3"><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">iterable</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><a href="#from.from-3" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1342<li class="tsd-description">
1343<div class="tsd-comment tsd-typography"><p>Creates an array from an iterable object.</p>
1344</div>
fab6d3b5 1345<section class="tsd-panel">
842d8918 1346<h4>Type Parameters</h4>
fab6d3b5 1347<ul class="tsd-type-parameter-list">
842d8918 1348<li>
3bd6a82e 1349<h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
842d8918 1350<div class="tsd-parameters">
1351<h4 class="tsd-parameters-title">Parameters</h4>
1352<ul class="tsd-parameter-list">
1353<li>
3bd6a82e 1354<h5><span class="tsd-kind-parameter">iterable</span>: <span class="tsd-signature-type ">Iterable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">ArrayLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
842d8918 1355<div class="tsd-comment tsd-typography"><p>An iterable object to convert to an array.</p>
1356</div></li></ul></div>
3bd6a82e 1357<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 1358<p>Inherited from Array.from</p>
1359<ul>
70353024 1360<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:81</li></ul></aside></li>
8d1797ad 1361<li class="tsd-signature tsd-anchor-link" id="from.from-4"><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">iterable</span>, <span class="tsd-kind-parameter">mapfn</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">U</span><span class="tsd-signature-symbol">[]</span><a href="#from.from-4" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1362<li class="tsd-description">
1363<div class="tsd-comment tsd-typography"><p>Creates an array from an iterable object.</p>
1364</div>
fab6d3b5 1365<section class="tsd-panel">
842d8918 1366<h4>Type Parameters</h4>
fab6d3b5 1367<ul class="tsd-type-parameter-list">
842d8918 1368<li>
3bd6a82e 1369<h4><span class="tsd-kind-type-parameter">T</span></h4></li>
842d8918 1370<li>
3bd6a82e 1371<h4><span class="tsd-kind-type-parameter">U</span></h4></li></ul></section>
842d8918 1372<div class="tsd-parameters">
1373<h4 class="tsd-parameters-title">Parameters</h4>
1374<ul class="tsd-parameter-list">
1375<li>
3bd6a82e 1376<h5><span class="tsd-kind-parameter">iterable</span>: <span class="tsd-signature-type ">Iterable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">ArrayLike</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
842d8918 1377<div class="tsd-comment tsd-typography"><p>An iterable object to convert to an array.</p>
1378</div></li>
1379<li>
3bd6a82e 1380<h5><span class="tsd-kind-parameter">mapfn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">v</span>, <span class="tsd-kind-parameter">k</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">)</span></h5>
842d8918 1381<div class="tsd-comment tsd-typography"><p>A mapping function to call on every element of the array.</p>
1382</div>
1383<ul class="tsd-parameters">
1384<li class="tsd-parameter-signature">
3bd6a82e 1385<ul class="tsd-signatures tsd-is-external">
1386<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">v</span>, <span class="tsd-kind-parameter">k</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span></li>
842d8918 1387<li class="tsd-description">
1388<div class="tsd-parameters">
1389<h4 class="tsd-parameters-title">Parameters</h4>
1390<ul class="tsd-parameter-list">
1391<li>
3bd6a82e 1392<h5><span class="tsd-kind-parameter">v</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
842d8918 1393<li>
3bd6a82e 1394<h5><span class="tsd-kind-parameter">k</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
1395<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4></li></ul></li></ul></li>
842d8918 1396<li>
3bd6a82e 1397<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5>
842d8918 1398<div class="tsd-comment tsd-typography"><p>Value of &#39;this&#39; used to invoke the mapfn.</p>
1399</div></li></ul></div>
3bd6a82e 1400<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 1401<p>Inherited from Array.from</p>
1402<ul>
70353024 1403<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:89</li></ul></aside></li></ul></section>
3bd6a82e 1404<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isArray" class="tsd-anchor"></a>
842d8918 1405<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Array</span><a href="#isArray" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1406<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
fab6d3b5 1407<li class="tsd-signature tsd-anchor-link" id="isArray.isArray-1"><span class="tsd-kind-call-signature">is<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">arg</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><a href="#isArray.isArray-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1408<li class="tsd-description">
1409<div class="tsd-parameters">
1410<h4 class="tsd-parameters-title">Parameters</h4>
1411<ul class="tsd-parameter-list">
1412<li>
3bd6a82e 1413<h5><span class="tsd-kind-parameter">arg</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
fab6d3b5 1414<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">arg</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 1415<p>Inherited from Array.isArray</p>
1416<ul>
70353024 1417<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es5.d.ts:1505</li></ul></aside></li></ul></section>
3bd6a82e 1418<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="of" class="tsd-anchor"></a>
842d8918 1419<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>of</span><a href="#of" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
3bd6a82e 1420<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
8d1797ad 1421<li class="tsd-signature tsd-anchor-link" id="of.of-1"><span class="tsd-kind-call-signature">of</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span><a href="#of.of-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
842d8918 1422<li class="tsd-description">
1423<div class="tsd-comment tsd-typography"><p>Returns a new array from a set of elements.</p>
1424</div>
fab6d3b5 1425<section class="tsd-panel">
842d8918 1426<h4>Type Parameters</h4>
fab6d3b5 1427<ul class="tsd-type-parameter-list">
842d8918 1428<li>
3bd6a82e 1429<h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
842d8918 1430<div class="tsd-parameters">
1431<h4 class="tsd-parameters-title">Parameters</h4>
1432<ul class="tsd-parameter-list">
1433<li>
3bd6a82e 1434<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h5>
842d8918 1435<div class="tsd-comment tsd-typography"><p>A set of elements to include in the new array object.</p>
1436</div></li></ul></div>
3bd6a82e 1437<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
842d8918 1438<p>Inherited from Array.of</p>
1439<ul>
70353024 1440<li>Defined in node_modules/.pnpm/typescript@5.1.3/node_modules/typescript/lib/lib.es2015.core.d.ts:84</li></ul></aside></li></ul></section></section></div>
842d8918 1441<div class="col-sidebar">
1442<div class="page-menu">
1443<div class="tsd-navigation settings">
1444<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
1445<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)"></path></svg>Settings</h3></summary>
1446<div class="tsd-accordion-details">
1447<div class="tsd-filter-visibility">
1448<h4 class="uppercase">Member Visibility</h4><form>
1449<ul id="tsd-filter-options">
1450<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>
1451<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>
1452<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>
1453<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>
1454<div class="tsd-theme-toggle">
3bd6a82e 1455<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>
842d8918 1456<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
1457<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)"></path></svg>On This Page</h3></summary>
1458<div class="tsd-accordion-details">
1459<ul>
3bd6a82e 1460<li><a href="#constructor" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg><span>constructor</span></a></li>
1461<li><a href="#_unscopables_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>[unscopables]</span></a></li>
1462<li><a href="#length-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>length</span></a></li>
1463<li><a href="#size" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>size</span></a></li>
1464<li><a href="#_species_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>[species]</span></a></li>
1465<li><a href="#_iterator_-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>[iterator]</span></a></li>
1466<li><a href="#at-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>at</span></a></li>
1467<li><a href="#checkSize" class="tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>check<wbr/>Size</span></a></li>
1468<li><a href="#concat-1" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>concat</span></a></li>
1469<li><a href="#copyWithin-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>copy<wbr/>Within</span></a></li>
1470<li><a href="#empty" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>empty</span></a></li>
1471<li><a href="#entries-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>entries</span></a></li>
1472<li><a href="#every-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>every</span></a></li>
1473<li><a href="#fill-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>fill</span></a></li>
1474<li><a href="#filter-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>filter</span></a></li>
1475<li><a href="#find-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>find</span></a></li>
1476<li><a href="#findIndex-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>find<wbr/>Index</span></a></li>
1477<li><a href="#flat-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>flat</span></a></li>
1478<li><a href="#flatMap-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>flat<wbr/>Map</span></a></li>
1479<li><a href="#forEach-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>for<wbr/>Each</span></a></li>
1480<li><a href="#full" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>full</span></a></li>
1481<li><a href="#includes-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>includes</span></a></li>
1482<li><a href="#indexOf-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>index<wbr/>Of</span></a></li>
1483<li><a href="#join-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>join</span></a></li>
1484<li><a href="#keys-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>keys</span></a></li>
1485<li><a href="#lastIndexOf-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>last<wbr/>Index<wbr/>Of</span></a></li>
1486<li><a href="#map-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>map</span></a></li>
1487<li><a href="#pop-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>pop</span></a></li>
1488<li><a href="#push-1" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>push</span></a></li>
1489<li><a href="#reduce-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>reduce</span></a></li>
1490<li><a href="#reduceRight-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>reduce<wbr/>Right</span></a></li>
1491<li><a href="#resize" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>resize</span></a></li>
1492<li><a href="#reverse-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>reverse</span></a></li>
1493<li><a href="#shift-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>shift</span></a></li>
1494<li><a href="#slice-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>slice</span></a></li>
1495<li><a href="#some-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>some</span></a></li>
1496<li><a href="#sort-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>sort</span></a></li>
1497<li><a href="#splice-1" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>splice</span></a></li>
1498<li><a href="#toLocaleString-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>to<wbr/>Locale<wbr/>String</span></a></li>
1499<li><a href="#toString-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>to<wbr/>String</span></a></li>
1500<li><a href="#unshift-1" class=""><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>unshift</span></a></li>
1501<li><a href="#values-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>values</span></a></li>
1502<li><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>from</span></a></li>
1503<li><a href="#isArray" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Array</span></a></li>
1504<li><a href="#of" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>of</span></a></li></ul></div></details></div>
842d8918 1505<div class="site-menu">
1506<nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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" id="icon-4-path"></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)" id="icon-4-text"></path></svg><span>poolifier</span></a>
1507<ul class="tsd-small-nested-navigation">
3bd6a82e 1508<li><a href="../enums/PoolType.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-8-path"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)" id="icon-8-text"></path></svg><span>Pool<wbr/>Type</span></a></li>
1509<li><a href="AbstractPool.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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" id="icon-128-path"></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)" id="icon-128-text"></path></svg><span>Abstract<wbr/>Pool</span></a></li>
1510<li><a href="AbstractWorker.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Abstract<wbr/>Worker</span></a></li>
1511<li><a href="CircularArray.html" class="current"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Circular<wbr/>Array</span></a></li>
1512<li><a href="ClusterWorker.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Cluster<wbr/>Worker</span></a></li>
1513<li><a href="DynamicClusterPool.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Dynamic<wbr/>Cluster<wbr/>Pool</span></a></li>
1514<li><a href="DynamicThreadPool.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Dynamic<wbr/>Thread<wbr/>Pool</span></a></li>
1515<li><a href="FixedClusterPool.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Fixed<wbr/>Cluster<wbr/>Pool</span></a></li>
1516<li><a href="FixedThreadPool.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Fixed<wbr/>Thread<wbr/>Pool</span></a></li>
1517<li><a href="PoolEmitter.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Pool<wbr/>Emitter</span></a></li>
3a592a12 1518<li><a href="Queue.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Queue</span></a></li>
3bd6a82e 1519<li><a href="ThreadWorker.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Thread<wbr/>Worker</span></a></li>
1520<li><a href="WorkerChoiceStrategyContext.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span></a></li>
1521<li><a href="../interfaces/ClusterPoolOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Cluster<wbr/>Pool<wbr/>Options</span></a></li>
1522<li><a href="../interfaces/IPool.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IPool</span></a></li>
1523<li><a href="../interfaces/IWorker.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IWorker</span></a></li>
1524<li><a href="../interfaces/IWorkerChoiceStrategy.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>IWorker<wbr/>Choice<wbr/>Strategy</span></a></li>
1525<li><a href="../interfaces/MessageValue.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Message<wbr/>Value</span></a></li>
1526<li><a href="../interfaces/PoolOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Pool<wbr/>Options</span></a></li>
1527<li><a href="../interfaces/PromiseResponseWrapper.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Promise<wbr/>Response<wbr/>Wrapper</span></a></li>
1528<li><a href="../interfaces/RequiredStatistics.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Required<wbr/>Statistics</span></a></li>
1529<li><a href="../interfaces/Task.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Task</span></a></li>
1530<li><a href="../interfaces/TasksQueueOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Tasks<wbr/>Queue<wbr/>Options</span></a></li>
1531<li><a href="../interfaces/TasksUsage.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Tasks<wbr/>Usage</span></a></li>
1532<li><a href="../interfaces/WorkerChoiceStrategyOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a></li>
1533<li><a href="../interfaces/WorkerNode.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Worker<wbr/>Node</span></a></li>
1534<li><a href="../interfaces/WorkerOptions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Worker<wbr/>Options</span></a></li>
1535<li><a href="../types/Draft.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg><span>Draft</span></a></li>
1536<li><a href="../types/ErrorHandler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Error<wbr/>Handler</span></a></li>
1537<li><a href="../types/ExitHandler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Exit<wbr/>Handler</span></a></li>
1538<li><a href="../types/KillBehavior.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Kill<wbr/>Behavior</span></a></li>
1539<li><a href="../types/MessageHandler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Message<wbr/>Handler</span></a></li>
1540<li><a href="../types/OnlineHandler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Online<wbr/>Handler</span></a></li>
1541<li><a href="../types/PoolEvent.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Pool<wbr/>Event</span></a></li>
2c94c3a5 1542<li><a href="../types/TaskFunctions.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Task<wbr/>Functions</span></a></li>
3bd6a82e 1543<li><a href="../types/ThreadWorkerWithMessageChannel.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Thread<wbr/>Worker<wbr/>With<wbr/>Message<wbr/>Channel</span></a></li>
1544<li><a href="../types/WorkerAsyncFunction.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Worker<wbr/>Async<wbr/>Function</span></a></li>
1545<li><a href="../types/WorkerChoiceStrategy.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy</span></a></li>
1546<li><a href="../types/WorkerFunction.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Worker<wbr/>Function</span></a></li>
1547<li><a href="../types/WorkerSyncFunction.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Worker<wbr/>Sync<wbr/>Function</span></a></li>
1548<li><a href="../variables/KillBehaviors.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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" id="icon-32-path"></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)" id="icon-32-text"></path></svg><span>Kill<wbr/>Behaviors</span></a></li>
1549<li><a href="../variables/PoolEvents.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Pool<wbr/>Events</span></a></li>
1550<li><a href="../variables/WorkerChoiceStrategies.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategies</span></a></li></ul></nav></div></div></div>
842d8918 1551<div class="tsd-generator">
1552<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
1553<div class="overlay"></div></body></html>