| cc35cd9c |
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 - v2.6.40</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> |
| cc35cd9c |
9 | <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier - v2.6.40</a></div> |
| 842d8918 |
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> |
| 95c33366 |
17 | <h1>Class CircularArray<T><code class="tsd-tag ts-flagInternal">Internal</code> </h1></div> |
| 842d8918 |
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> |
| 15d6dfaf |
20 | </div> |
| 21 | <div class="tsd-comment tsd-typography"></div></section> |
| fab6d3b5 |
22 | <section class="tsd-panel"> |
| 842d8918 |
23 | <h4>Type Parameters</h4> |
| fab6d3b5 |
24 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
25 | <li> |
| 3bd6a82e |
26 | <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section> |
| 842d8918 |
27 | <section class="tsd-panel tsd-hierarchy"> |
| 28 | <h4>Hierarchy</h4> |
| 29 | <ul class="tsd-hierarchy"> |
| 3bd6a82e |
30 | <li><span class="tsd-signature-type ">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span> |
| 842d8918 |
31 | <ul class="tsd-hierarchy"> |
| 32 | <li><span class="target">CircularArray</span></li></ul></li></ul></section><aside class="tsd-sources"> |
| 33 | <ul> |
| cc35cd9c |
34 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7790a49/src/circular-array.ts#L10">src/circular-array.ts:10</a></li></ul></aside> |
| 842d8918 |
35 | <section class="tsd-panel-group tsd-index-group"> |
| 36 | <section class="tsd-panel tsd-index-panel"> |
| 37 | <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"> |
| 38 | <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> |
| 39 | <div class="tsd-accordion-details"> |
| 40 | <section class="tsd-index-section"> |
| 41 | <h3 class="tsd-index-heading">Constructors</h3> |
| 15d6dfaf |
42 | <div class="tsd-index-list"><a href="CircularArray.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>constructor</span></a> |
| 842d8918 |
43 | </div></section> |
| 44 | <section class="tsd-index-section"> |
| 45 | <h3 class="tsd-index-heading">Properties</h3> |
| 15d6dfaf |
46 | <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" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>[unscopables]</span></a> |
| 47 | <a href="CircularArray.html#length-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>length</span></a> |
| 48 | <a href="CircularArray.html#size" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>size</span></a> |
| 49 | <a href="CircularArray.html#_species_" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>[species]</span></a> |
| 842d8918 |
50 | </div></section> |
| 51 | <section class="tsd-index-section"> |
| 52 | <h3 class="tsd-index-heading">Methods</h3> |
| 15d6dfaf |
53 | <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" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>[iterator]</span></a> |
| 54 | <a href="CircularArray.html#at-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>at</span></a> |
| 55 | <a href="CircularArray.html#checkSize" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Size</span></a> |
| 56 | <a href="CircularArray.html#concat-1" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>concat</span></a> |
| 57 | <a href="CircularArray.html#copyWithin-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>copy<wbr/>Within</span></a> |
| 58 | <a href="CircularArray.html#empty" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>empty</span></a> |
| 59 | <a href="CircularArray.html#entries-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>entries</span></a> |
| 60 | <a href="CircularArray.html#every-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>every</span></a> |
| 61 | <a href="CircularArray.html#fill-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>fill</span></a> |
| 62 | <a href="CircularArray.html#filter-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>filter</span></a> |
| 63 | <a href="CircularArray.html#find-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>find</span></a> |
| 64 | <a href="CircularArray.html#findIndex-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>find<wbr/>Index</span></a> |
| 65 | <a href="CircularArray.html#flat-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flat</span></a> |
| 66 | <a href="CircularArray.html#flatMap-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flat<wbr/>Map</span></a> |
| 67 | <a href="CircularArray.html#forEach-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>for<wbr/>Each</span></a> |
| 68 | <a href="CircularArray.html#full" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>full</span></a> |
| 69 | <a href="CircularArray.html#includes-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>includes</span></a> |
| 70 | <a href="CircularArray.html#indexOf-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>index<wbr/>Of</span></a> |
| 71 | <a href="CircularArray.html#join-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>join</span></a> |
| 72 | <a href="CircularArray.html#keys-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>keys</span></a> |
| 73 | <a href="CircularArray.html#lastIndexOf-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>last<wbr/>Index<wbr/>Of</span></a> |
| 74 | <a href="CircularArray.html#map-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>map</span></a> |
| 75 | <a href="CircularArray.html#pop-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pop</span></a> |
| 76 | <a href="CircularArray.html#push-1" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>push</span></a> |
| 77 | <a href="CircularArray.html#reduce-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reduce</span></a> |
| 78 | <a href="CircularArray.html#reduceRight-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reduce<wbr/>Right</span></a> |
| 79 | <a href="CircularArray.html#resize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>resize</span></a> |
| 80 | <a href="CircularArray.html#reverse-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reverse</span></a> |
| 81 | <a href="CircularArray.html#shift-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>shift</span></a> |
| 82 | <a href="CircularArray.html#slice-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>slice</span></a> |
| 83 | <a href="CircularArray.html#some-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>some</span></a> |
| 84 | <a href="CircularArray.html#sort-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sort</span></a> |
| 85 | <a href="CircularArray.html#splice-1" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>splice</span></a> |
| 86 | <a href="CircularArray.html#toLocaleString-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>Locale<wbr/>String</span></a> |
| 87 | <a href="CircularArray.html#toString-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>String</span></a> |
| 88 | <a href="CircularArray.html#unshift-1" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unshift</span></a> |
| 89 | <a href="CircularArray.html#values-1" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>values</span></a> |
| 90 | <a href="CircularArray.html#from" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from</span></a> |
| 91 | <a href="CircularArray.html#isArray" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Array</span></a> |
| 92 | <a href="CircularArray.html#of" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>of</span></a> |
| 842d8918 |
93 | </div></section></div></details></section></section> |
| 94 | <section class="tsd-panel-group tsd-member-group"> |
| 95 | <h2>Constructors</h2> |
| 3bd6a82e |
96 | <section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a> |
| 15d6dfaf |
97 | <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3> |
| 3bd6a82e |
98 | <ul class="tsd-signatures"> |
| 15d6dfaf |
99 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><a href="#constructor.new_CircularArray" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
100 | <li class="tsd-description"> |
| fab6d3b5 |
101 | <section class="tsd-panel"> |
| 842d8918 |
102 | <h4>Type Parameters</h4> |
| fab6d3b5 |
103 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
104 | <li> |
| 3bd6a82e |
105 | <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section> |
| 842d8918 |
106 | <div class="tsd-parameters"> |
| 107 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 108 | <ul class="tsd-parameter-list"> |
| 109 | <li> |
| 3bd6a82e |
110 | <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 |
111 | <li> |
| 323daa7f |
112 | <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><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div> |
| 8d1797ad |
113 | <h4 class="tsd-returns-title">Returns <a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"> |
| 842d8918 |
114 | <p>Overrides Array<T>.constructor</p> |
| 115 | <ul> |
| cc35cd9c |
116 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7790a49/src/circular-array.ts#L13">src/circular-array.ts:13</a></li></ul></aside></li></ul></section></section> |
| 842d8918 |
117 | <section class="tsd-panel-group tsd-member-group"> |
| 118 | <h2>Properties</h2> |
| 3bd6a82e |
119 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_unscopables_" class="tsd-anchor"></a> |
| 15d6dfaf |
120 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad |
121 | <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 |
122 | <div class="tsd-comment tsd-typography"><p>Is an object whose properties have the value 'true' |
| 123 | when they will be absent when used in a 'with' statement.</p> |
| 124 | </div> |
| 125 | <div class="tsd-type-declaration"> |
| 126 | <h4>Type declaration</h4> |
| 127 | <ul class="tsd-parameters"> |
| 128 | <li class="tsd-parameter"> |
| 8d1797ad |
129 | <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 |
130 | <div class="tsd-comment tsd-typography"><p>Is an object whose properties have the value 'true' |
| 131 | when they will be absent when used in a 'with' statement.</p> |
| 15d6dfaf |
132 | </div> |
| 133 | <div class="tsd-comment tsd-typography"></div></li> |
| 842d8918 |
134 | <li class="tsd-parameter"> |
| 8d1797ad |
135 | <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 |
136 | <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> |
| 15d6dfaf |
137 | </div> |
| 138 | <div class="tsd-comment tsd-typography"></div></li></ul></div> |
| 139 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 3bd6a82e |
140 | <p>Inherited from Array.[unscopables]</p> |
| 842d8918 |
141 | <ul> |
| 323daa7f |
142 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97</li></ul></aside></section> |
| 3bd6a82e |
143 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="length-1" class="tsd-anchor"></a> |
| 15d6dfaf |
144 | <h3 class="tsd-anchor-link"><span>length</span><a href="#length-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad |
145 | <div class="tsd-signature"><span class="tsd-kind-property">length</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> |
| 842d8918 |
146 | <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> |
| 15d6dfaf |
147 | </div> |
| 148 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
149 | <p>Inherited from Array.length</p> |
| 150 | <ul> |
| 323daa7f |
151 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1318</li></ul></aside></section> |
| 3bd6a82e |
152 | <section class="tsd-panel tsd-member"><a id="size" class="tsd-anchor"></a> |
| 15d6dfaf |
153 | <h3 class="tsd-anchor-link"><span>size</span><a href="#size" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad |
154 | <div class="tsd-signature"><span class="tsd-kind-property">size</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"> |
| 842d8918 |
155 | <ul> |
| cc35cd9c |
156 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7790a49/src/circular-array.ts#L11">src/circular-array.ts:11</a></li></ul></aside></section> |
| 3bd6a82e |
157 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_species_" class="tsd-anchor"></a> |
| 15d6dfaf |
158 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad |
159 | <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 |
160 | <p>Inherited from Array.[species]</p> |
| 842d8918 |
161 | <ul> |
| 323daa7f |
162 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316</li></ul></aside></section></section> |
| 842d8918 |
163 | <section class="tsd-panel-group tsd-member-group"> |
| 164 | <h2>Methods</h2> |
| 3bd6a82e |
165 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_iterator_-1" class="tsd-anchor"></a> |
| 15d6dfaf |
166 | <h3 class="tsd-anchor-link"><span>[iterator]</span><a href="#_iterator_-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
167 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
168 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><a href="#_iterator_-1._iterator_-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
169 | <li class="tsd-description"> |
| 170 | <div class="tsd-comment tsd-typography"><p>Iterator</p> |
| 171 | </div> |
| 15d6dfaf |
172 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4> |
| 173 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 3bd6a82e |
174 | <p>Inherited from Array.[iterator]</p> |
| 842d8918 |
175 | <ul> |
| 323daa7f |
176 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:58</li></ul></aside></li></ul></section> |
| 3bd6a82e |
177 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="at-1" class="tsd-anchor"></a> |
| 15d6dfaf |
178 | <h3 class="tsd-anchor-link"><span>at</span><a href="#at-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
179 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
180 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
181 | <li class="tsd-description"> |
| 182 | <div class="tsd-comment tsd-typography"><p>Returns the item located at the specified index.</p> |
| 183 | </div> |
| 184 | <div class="tsd-parameters"> |
| 185 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 186 | <ul class="tsd-parameter-list"> |
| 187 | <li> |
| 3bd6a82e |
188 | <h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5> |
| 842d8918 |
189 | <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> |
| 323daa7f |
190 | </div></li></ul></div> |
| 15d6dfaf |
191 | <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> |
| 192 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
193 | <p>Inherited from Array.at</p> |
| 194 | <ul> |
| 323daa7f |
195 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2022.array.d.ts:24</li></ul></aside></li></ul></section> |
| 3bd6a82e |
196 | <section class="tsd-panel tsd-member tsd-is-private"><a id="checkSize" class="tsd-anchor"></a> |
| 15d6dfaf |
197 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
198 | <ul class="tsd-signatures tsd-is-private"> |
| 15d6dfaf |
199 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
200 | <li class="tsd-description"> |
| 201 | <div class="tsd-parameters"> |
| 202 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 203 | <ul class="tsd-parameter-list"> |
| 204 | <li> |
| 3bd6a82e |
205 | <h5><span class="tsd-kind-parameter">size</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div> |
| 842d8918 |
206 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"> |
| 207 | <ul> |
| cc35cd9c |
208 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7790a49/src/circular-array.ts#L100">src/circular-array.ts:100</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
209 | <section class="tsd-panel tsd-member"><a id="concat-1" class="tsd-anchor"></a> |
| 15d6dfaf |
210 | <h3 class="tsd-anchor-link"><span>concat</span><a href="#concat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
211 | <ul class="tsd-signatures"> |
| 15d6dfaf |
212 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><a href="#concat-1.concat-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
213 | <li class="tsd-description"> |
| 214 | <div class="tsd-parameters"> |
| 215 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 216 | <ul class="tsd-parameter-list"> |
| 217 | <li> |
| 323daa7f |
218 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div> |
| 15d6dfaf |
219 | <h4 class="tsd-returns-title">Returns <a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4> |
| 220 | <div class="tsd-comment tsd-typography"> |
| 221 | <h4>Inherit Doc</h4></div><aside class="tsd-sources"> |
| 842d8918 |
222 | <p>Overrides Array.concat</p> |
| 223 | <ul> |
| cc35cd9c |
224 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7790a49/src/circular-array.ts#L41">src/circular-array.ts:41</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
225 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="copyWithin-1" class="tsd-anchor"></a> |
| 15d6dfaf |
226 | <h3 class="tsd-anchor-link"><span>copy<wbr/>Within</span><a href="#copyWithin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
227 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 323daa7f |
228 | <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-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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><a href="#copyWithin-1.copyWithin-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
229 | <li class="tsd-description"> |
| 230 | <div class="tsd-comment tsd-typography"><p>Returns the this object after copying a section of the array identified by start and end |
| 231 | to the same array starting at position target</p> |
| 232 | </div> |
| 233 | <div class="tsd-parameters"> |
| 234 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 235 | <ul class="tsd-parameter-list"> |
| 236 | <li> |
| 3bd6a82e |
237 | <h5><span class="tsd-kind-parameter">target</span>: <span class="tsd-signature-type">number</span></h5> |
| 842d8918 |
238 | <div class="tsd-comment tsd-typography"><p>If target is negative, it is treated as length+target where length is the |
| 239 | length of the array.</p> |
| 323daa7f |
240 | </div></li> |
| 842d8918 |
241 | <li> |
| 323daa7f |
242 | <h5><span class="tsd-kind-parameter">start</span>: <span class="tsd-signature-type">number</span></h5> |
| 842d8918 |
243 | <div class="tsd-comment tsd-typography"><p>If start is negative, it is treated as length+start. If end is negative, it |
| 323daa7f |
244 | is treated as length+end.</p> |
| 245 | </div></li> |
| 842d8918 |
246 | <li> |
| 3bd6a82e |
247 | <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 |
248 | <div class="tsd-comment tsd-typography"><p>If not specified, length of the this object is used as its default value.</p> |
| 323daa7f |
249 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
250 | <h4 class="tsd-returns-title">Returns <a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4> |
| 251 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
252 | <p>Inherited from Array.copyWithin</p> |
| 253 | <ul> |
| 323daa7f |
254 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:62</li></ul></aside></li></ul></section> |
| 3bd6a82e |
255 | <section class="tsd-panel tsd-member"><a id="empty" class="tsd-anchor"></a> |
| 15d6dfaf |
256 | <h3 class="tsd-anchor-link"><span>empty</span><a href="#empty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
257 | <ul class="tsd-signatures"> |
| 15d6dfaf |
258 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
259 | <li class="tsd-description"> |
| 260 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"> |
| 261 | <ul> |
| cc35cd9c |
262 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7790a49/src/circular-array.ts#L92">src/circular-array.ts:92</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
263 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="entries-1" class="tsd-anchor"></a> |
| 15d6dfaf |
264 | <h3 class="tsd-anchor-link"><span>entries</span><a href="#entries-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
265 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
266 | <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"><</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">></span><a href="#entries-1.entries-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
267 | <li class="tsd-description"> |
| 268 | <div class="tsd-comment tsd-typography"><p>Returns an iterable of key, value pairs for every entry in the array</p> |
| 269 | </div> |
| 15d6dfaf |
270 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IterableIterator</span><span class="tsd-signature-symbol"><</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">></span></h4> |
| 271 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
272 | <p>Inherited from Array.entries</p> |
| 273 | <ul> |
| 323daa7f |
274 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:63</li></ul></aside></li></ul></section> |
| 3bd6a82e |
275 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="every-1" class="tsd-anchor"></a> |
| 15d6dfaf |
276 | <h3 class="tsd-anchor-link"><span>every</span><a href="#every-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
277 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
278 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">></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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
279 | <li class="tsd-description"> |
| 280 | <div class="tsd-comment tsd-typography"><p>Determines whether all the members of an array satisfy the specified test.</p> |
| 281 | </div> |
| fab6d3b5 |
282 | <section class="tsd-panel"> |
| 842d8918 |
283 | <h4>Type Parameters</h4> |
| fab6d3b5 |
284 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
285 | <li> |
| 3bd6a82e |
286 | <h4><span class="tsd-kind-type-parameter">S</span></h4></li></ul></section> |
| 842d8918 |
287 | <div class="tsd-parameters"> |
| 288 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 289 | <ul class="tsd-parameter-list"> |
| 290 | <li> |
| fab6d3b5 |
291 | <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"> => </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 |
292 | <div class="tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The every method calls |
| 293 | the predicate function for each element in the array until the predicate returns a value |
| 294 | which is coercible to the Boolean value false, or until the end of the array.</p> |
| 295 | </div> |
| 296 | <ul class="tsd-parameters"> |
| 297 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
298 | <ul class="tsd-signatures tsd-is-external"> |
| fab6d3b5 |
299 | <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 |
300 | <li class="tsd-description"> |
| 301 | <div class="tsd-parameters"> |
| 302 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 303 | <ul class="tsd-parameter-list"> |
| 304 | <li> |
| 3bd6a82e |
305 | <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
306 | <li> |
| 3bd6a82e |
307 | <h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
308 | <li> |
| 3bd6a82e |
309 | <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 |
310 | <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 |
311 | <li> |
| 3bd6a82e |
312 | <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 |
313 | <div class="tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the predicate function. |
| 314 | If thisArg is omitted, undefined is used as the this value.</p> |
| 323daa7f |
315 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
316 | <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> |
| 317 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
318 | <p>Inherited from Array.every</p> |
| 319 | <ul> |
| 323daa7f |
320 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1425</li></ul></aside></li> |
| 15d6dfaf |
321 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
322 | <li class="tsd-description"> |
| 323 | <div class="tsd-comment tsd-typography"><p>Determines whether all the members of an array satisfy the specified test.</p> |
| 324 | </div> |
| 325 | <div class="tsd-parameters"> |
| 326 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 327 | <ul class="tsd-parameter-list"> |
| 328 | <li> |
| 3bd6a82e |
329 | <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"> => </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
330 | <div class="tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The every method calls |
| 331 | the predicate function for each element in the array until the predicate returns a value |
| 332 | which is coercible to the Boolean value false, or until the end of the array.</p> |
| 333 | </div> |
| 334 | <ul class="tsd-parameters"> |
| 335 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
336 | <ul class="tsd-signatures tsd-is-external"> |
| 337 | <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 |
338 | <li class="tsd-description"> |
| 339 | <div class="tsd-parameters"> |
| 340 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 341 | <ul class="tsd-parameter-list"> |
| 342 | <li> |
| 3bd6a82e |
343 | <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
344 | <li> |
| 3bd6a82e |
345 | <h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
346 | <li> |
| 3bd6a82e |
347 | <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 |
348 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></li></ul></li> |
| 349 | <li> |
| 3bd6a82e |
350 | <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 |
351 | <div class="tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the predicate function. |
| 352 | If thisArg is omitted, undefined is used as the this value.</p> |
| 323daa7f |
353 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
354 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> |
| 355 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
356 | <p>Inherited from Array.every</p> |
| 357 | <ul> |
| 323daa7f |
358 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1434</li></ul></aside></li></ul></section> |
| 3bd6a82e |
359 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fill-1" class="tsd-anchor"></a> |
| 15d6dfaf |
360 | <h3 class="tsd-anchor-link"><span>fill</span><a href="#fill-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
361 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
362 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><a href="#fill-1.fill-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
363 | <li class="tsd-description"> |
| 364 | <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> |
| 365 | </div> |
| 366 | <div class="tsd-parameters"> |
| 367 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 368 | <ul class="tsd-parameter-list"> |
| 369 | <li> |
| 3bd6a82e |
370 | <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5> |
| 842d8918 |
371 | <div class="tsd-comment tsd-typography"><p>value to fill array section with</p> |
| 323daa7f |
372 | </div></li> |
| 842d8918 |
373 | <li> |
| 3bd6a82e |
374 | <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 |
375 | <div class="tsd-comment tsd-typography"><p>index to start filling the array at. If start is negative, it is treated as |
| 376 | length+start where length is the length of the array.</p> |
| 323daa7f |
377 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li> |
| 842d8918 |
378 | <li> |
| 3bd6a82e |
379 | <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 |
380 | <div class="tsd-comment tsd-typography"><p>index to stop filling the array at. If end is negative, it is treated as |
| 381 | length+end.</p> |
| 323daa7f |
382 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
383 | <h4 class="tsd-returns-title">Returns <a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4> |
| 384 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
385 | <p>Inherited from Array.fill</p> |
| 386 | <ul> |
| 323daa7f |
387 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:51</li></ul></aside></li></ul></section> |
| 3bd6a82e |
388 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="filter-1" class="tsd-anchor"></a> |
| 15d6dfaf |
389 | <h3 class="tsd-anchor-link"><span>filter</span><a href="#filter-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
390 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
391 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">></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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
392 | <li class="tsd-description"> |
| 393 | <div class="tsd-comment tsd-typography"><p>Returns the elements of an array that meet the condition specified in a callback function.</p> |
| 394 | </div> |
| fab6d3b5 |
395 | <section class="tsd-panel"> |
| 842d8918 |
396 | <h4>Type Parameters</h4> |
| fab6d3b5 |
397 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
398 | <li> |
| 3bd6a82e |
399 | <h4><span class="tsd-kind-type-parameter">S</span></h4></li></ul></section> |
| 842d8918 |
400 | <div class="tsd-parameters"> |
| 401 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 402 | <ul class="tsd-parameter-list"> |
| 403 | <li> |
| fab6d3b5 |
404 | <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"> => </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 |
405 | <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> |
| 406 | </div> |
| 407 | <ul class="tsd-parameters"> |
| 408 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
409 | <ul class="tsd-signatures tsd-is-external"> |
| fab6d3b5 |
410 | <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 |
411 | <li class="tsd-description"> |
| 412 | <div class="tsd-parameters"> |
| 413 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 414 | <ul class="tsd-parameter-list"> |
| 415 | <li> |
| 3bd6a82e |
416 | <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
417 | <li> |
| 3bd6a82e |
418 | <h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
419 | <li> |
| 3bd6a82e |
420 | <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 |
421 | <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 |
422 | <li> |
| 3bd6a82e |
423 | <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 |
424 | <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> |
| 323daa7f |
425 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
426 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">[]</span></h4> |
| 427 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
428 | <p>Inherited from Array.filter</p> |
| 429 | <ul> |
| 323daa7f |
430 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1461</li></ul></aside></li> |
| 15d6dfaf |
431 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
432 | <li class="tsd-description"> |
| 433 | <div class="tsd-comment tsd-typography"><p>Returns the elements of an array that meet the condition specified in a callback function.</p> |
| 434 | </div> |
| 435 | <div class="tsd-parameters"> |
| 436 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 437 | <ul class="tsd-parameter-list"> |
| 438 | <li> |
| 3bd6a82e |
439 | <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"> => </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
440 | <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> |
| 441 | </div> |
| 442 | <ul class="tsd-parameters"> |
| 443 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
444 | <ul class="tsd-signatures tsd-is-external"> |
| 445 | <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 |
446 | <li class="tsd-description"> |
| 447 | <div class="tsd-parameters"> |
| 448 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 449 | <ul class="tsd-parameter-list"> |
| 450 | <li> |
| 3bd6a82e |
451 | <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
452 | <li> |
| 3bd6a82e |
453 | <h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
454 | <li> |
| 3bd6a82e |
455 | <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 |
456 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></li></ul></li> |
| 457 | <li> |
| 3bd6a82e |
458 | <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 |
459 | <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> |
| 323daa7f |
460 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
461 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4> |
| 462 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
463 | <p>Inherited from Array.filter</p> |
| 464 | <ul> |
| 323daa7f |
465 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1467</li></ul></aside></li></ul></section> |
| 3bd6a82e |
466 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="find-1" class="tsd-anchor"></a> |
| 15d6dfaf |
467 | <h3 class="tsd-anchor-link"><span>find</span><a href="#find-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
468 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
469 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">></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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
470 | <li class="tsd-description"> |
| 471 | <div class="tsd-comment tsd-typography"><p>Returns the value of the first element in the array where predicate is true, and undefined |
| 472 | otherwise.</p> |
| 473 | </div> |
| fab6d3b5 |
474 | <section class="tsd-panel"> |
| 842d8918 |
475 | <h4>Type Parameters</h4> |
| fab6d3b5 |
476 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
477 | <li> |
| 3bd6a82e |
478 | <h4><span class="tsd-kind-type-parameter">S</span></h4></li></ul></section> |
| 842d8918 |
479 | <div class="tsd-parameters"> |
| 480 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 481 | <ul class="tsd-parameter-list"> |
| 482 | <li> |
| fab6d3b5 |
483 | <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"> => </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 |
484 | <div class="tsd-comment tsd-typography"><p>find calls predicate once for each element of the array, in ascending |
| 485 | order, until it finds one where predicate returns true. If such an element is found, find |
| 486 | immediately returns that element value. Otherwise, find returns undefined.</p> |
| 487 | </div> |
| 488 | <ul class="tsd-parameters"> |
| 489 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
490 | <ul class="tsd-signatures tsd-is-external"> |
| fab6d3b5 |
491 | <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 |
492 | <li class="tsd-description"> |
| 493 | <div class="tsd-parameters"> |
| 494 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 495 | <ul class="tsd-parameter-list"> |
| 496 | <li> |
| 3bd6a82e |
497 | <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
498 | <li> |
| 3bd6a82e |
499 | <h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
500 | <li> |
| 3bd6a82e |
501 | <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 |
502 | <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 |
503 | <li> |
| 3bd6a82e |
504 | <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 |
505 | <div class="tsd-comment tsd-typography"><p>If provided, it will be used as the this value for each invocation of |
| 506 | predicate. If it is not provided, undefined is used instead.</p> |
| 323daa7f |
507 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
508 | <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> |
| 509 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
510 | <p>Inherited from Array.find</p> |
| 511 | <ul> |
| 323daa7f |
512 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:29</li></ul></aside></li> |
| 15d6dfaf |
513 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
514 | <li class="tsd-description"> |
| 515 | <div class="tsd-parameters"> |
| 516 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 517 | <ul class="tsd-parameter-list"> |
| 518 | <li> |
| 3bd6a82e |
519 | <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"> => </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
520 | <ul class="tsd-parameters"> |
| 521 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
522 | <ul class="tsd-signatures tsd-is-external"> |
| 523 | <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 |
524 | <li class="tsd-description"> |
| 525 | <div class="tsd-parameters"> |
| 526 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 527 | <ul class="tsd-parameter-list"> |
| 528 | <li> |
| 3bd6a82e |
529 | <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
530 | <li> |
| 3bd6a82e |
531 | <h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
532 | <li> |
| 3bd6a82e |
533 | <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 |
534 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></li></ul></li> |
| 535 | <li> |
| 323daa7f |
536 | <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">thisArg</span>: <span class="tsd-signature-type">any</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 3bd6a82e |
537 | <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 |
538 | <p>Inherited from Array.find</p> |
| 539 | <ul> |
| 323daa7f |
540 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:30</li></ul></aside></li></ul></section> |
| 3bd6a82e |
541 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="findIndex-1" class="tsd-anchor"></a> |
| 15d6dfaf |
542 | <h3 class="tsd-anchor-link"><span>find<wbr/>Index</span><a href="#findIndex-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
543 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
544 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
545 | <li class="tsd-description"> |
| 546 | <div class="tsd-comment tsd-typography"><p>Returns the index of the first element in the array where predicate is true, and -1 |
| 547 | otherwise.</p> |
| 548 | </div> |
| 549 | <div class="tsd-parameters"> |
| 550 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 551 | <ul class="tsd-parameter-list"> |
| 552 | <li> |
| 3bd6a82e |
553 | <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"> => </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
554 | <div class="tsd-comment tsd-typography"><p>find calls predicate once for each element of the array, in ascending |
| 555 | order, until it finds one where predicate returns true. If such an element is found, |
| 556 | findIndex immediately returns that element index. Otherwise, findIndex returns -1.</p> |
| 557 | </div> |
| 558 | <ul class="tsd-parameters"> |
| 559 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
560 | <ul class="tsd-signatures tsd-is-external"> |
| 561 | <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 |
562 | <li class="tsd-description"> |
| 563 | <div class="tsd-parameters"> |
| 564 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 565 | <ul class="tsd-parameter-list"> |
| 566 | <li> |
| 3bd6a82e |
567 | <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
568 | <li> |
| 3bd6a82e |
569 | <h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
570 | <li> |
| 3bd6a82e |
571 | <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 |
572 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></li></ul></li> |
| 573 | <li> |
| 3bd6a82e |
574 | <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 |
575 | <div class="tsd-comment tsd-typography"><p>If provided, it will be used as the this value for each invocation of |
| 576 | predicate. If it is not provided, undefined is used instead.</p> |
| 323daa7f |
577 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
578 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> |
| 579 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
580 | <p>Inherited from Array.findIndex</p> |
| 581 | <ul> |
| 323daa7f |
582 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:41</li></ul></aside></li></ul></section> |
| 3bd6a82e |
583 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="flat-1" class="tsd-anchor"></a> |
| 15d6dfaf |
584 | <h3 class="tsd-anchor-link"><span>flat</span><a href="#flat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
585 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
586 | <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"><</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">></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"><</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">></span><span class="tsd-signature-symbol">[]</span><a href="#flat-1.flat-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
587 | <li class="tsd-description"> |
| 588 | <div class="tsd-comment tsd-typography"><p>Returns a new array with all sub-array elements concatenated into it recursively up to the |
| 589 | specified depth.</p> |
| 590 | </div> |
| fab6d3b5 |
591 | <section class="tsd-panel"> |
| 842d8918 |
592 | <h4>Type Parameters</h4> |
| fab6d3b5 |
593 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
594 | <li> |
| 3bd6a82e |
595 | <h4><span class="tsd-kind-type-parameter">A</span></h4></li> |
| 842d8918 |
596 | <li> |
| 3bd6a82e |
597 | <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 |
598 | <div class="tsd-parameters"> |
| 599 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 600 | <ul class="tsd-parameter-list"> |
| 601 | <li> |
| 3bd6a82e |
602 | <h5><span class="tsd-kind-parameter">this</span>: <span class="tsd-signature-type tsd-kind-type-parameter">A</span></h5></li> |
| 842d8918 |
603 | <li> |
| 3bd6a82e |
604 | <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 |
605 | <div class="tsd-comment tsd-typography"><p>The maximum recursion depth</p> |
| 323daa7f |
606 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
607 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">FlatArray</span><span class="tsd-signature-symbol"><</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">></span><span class="tsd-signature-symbol">[]</span></h4> |
| 608 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
609 | <p>Inherited from Array.flat</p> |
| 610 | <ul> |
| 323daa7f |
611 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2019.array.d.ts:79</li></ul></aside></li></ul></section> |
| 3bd6a82e |
612 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="flatMap-1" class="tsd-anchor"></a> |
| 15d6dfaf |
613 | <h3 class="tsd-anchor-link"><span>flat<wbr/>Map</span><a href="#flatMap-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
614 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
615 | <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"><</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">></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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
616 | <li class="tsd-description"> |
| 617 | <div class="tsd-comment tsd-typography"><p>Calls a defined callback function on each element of an array. Then, flattens the result into |
| 618 | a new array. |
| 619 | This is identical to a map followed by flat with depth 1.</p> |
| 620 | </div> |
| fab6d3b5 |
621 | <section class="tsd-panel"> |
| 842d8918 |
622 | <h4>Type Parameters</h4> |
| fab6d3b5 |
623 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
624 | <li> |
| 3bd6a82e |
625 | <h4><span class="tsd-kind-type-parameter">U</span></h4></li> |
| 842d8918 |
626 | <li> |
| 3bd6a82e |
627 | <h4><span class="tsd-kind-type-parameter">This</span> = <span class="tsd-signature-type">undefined</span></h4></li></ul></section> |
| 842d8918 |
628 | <div class="tsd-parameters"> |
| 629 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 630 | <ul class="tsd-parameter-list"> |
| 631 | <li> |
| 3bd6a82e |
632 | <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"> => </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 |
633 | <div class="tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The flatMap method calls the |
| 634 | callback function one time for each element in the array.</p> |
| 635 | </div> |
| 636 | <ul class="tsd-parameters"> |
| 637 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
638 | <ul class="tsd-signatures tsd-is-external"> |
| 639 | <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 |
640 | <li class="tsd-description"> |
| 641 | <div class="tsd-parameters"> |
| 642 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 643 | <ul class="tsd-parameter-list"> |
| 644 | <li> |
| 3bd6a82e |
645 | <h5><span class="tsd-kind-parameter">this</span>: <span class="tsd-signature-type tsd-kind-type-parameter">This</span></h5></li> |
| 842d8918 |
646 | <li> |
| 3bd6a82e |
647 | <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
648 | <li> |
| 3bd6a82e |
649 | <h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
650 | <li> |
| 3bd6a82e |
651 | <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> |
| 652 | <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 |
653 | <li> |
| 3bd6a82e |
654 | <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 |
655 | <div class="tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the callback function. If |
| 656 | thisArg is omitted, undefined is used as the this value.</p> |
| 323daa7f |
657 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
658 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span></h4> |
| 659 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
660 | <p>Inherited from Array.flatMap</p> |
| 661 | <ul> |
| 323daa7f |
662 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2019.array.d.ts:68</li></ul></aside></li></ul></section> |
| 3bd6a82e |
663 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="forEach-1" class="tsd-anchor"></a> |
| 15d6dfaf |
664 | <h3 class="tsd-anchor-link"><span>for<wbr/>Each</span><a href="#forEach-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
665 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
666 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
667 | <li class="tsd-description"> |
| 668 | <div class="tsd-comment tsd-typography"><p>Performs the specified action for each element in an array.</p> |
| 669 | </div> |
| 670 | <div class="tsd-parameters"> |
| 671 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 672 | <ul class="tsd-parameter-list"> |
| 673 | <li> |
| 3bd6a82e |
674 | <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"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
675 | <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> |
| 676 | </div> |
| 677 | <ul class="tsd-parameters"> |
| 678 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
679 | <ul class="tsd-signatures tsd-is-external"> |
| 680 | <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 |
681 | <li class="tsd-description"> |
| 682 | <div class="tsd-parameters"> |
| 683 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 684 | <ul class="tsd-parameter-list"> |
| 685 | <li> |
| 3bd6a82e |
686 | <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
687 | <li> |
| 3bd6a82e |
688 | <h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
689 | <li> |
| 3bd6a82e |
690 | <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 |
691 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li> |
| 692 | <li> |
| 3bd6a82e |
693 | <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 |
694 | <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> |
| 323daa7f |
695 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
696 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 697 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
698 | <p>Inherited from Array.forEach</p> |
| 699 | <ul> |
| 323daa7f |
700 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1449</li></ul></aside></li></ul></section> |
| 3bd6a82e |
701 | <section class="tsd-panel tsd-member"><a id="full" class="tsd-anchor"></a> |
| 15d6dfaf |
702 | <h3 class="tsd-anchor-link"><span>full</span><a href="#full" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
703 | <ul class="tsd-signatures"> |
| 15d6dfaf |
704 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
705 | <li class="tsd-description"> |
| 706 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"> |
| 707 | <ul> |
| cc35cd9c |
708 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7790a49/src/circular-array.ts#L96">src/circular-array.ts:96</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
709 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="includes-1" class="tsd-anchor"></a> |
| 15d6dfaf |
710 | <h3 class="tsd-anchor-link"><span>includes</span><a href="#includes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
711 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
712 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
713 | <li class="tsd-description"> |
| 714 | <div class="tsd-comment tsd-typography"><p>Determines whether an array includes a certain element, returning true or false as appropriate.</p> |
| 715 | </div> |
| 716 | <div class="tsd-parameters"> |
| 717 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 718 | <ul class="tsd-parameter-list"> |
| 719 | <li> |
| 3bd6a82e |
720 | <h5><span class="tsd-kind-parameter">searchElement</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5> |
| 842d8918 |
721 | <div class="tsd-comment tsd-typography"><p>The element to search for.</p> |
| 323daa7f |
722 | </div></li> |
| 842d8918 |
723 | <li> |
| 3bd6a82e |
724 | <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 |
725 | <div class="tsd-comment tsd-typography"><p>The position in this array at which to begin searching for searchElement.</p> |
| 323daa7f |
726 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
727 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> |
| 728 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
729 | <p>Inherited from Array.includes</p> |
| 730 | <ul> |
| 323daa7f |
731 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2016.array.include.d.ts:25</li></ul></aside></li></ul></section> |
| 3bd6a82e |
732 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="indexOf-1" class="tsd-anchor"></a> |
| 15d6dfaf |
733 | <h3 class="tsd-anchor-link"><span>index<wbr/>Of</span><a href="#indexOf-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
734 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
735 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
736 | <li class="tsd-description"> |
| 737 | <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> |
| 738 | </div> |
| 739 | <div class="tsd-parameters"> |
| 740 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 741 | <ul class="tsd-parameter-list"> |
| 742 | <li> |
| 3bd6a82e |
743 | <h5><span class="tsd-kind-parameter">searchElement</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5> |
| 842d8918 |
744 | <div class="tsd-comment tsd-typography"><p>The value to locate in the array.</p> |
| 323daa7f |
745 | </div></li> |
| 842d8918 |
746 | <li> |
| 3bd6a82e |
747 | <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 |
748 | <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> |
| 323daa7f |
749 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
750 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> |
| 751 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
752 | <p>Inherited from Array.indexOf</p> |
| 753 | <ul> |
| 323daa7f |
754 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1410</li></ul></aside></li></ul></section> |
| 3bd6a82e |
755 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="join-1" class="tsd-anchor"></a> |
| 15d6dfaf |
756 | <h3 class="tsd-anchor-link"><span>join</span><a href="#join-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
757 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
758 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
759 | <li class="tsd-description"> |
| 760 | <div class="tsd-comment tsd-typography"><p>Adds all the elements of an array into a string, separated by the specified separator string.</p> |
| 761 | </div> |
| 762 | <div class="tsd-parameters"> |
| 763 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 764 | <ul class="tsd-parameter-list"> |
| 765 | <li> |
| 3bd6a82e |
766 | <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 |
767 | <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> |
| 323daa7f |
768 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
769 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> |
| 770 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
771 | <p>Inherited from Array.join</p> |
| 772 | <ul> |
| 323daa7f |
773 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1353</li></ul></aside></li></ul></section> |
| 3bd6a82e |
774 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="keys-1" class="tsd-anchor"></a> |
| 15d6dfaf |
775 | <h3 class="tsd-anchor-link"><span>keys</span><a href="#keys-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
776 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
777 | <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"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#keys-1.keys-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
778 | <li class="tsd-description"> |
| 779 | <div class="tsd-comment tsd-typography"><p>Returns an iterable of keys in the array</p> |
| 780 | </div> |
| 15d6dfaf |
781 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4> |
| 782 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
783 | <p>Inherited from Array.keys</p> |
| 784 | <ul> |
| 323daa7f |
785 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:68</li></ul></aside></li></ul></section> |
| 3bd6a82e |
786 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="lastIndexOf-1" class="tsd-anchor"></a> |
| 15d6dfaf |
787 | <h3 class="tsd-anchor-link"><span>last<wbr/>Index<wbr/>Of</span><a href="#lastIndexOf-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
788 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
789 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
790 | <li class="tsd-description"> |
| 791 | <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> |
| 792 | </div> |
| 793 | <div class="tsd-parameters"> |
| 794 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 795 | <ul class="tsd-parameter-list"> |
| 796 | <li> |
| 3bd6a82e |
797 | <h5><span class="tsd-kind-parameter">searchElement</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5> |
| 842d8918 |
798 | <div class="tsd-comment tsd-typography"><p>The value to locate in the array.</p> |
| 323daa7f |
799 | </div></li> |
| 842d8918 |
800 | <li> |
| 3bd6a82e |
801 | <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 |
802 | <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> |
| 323daa7f |
803 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
804 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> |
| 805 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
806 | <p>Inherited from Array.lastIndexOf</p> |
| 807 | <ul> |
| 323daa7f |
808 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1416</li></ul></aside></li></ul></section> |
| 3bd6a82e |
809 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="map-1" class="tsd-anchor"></a> |
| 15d6dfaf |
810 | <h3 class="tsd-anchor-link"><span>map</span><a href="#map-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
811 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
812 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">></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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
813 | <li class="tsd-description"> |
| 814 | <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> |
| 815 | </div> |
| fab6d3b5 |
816 | <section class="tsd-panel"> |
| 842d8918 |
817 | <h4>Type Parameters</h4> |
| fab6d3b5 |
818 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
819 | <li> |
| 3bd6a82e |
820 | <h4><span class="tsd-kind-type-parameter">U</span></h4></li></ul></section> |
| 842d8918 |
821 | <div class="tsd-parameters"> |
| 822 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 823 | <ul class="tsd-parameter-list"> |
| 824 | <li> |
| 3bd6a82e |
825 | <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"> => </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
826 | <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> |
| 827 | </div> |
| 828 | <ul class="tsd-parameters"> |
| 829 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
830 | <ul class="tsd-signatures tsd-is-external"> |
| 831 | <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 |
832 | <li class="tsd-description"> |
| 833 | <div class="tsd-parameters"> |
| 834 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 835 | <ul class="tsd-parameter-list"> |
| 836 | <li> |
| 3bd6a82e |
837 | <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
838 | <li> |
| 3bd6a82e |
839 | <h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
840 | <li> |
| 3bd6a82e |
841 | <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> |
| 842 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4></li></ul></li></ul></li> |
| 842d8918 |
843 | <li> |
| 3bd6a82e |
844 | <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 |
845 | <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> |
| 323daa7f |
846 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
847 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span></h4> |
| 848 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
849 | <p>Inherited from Array.map</p> |
| 850 | <ul> |
| 323daa7f |
851 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1455</li></ul></aside></li></ul></section> |
| 3bd6a82e |
852 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pop-1" class="tsd-anchor"></a> |
| 15d6dfaf |
853 | <h3 class="tsd-anchor-link"><span>pop</span><a href="#pop-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
854 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
855 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
856 | <li class="tsd-description"> |
| 857 | <div class="tsd-comment tsd-typography"><p>Removes the last element from an array and returns it. |
| 858 | If the array is empty, undefined is returned and the array is not modified.</p> |
| 859 | </div> |
| 15d6dfaf |
860 | <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> |
| 861 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
862 | <p>Inherited from Array.pop</p> |
| 863 | <ul> |
| 323daa7f |
864 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1331</li></ul></aside></li></ul></section> |
| 3bd6a82e |
865 | <section class="tsd-panel tsd-member"><a id="push-1" class="tsd-anchor"></a> |
| 15d6dfaf |
866 | <h3 class="tsd-anchor-link"><span>push</span><a href="#push-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
867 | <ul class="tsd-signatures"> |
| 15d6dfaf |
868 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
869 | <li class="tsd-description"> |
| 870 | <div class="tsd-parameters"> |
| 871 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 872 | <ul class="tsd-parameter-list"> |
| 873 | <li> |
| 323daa7f |
874 | <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><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div> |
| 15d6dfaf |
875 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> |
| 876 | <div class="tsd-comment tsd-typography"> |
| 877 | <h4>Inherit Doc</h4></div><aside class="tsd-sources"> |
| 842d8918 |
878 | <p>Overrides Array.push</p> |
| 879 | <ul> |
| cc35cd9c |
880 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7790a49/src/circular-array.ts#L23">src/circular-array.ts:23</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
881 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="reduce-1" class="tsd-anchor"></a> |
| 15d6dfaf |
882 | <h3 class="tsd-anchor-link"><span>reduce</span><a href="#reduce-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
883 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
884 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
885 | <li class="tsd-description"> |
| 886 | <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> |
| 887 | </div> |
| 888 | <div class="tsd-parameters"> |
| 889 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 890 | <ul class="tsd-parameter-list"> |
| 891 | <li> |
| 3bd6a82e |
892 | <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"> => </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
893 | <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> |
| 894 | </div> |
| 895 | <ul class="tsd-parameters"> |
| 896 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
897 | <ul class="tsd-signatures tsd-is-external"> |
| 898 | <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 |
899 | <li class="tsd-description"> |
| 900 | <div class="tsd-parameters"> |
| 901 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 902 | <ul class="tsd-parameter-list"> |
| 903 | <li> |
| 3bd6a82e |
904 | <h5><span class="tsd-kind-parameter">previousValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
905 | <li> |
| 3bd6a82e |
906 | <h5><span class="tsd-kind-parameter">currentValue</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">currentIndex</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
909 | <li> |
| 3bd6a82e |
910 | <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> |
| 911 | <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> |
| 15d6dfaf |
912 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4> |
| 913 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
914 | <p>Inherited from Array.reduce</p> |
| 915 | <ul> |
| 323daa7f |
916 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1473</li></ul></aside></li> |
| 15d6dfaf |
917 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
918 | <li class="tsd-description"> |
| 919 | <div class="tsd-parameters"> |
| 920 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 921 | <ul class="tsd-parameter-list"> |
| 922 | <li> |
| 3bd6a82e |
923 | <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"> => </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
924 | <ul class="tsd-parameters"> |
| 925 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
926 | <ul class="tsd-signatures tsd-is-external"> |
| 927 | <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 |
928 | <li class="tsd-description"> |
| 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">previousValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
934 | <li> |
| 3bd6a82e |
935 | <h5><span class="tsd-kind-parameter">currentValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
936 | <li> |
| 3bd6a82e |
937 | <h5><span class="tsd-kind-parameter">currentIndex</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
938 | <li> |
| 3bd6a82e |
939 | <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> |
| 940 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4></li></ul></li></ul></li> |
| 842d8918 |
941 | <li> |
| 3bd6a82e |
942 | <h5><span class="tsd-kind-parameter">initialValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div> |
| 943 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><aside class="tsd-sources"> |
| 842d8918 |
944 | <p>Inherited from Array.reduce</p> |
| 945 | <ul> |
| 323daa7f |
946 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1474</li></ul></aside></li> |
| 15d6dfaf |
947 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">></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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
948 | <li class="tsd-description"> |
| 949 | <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> |
| 950 | </div> |
| fab6d3b5 |
951 | <section class="tsd-panel"> |
| 842d8918 |
952 | <h4>Type Parameters</h4> |
| fab6d3b5 |
953 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
954 | <li> |
| 3bd6a82e |
955 | <h4><span class="tsd-kind-type-parameter">U</span></h4></li></ul></section> |
| 842d8918 |
956 | <div class="tsd-parameters"> |
| 957 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 958 | <ul class="tsd-parameter-list"> |
| 959 | <li> |
| 3bd6a82e |
960 | <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"> => </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
961 | <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> |
| 962 | </div> |
| 963 | <ul class="tsd-parameters"> |
| 964 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
965 | <ul class="tsd-signatures tsd-is-external"> |
| 966 | <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 |
967 | <li class="tsd-description"> |
| 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">previousValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h5></li> |
| 842d8918 |
973 | <li> |
| 3bd6a82e |
974 | <h5><span class="tsd-kind-parameter">currentValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
975 | <li> |
| 3bd6a82e |
976 | <h5><span class="tsd-kind-parameter">currentIndex</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
977 | <li> |
| 3bd6a82e |
978 | <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> |
| 979 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4></li></ul></li></ul></li> |
| 842d8918 |
980 | <li> |
| 3bd6a82e |
981 | <h5><span class="tsd-kind-parameter">initialValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h5> |
| 842d8918 |
982 | <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> |
| 323daa7f |
983 | </div></li></ul></div> |
| 15d6dfaf |
984 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4> |
| 985 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
986 | <p>Inherited from Array.reduce</p> |
| 987 | <ul> |
| 323daa7f |
988 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1480</li></ul></aside></li></ul></section> |
| 3bd6a82e |
989 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="reduceRight-1" class="tsd-anchor"></a> |
| 15d6dfaf |
990 | <h3 class="tsd-anchor-link"><span>reduce<wbr/>Right</span><a href="#reduceRight-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
991 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
992 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
993 | <li class="tsd-description"> |
| 994 | <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> |
| 995 | </div> |
| 996 | <div class="tsd-parameters"> |
| 997 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 998 | <ul class="tsd-parameter-list"> |
| 999 | <li> |
| 3bd6a82e |
1000 | <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"> => </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
1001 | <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> |
| 1002 | </div> |
| 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></ul></div> |
| 15d6dfaf |
1020 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4> |
| 1021 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1022 | <p>Inherited from Array.reduceRight</p> |
| 1023 | <ul> |
| 323daa7f |
1024 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1486</li></ul></aside></li> |
| 15d6dfaf |
1025 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1026 | <li class="tsd-description"> |
| 1027 | <div class="tsd-parameters"> |
| 1028 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1029 | <ul class="tsd-parameter-list"> |
| 1030 | <li> |
| 3bd6a82e |
1031 | <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"> => </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
1032 | <ul class="tsd-parameters"> |
| 1033 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
1034 | <ul class="tsd-signatures tsd-is-external"> |
| 1035 | <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 |
1036 | <li class="tsd-description"> |
| 1037 | <div class="tsd-parameters"> |
| 1038 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1039 | <ul class="tsd-parameter-list"> |
| 1040 | <li> |
| 3bd6a82e |
1041 | <h5><span class="tsd-kind-parameter">previousValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
1042 | <li> |
| 3bd6a82e |
1043 | <h5><span class="tsd-kind-parameter">currentValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
1044 | <li> |
| 3bd6a82e |
1045 | <h5><span class="tsd-kind-parameter">currentIndex</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
1046 | <li> |
| 3bd6a82e |
1047 | <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> |
| 1048 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4></li></ul></li></ul></li> |
| 842d8918 |
1049 | <li> |
| 3bd6a82e |
1050 | <h5><span class="tsd-kind-parameter">initialValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div> |
| 1051 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><aside class="tsd-sources"> |
| 842d8918 |
1052 | <p>Inherited from Array.reduceRight</p> |
| 1053 | <ul> |
| 323daa7f |
1054 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1487</li></ul></aside></li> |
| 15d6dfaf |
1055 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">></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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1056 | <li class="tsd-description"> |
| 1057 | <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> |
| 1058 | </div> |
| fab6d3b5 |
1059 | <section class="tsd-panel"> |
| 842d8918 |
1060 | <h4>Type Parameters</h4> |
| fab6d3b5 |
1061 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
1062 | <li> |
| 3bd6a82e |
1063 | <h4><span class="tsd-kind-type-parameter">U</span></h4></li></ul></section> |
| 842d8918 |
1064 | <div class="tsd-parameters"> |
| 1065 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1066 | <ul class="tsd-parameter-list"> |
| 1067 | <li> |
| 3bd6a82e |
1068 | <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"> => </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
1069 | <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> |
| 1070 | </div> |
| 1071 | <ul class="tsd-parameters"> |
| 1072 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
1073 | <ul class="tsd-signatures tsd-is-external"> |
| 1074 | <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 |
1075 | <li class="tsd-description"> |
| 1076 | <div class="tsd-parameters"> |
| 1077 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1078 | <ul class="tsd-parameter-list"> |
| 1079 | <li> |
| 3bd6a82e |
1080 | <h5><span class="tsd-kind-parameter">previousValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h5></li> |
| 842d8918 |
1081 | <li> |
| 3bd6a82e |
1082 | <h5><span class="tsd-kind-parameter">currentValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
1083 | <li> |
| 3bd6a82e |
1084 | <h5><span class="tsd-kind-parameter">currentIndex</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
1085 | <li> |
| 3bd6a82e |
1086 | <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> |
| 1087 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4></li></ul></li></ul></li> |
| 842d8918 |
1088 | <li> |
| 3bd6a82e |
1089 | <h5><span class="tsd-kind-parameter">initialValue</span>: <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h5> |
| 842d8918 |
1090 | <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> |
| 323daa7f |
1091 | </div></li></ul></div> |
| 15d6dfaf |
1092 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4> |
| 1093 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1094 | <p>Inherited from Array.reduceRight</p> |
| 1095 | <ul> |
| 323daa7f |
1096 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1493</li></ul></aside></li></ul></section> |
| 3bd6a82e |
1097 | <section class="tsd-panel tsd-member"><a id="resize" class="tsd-anchor"></a> |
| 15d6dfaf |
1098 | <h3 class="tsd-anchor-link"><span>resize</span><a href="#resize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1099 | <ul class="tsd-signatures"> |
| 15d6dfaf |
1100 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1101 | <li class="tsd-description"> |
| 1102 | <div class="tsd-parameters"> |
| 1103 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1104 | <ul class="tsd-parameter-list"> |
| 1105 | <li> |
| 3bd6a82e |
1106 | <h5><span class="tsd-kind-parameter">size</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div> |
| 842d8918 |
1107 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"> |
| 1108 | <ul> |
| cc35cd9c |
1109 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7790a49/src/circular-array.ts#L80">src/circular-array.ts:80</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
1110 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="reverse-1" class="tsd-anchor"></a> |
| 15d6dfaf |
1111 | <h3 class="tsd-anchor-link"><span>reverse</span><a href="#reverse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1112 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
1113 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1114 | <li class="tsd-description"> |
| 1115 | <div class="tsd-comment tsd-typography"><p>Reverses the elements in an array in place. |
| 1116 | This method mutates the array and returns a reference to the same array.</p> |
| 1117 | </div> |
| 15d6dfaf |
1118 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4> |
| 1119 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1120 | <p>Inherited from Array.reverse</p> |
| 1121 | <ul> |
| 323daa7f |
1122 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1358</li></ul></aside></li></ul></section> |
| 3bd6a82e |
1123 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="shift-1" class="tsd-anchor"></a> |
| 15d6dfaf |
1124 | <h3 class="tsd-anchor-link"><span>shift</span><a href="#shift-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1125 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
1126 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1127 | <li class="tsd-description"> |
| 1128 | <div class="tsd-comment tsd-typography"><p>Removes the first element from an array and returns it. |
| 1129 | If the array is empty, undefined is returned and the array is not modified.</p> |
| 1130 | </div> |
| 15d6dfaf |
1131 | <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> |
| 1132 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1133 | <p>Inherited from Array.shift</p> |
| 1134 | <ul> |
| 323daa7f |
1135 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1363</li></ul></aside></li></ul></section> |
| 3bd6a82e |
1136 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="slice-1" class="tsd-anchor"></a> |
| 15d6dfaf |
1137 | <h3 class="tsd-anchor-link"><span>slice</span><a href="#slice-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1138 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
1139 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1140 | <li class="tsd-description"> |
| 1141 | <div class="tsd-comment tsd-typography"><p>Returns a copy of a section of an array. |
| 1142 | For both start and end, a negative index can be used to indicate an offset from the end of the array. |
| 1143 | For example, -2 refers to the second to last element of the array.</p> |
| 1144 | </div> |
| 1145 | <div class="tsd-parameters"> |
| 1146 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1147 | <ul class="tsd-parameter-list"> |
| 1148 | <li> |
| 3bd6a82e |
1149 | <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 |
1150 | <div class="tsd-comment tsd-typography"><p>The beginning index of the specified portion of the array. |
| 1151 | If start is undefined, then the slice begins at index 0.</p> |
| 323daa7f |
1152 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li> |
| 842d8918 |
1153 | <li> |
| 3bd6a82e |
1154 | <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 |
1155 | <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 'end'. |
| 1156 | If end is undefined, then the slice extends to the end of the array.</p> |
| 323daa7f |
1157 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
1158 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4> |
| 1159 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1160 | <p>Inherited from Array.slice</p> |
| 1161 | <ul> |
| 323daa7f |
1162 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1373</li></ul></aside></li></ul></section> |
| 3bd6a82e |
1163 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="some-1" class="tsd-anchor"></a> |
| 15d6dfaf |
1164 | <h3 class="tsd-anchor-link"><span>some</span><a href="#some-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1165 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
1166 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1167 | <li class="tsd-description"> |
| 1168 | <div class="tsd-comment tsd-typography"><p>Determines whether the specified callback function returns true for any element of an array.</p> |
| 1169 | </div> |
| 1170 | <div class="tsd-parameters"> |
| 1171 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1172 | <ul class="tsd-parameter-list"> |
| 1173 | <li> |
| 3bd6a82e |
1174 | <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"> => </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
1175 | <div class="tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The some method calls |
| 1176 | the predicate function for each element in the array until the predicate returns a value |
| 1177 | which is coercible to the Boolean value true, or until the end of the array.</p> |
| 1178 | </div> |
| 1179 | <ul class="tsd-parameters"> |
| 1180 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
1181 | <ul class="tsd-signatures tsd-is-external"> |
| 1182 | <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 |
1183 | <li class="tsd-description"> |
| 1184 | <div class="tsd-parameters"> |
| 1185 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1186 | <ul class="tsd-parameter-list"> |
| 1187 | <li> |
| 3bd6a82e |
1188 | <h5><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
1189 | <li> |
| 3bd6a82e |
1190 | <h5><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
1191 | <li> |
| 3bd6a82e |
1192 | <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 |
1193 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></li></ul></li> |
| 1194 | <li> |
| 3bd6a82e |
1195 | <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 |
1196 | <div class="tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the predicate function. |
| 1197 | If thisArg is omitted, undefined is used as the this value.</p> |
| 323daa7f |
1198 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
1199 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> |
| 1200 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1201 | <p>Inherited from Array.some</p> |
| 1202 | <ul> |
| 323daa7f |
1203 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1443</li></ul></aside></li></ul></section> |
| 3bd6a82e |
1204 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="sort-1" class="tsd-anchor"></a> |
| 15d6dfaf |
1205 | <h3 class="tsd-anchor-link"><span>sort</span><a href="#sort-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1206 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
1207 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><a href="#sort-1.sort-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1208 | <li class="tsd-description"> |
| 1209 | <div class="tsd-comment tsd-typography"><p>Sorts an array in place. |
| 1210 | This method mutates the array and returns a reference to the same array.</p> |
| 1211 | </div> |
| 1212 | <div class="tsd-parameters"> |
| 1213 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1214 | <ul class="tsd-parameter-list"> |
| 1215 | <li> |
| 3bd6a82e |
1216 | <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"> => </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
1217 | <div class="tsd-comment tsd-typography"><p>Function used to determine the order of the elements. It is expected to return |
| 1218 | a negative value if the first argument is less than the second argument, zero if they're equal, and a positive |
| 1219 | value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.</p> |
| 1220 | <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">=></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 |
1221 | </code><button>Copy</button></pre> |
| 323daa7f |
1222 | </div><code class="tsd-tag ts-flagOptional">Optional</code> |
| 842d8918 |
1223 | <ul class="tsd-parameters"> |
| 1224 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
1225 | <ul class="tsd-signatures tsd-is-external"> |
| 1226 | <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 |
1227 | <li class="tsd-description"> |
| 1228 | <div class="tsd-parameters"> |
| 1229 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1230 | <ul class="tsd-parameter-list"> |
| 1231 | <li> |
| 3bd6a82e |
1232 | <h5><span class="tsd-kind-parameter">a</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
1233 | <li> |
| 3bd6a82e |
1234 | <h5><span class="tsd-kind-parameter">b</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li></ul></div> |
| 842d8918 |
1235 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></li></ul></li></ul></div> |
| 15d6dfaf |
1236 | <h4 class="tsd-returns-title">Returns <a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4> |
| 1237 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1238 | <p>Inherited from Array.sort</p> |
| 1239 | <ul> |
| 323daa7f |
1240 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1384</li></ul></aside></li></ul></section> |
| 3bd6a82e |
1241 | <section class="tsd-panel tsd-member"><a id="splice-1" class="tsd-anchor"></a> |
| 15d6dfaf |
1242 | <h3 class="tsd-anchor-link"><span>splice</span><a href="#splice-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1243 | <ul class="tsd-signatures"> |
| 3c7c9bd1 |
1244 | <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><a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1245 | <li class="tsd-description"> |
| 1246 | <div class="tsd-parameters"> |
| 1247 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1248 | <ul class="tsd-parameter-list"> |
| 1249 | <li> |
| 3bd6a82e |
1250 | <h5><span class="tsd-kind-parameter">start</span>: <span class="tsd-signature-type">number</span></h5></li> |
| 842d8918 |
1251 | <li> |
| 323daa7f |
1252 | <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">deleteCount</span>: <span class="tsd-signature-type">number</span></h5><code class="tsd-tag ts-flagOptional">Optional</code> </li> |
| 842d8918 |
1253 | <li> |
| 323daa7f |
1254 | <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><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div> |
| 3c7c9bd1 |
1255 | <h4 class="tsd-returns-title">Returns <a href="CircularArray.html" class="tsd-signature-type tsd-kind-class">CircularArray</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4> |
| 15d6dfaf |
1256 | <div class="tsd-comment tsd-typography"> |
| 1257 | <h4>Inherit Doc</h4></div><aside class="tsd-sources"> |
| 842d8918 |
1258 | <p>Overrides Array.splice</p> |
| 1259 | <ul> |
| cc35cd9c |
1260 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7790a49/src/circular-array.ts#L56">src/circular-array.ts:56</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
1261 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toLocaleString-1" class="tsd-anchor"></a> |
| 15d6dfaf |
1262 | <h3 class="tsd-anchor-link"><span>to<wbr/>Locale<wbr/>String</span><a href="#toLocaleString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1263 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
1264 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1265 | <li class="tsd-description"> |
| 1266 | <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> |
| 1267 | </div> |
| 15d6dfaf |
1268 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> |
| 1269 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1270 | <p>Inherited from Array.toLocaleString</p> |
| 1271 | <ul> |
| 323daa7f |
1272 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1326</li></ul></aside></li></ul></section> |
| 3bd6a82e |
1273 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toString-1" class="tsd-anchor"></a> |
| 15d6dfaf |
1274 | <h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1275 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
1276 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1277 | <li class="tsd-description"> |
| 1278 | <div class="tsd-comment tsd-typography"><p>Returns a string representation of an array.</p> |
| 1279 | </div> |
| 15d6dfaf |
1280 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> |
| 1281 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1282 | <p>Inherited from Array.toString</p> |
| 1283 | <ul> |
| 323daa7f |
1284 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1322</li></ul></aside></li></ul></section> |
| 3bd6a82e |
1285 | <section class="tsd-panel tsd-member"><a id="unshift-1" class="tsd-anchor"></a> |
| 15d6dfaf |
1286 | <h3 class="tsd-anchor-link"><span>unshift</span><a href="#unshift-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1287 | <ul class="tsd-signatures"> |
| 15d6dfaf |
1288 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1289 | <li class="tsd-description"> |
| 1290 | <div class="tsd-parameters"> |
| 1291 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1292 | <ul class="tsd-parameter-list"> |
| 1293 | <li> |
| 323daa7f |
1294 | <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><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div> |
| 15d6dfaf |
1295 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> |
| 1296 | <div class="tsd-comment tsd-typography"> |
| 1297 | <h4>Inherit Doc</h4></div><aside class="tsd-sources"> |
| 842d8918 |
1298 | <p>Overrides Array.unshift</p> |
| 1299 | <ul> |
| cc35cd9c |
1300 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/7790a49/src/circular-array.ts#L32">src/circular-array.ts:32</a></li></ul></aside></li></ul></section> |
| 3bd6a82e |
1301 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="values-1" class="tsd-anchor"></a> |
| 15d6dfaf |
1302 | <h3 class="tsd-anchor-link"><span>values</span><a href="#values-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1303 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
1304 | <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"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><a href="#values-1.values-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1305 | <li class="tsd-description"> |
| 1306 | <div class="tsd-comment tsd-typography"><p>Returns an iterable of values in the array</p> |
| 1307 | </div> |
| 15d6dfaf |
1308 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4> |
| 1309 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1310 | <p>Inherited from Array.values</p> |
| 1311 | <ul> |
| 323daa7f |
1312 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:73</li></ul></aside></li></ul></section> |
| 3bd6a82e |
1313 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a> |
| 15d6dfaf |
1314 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1315 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
1316 | <li class="tsd-signature tsd-anchor-link" id="from.from-1"><span class="tsd-kind-call-signature">from</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">(</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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1317 | <li class="tsd-description"> |
| 1318 | <div class="tsd-comment tsd-typography"><p>Creates an array from an array-like object.</p> |
| 1319 | </div> |
| fab6d3b5 |
1320 | <section class="tsd-panel"> |
| 842d8918 |
1321 | <h4>Type Parameters</h4> |
| fab6d3b5 |
1322 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
1323 | <li> |
| 3bd6a82e |
1324 | <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section> |
| 842d8918 |
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">arrayLike</span>: <span class="tsd-signature-type ">ArrayLike</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h5> |
| 842d8918 |
1330 | <div class="tsd-comment tsd-typography"><p>An array-like object to convert to an array.</p> |
| 323daa7f |
1331 | </div></li></ul></div> |
| 15d6dfaf |
1332 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4> |
| 1333 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1334 | <p>Inherited from Array.from</p> |
| 1335 | <ul> |
| 323daa7f |
1336 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:70</li></ul></aside></li> |
| 15d6dfaf |
1337 | <li class="tsd-signature tsd-anchor-link" id="from.from-2"><span class="tsd-kind-call-signature">from</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 tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">></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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1338 | <li class="tsd-description"> |
| 1339 | <div class="tsd-comment tsd-typography"><p>Creates an array from an iterable object.</p> |
| 1340 | </div> |
| fab6d3b5 |
1341 | <section class="tsd-panel"> |
| 842d8918 |
1342 | <h4>Type Parameters</h4> |
| fab6d3b5 |
1343 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
1344 | <li> |
| 3bd6a82e |
1345 | <h4><span class="tsd-kind-type-parameter">T</span></h4></li> |
| 842d8918 |
1346 | <li> |
| 3bd6a82e |
1347 | <h4><span class="tsd-kind-type-parameter">U</span></h4></li></ul></section> |
| 842d8918 |
1348 | <div class="tsd-parameters"> |
| 1349 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1350 | <ul class="tsd-parameter-list"> |
| 1351 | <li> |
| 3bd6a82e |
1352 | <h5><span class="tsd-kind-parameter">arrayLike</span>: <span class="tsd-signature-type ">ArrayLike</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h5> |
| 842d8918 |
1353 | <div class="tsd-comment tsd-typography"><p>An array-like object to convert to an array.</p> |
| 323daa7f |
1354 | </div></li> |
| 842d8918 |
1355 | <li> |
| 3bd6a82e |
1356 | <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"> => </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
1357 | <div class="tsd-comment tsd-typography"><p>A mapping function to call on every element of the array.</p> |
| 1358 | </div> |
| 1359 | <ul class="tsd-parameters"> |
| 1360 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
1361 | <ul class="tsd-signatures tsd-is-external"> |
| 1362 | <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 |
1363 | <li class="tsd-description"> |
| 1364 | <div class="tsd-parameters"> |
| 1365 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1366 | <ul class="tsd-parameter-list"> |
| 1367 | <li> |
| 3bd6a82e |
1368 | <h5><span class="tsd-kind-parameter">v</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
1369 | <li> |
| 3bd6a82e |
1370 | <h5><span class="tsd-kind-parameter">k</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div> |
| 1371 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4></li></ul></li></ul></li> |
| 842d8918 |
1372 | <li> |
| 3bd6a82e |
1373 | <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 |
1374 | <div class="tsd-comment tsd-typography"><p>Value of 'this' used to invoke the mapfn.</p> |
| 323daa7f |
1375 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
1376 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span></h4> |
| 1377 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1378 | <p>Inherited from Array.from</p> |
| 1379 | <ul> |
| 323daa7f |
1380 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:78</li></ul></aside></li> |
| 15d6dfaf |
1381 | <li class="tsd-signature tsd-anchor-link" id="from.from-3"><span class="tsd-kind-call-signature">from</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">(</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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1382 | <li class="tsd-description"> |
| 1383 | <div class="tsd-comment tsd-typography"><p>Creates an array from an iterable object.</p> |
| 1384 | </div> |
| fab6d3b5 |
1385 | <section class="tsd-panel"> |
| 842d8918 |
1386 | <h4>Type Parameters</h4> |
| fab6d3b5 |
1387 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
1388 | <li> |
| 3bd6a82e |
1389 | <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section> |
| 842d8918 |
1390 | <div class="tsd-parameters"> |
| 1391 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1392 | <ul class="tsd-parameter-list"> |
| 1393 | <li> |
| 3bd6a82e |
1394 | <h5><span class="tsd-kind-parameter">iterable</span>: <span class="tsd-signature-type ">Iterable</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"> | </span><span class="tsd-signature-type ">ArrayLike</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h5> |
| 842d8918 |
1395 | <div class="tsd-comment tsd-typography"><p>An iterable object to convert to an array.</p> |
| 323daa7f |
1396 | </div></li></ul></div> |
| 15d6dfaf |
1397 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4> |
| 1398 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1399 | <p>Inherited from Array.from</p> |
| 1400 | <ul> |
| 323daa7f |
1401 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:81</li></ul></aside></li> |
| 15d6dfaf |
1402 | <li class="tsd-signature tsd-anchor-link" id="from.from-4"><span class="tsd-kind-call-signature">from</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 tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">></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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1403 | <li class="tsd-description"> |
| 1404 | <div class="tsd-comment tsd-typography"><p>Creates an array from an iterable object.</p> |
| 1405 | </div> |
| fab6d3b5 |
1406 | <section class="tsd-panel"> |
| 842d8918 |
1407 | <h4>Type Parameters</h4> |
| fab6d3b5 |
1408 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
1409 | <li> |
| 3bd6a82e |
1410 | <h4><span class="tsd-kind-type-parameter">T</span></h4></li> |
| 842d8918 |
1411 | <li> |
| 3bd6a82e |
1412 | <h4><span class="tsd-kind-type-parameter">U</span></h4></li></ul></section> |
| 842d8918 |
1413 | <div class="tsd-parameters"> |
| 1414 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1415 | <ul class="tsd-parameter-list"> |
| 1416 | <li> |
| 3bd6a82e |
1417 | <h5><span class="tsd-kind-parameter">iterable</span>: <span class="tsd-signature-type ">Iterable</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"> | </span><span class="tsd-signature-type ">ArrayLike</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h5> |
| 842d8918 |
1418 | <div class="tsd-comment tsd-typography"><p>An iterable object to convert to an array.</p> |
| 323daa7f |
1419 | </div></li> |
| 842d8918 |
1420 | <li> |
| 3bd6a82e |
1421 | <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"> => </span><span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">)</span></h5> |
| 842d8918 |
1422 | <div class="tsd-comment tsd-typography"><p>A mapping function to call on every element of the array.</p> |
| 1423 | </div> |
| 1424 | <ul class="tsd-parameters"> |
| 1425 | <li class="tsd-parameter-signature"> |
| 3bd6a82e |
1426 | <ul class="tsd-signatures tsd-is-external"> |
| 1427 | <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 |
1428 | <li class="tsd-description"> |
| 1429 | <div class="tsd-parameters"> |
| 1430 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1431 | <ul class="tsd-parameter-list"> |
| 1432 | <li> |
| 3bd6a82e |
1433 | <h5><span class="tsd-kind-parameter">v</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li> |
| 842d8918 |
1434 | <li> |
| 3bd6a82e |
1435 | <h5><span class="tsd-kind-parameter">k</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div> |
| 1436 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span></h4></li></ul></li></ul></li> |
| 842d8918 |
1437 | <li> |
| 3bd6a82e |
1438 | <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 |
1439 | <div class="tsd-comment tsd-typography"><p>Value of 'this' used to invoke the mapfn.</p> |
| 323daa7f |
1440 | </div><code class="tsd-tag ts-flagOptional">Optional</code> </li></ul></div> |
| 15d6dfaf |
1441 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">U</span><span class="tsd-signature-symbol">[]</span></h4> |
| 1442 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1443 | <p>Inherited from Array.from</p> |
| 1444 | <ul> |
| 323daa7f |
1445 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:89</li></ul></aside></li></ul></section> |
| 3bd6a82e |
1446 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isArray" class="tsd-anchor"></a> |
| 15d6dfaf |
1447 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1448 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
1449 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1450 | <li class="tsd-description"> |
| 1451 | <div class="tsd-parameters"> |
| 1452 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1453 | <ul class="tsd-parameter-list"> |
| 1454 | <li> |
| 3bd6a82e |
1455 | <h5><span class="tsd-kind-parameter">arg</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div> |
| fab6d3b5 |
1456 | <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 |
1457 | <p>Inherited from Array.isArray</p> |
| 1458 | <ul> |
| 323daa7f |
1459 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es5.d.ts:1505</li></ul></aside></li></ul></section> |
| 3bd6a82e |
1460 | <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="of" class="tsd-anchor"></a> |
| 15d6dfaf |
1461 | <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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e |
1462 | <ul class="tsd-signatures tsd-is-inherited tsd-is-external"> |
| 15d6dfaf |
1463 | <li class="tsd-signature tsd-anchor-link" id="of.of-1"><span class="tsd-kind-call-signature">of</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">(</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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 842d8918 |
1464 | <li class="tsd-description"> |
| 1465 | <div class="tsd-comment tsd-typography"><p>Returns a new array from a set of elements.</p> |
| 1466 | </div> |
| fab6d3b5 |
1467 | <section class="tsd-panel"> |
| 842d8918 |
1468 | <h4>Type Parameters</h4> |
| fab6d3b5 |
1469 | <ul class="tsd-type-parameter-list"> |
| 842d8918 |
1470 | <li> |
| 3bd6a82e |
1471 | <h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section> |
| 842d8918 |
1472 | <div class="tsd-parameters"> |
| 1473 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 1474 | <ul class="tsd-parameter-list"> |
| 1475 | <li> |
| 3bd6a82e |
1476 | <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 |
1477 | <div class="tsd-comment tsd-typography"><p>A set of elements to include in the new array object.</p> |
| 323daa7f |
1478 | </div><code class="tsd-tag ts-flagRest">Rest</code> </li></ul></div> |
| 15d6dfaf |
1479 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">[]</span></h4> |
| 1480 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> |
| 842d8918 |
1481 | <p>Inherited from Array.of</p> |
| 1482 | <ul> |
| 323daa7f |
1483 | <li>Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.core.d.ts:84</li></ul></aside></li></ul></section></section></div> |
| 842d8918 |
1484 | <div class="col-sidebar"> |
| 1485 | <div class="page-menu"> |
| 1486 | <div class="tsd-navigation settings"> |
| 1487 | <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> |
| 15d6dfaf |
1488 | <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary> |
| 842d8918 |
1489 | <div class="tsd-accordion-details"> |
| 1490 | <div class="tsd-filter-visibility"> |
| 1491 | <h4 class="uppercase">Member Visibility</h4><form> |
| 1492 | <ul id="tsd-filter-options"> |
| 1493 | <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> |
| 1494 | <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> |
| 1495 | <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> |
| 1496 | <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> |
| 1497 | <div class="tsd-theme-toggle"> |
| 3bd6a82e |
1498 | <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 |
1499 | <details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"> |
| 15d6dfaf |
1500 | <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary> |
| 842d8918 |
1501 | <div class="tsd-accordion-details"> |
| 1502 | <ul> |
| 15d6dfaf |
1503 | <li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li> |
| 1504 | <li><a href="#_unscopables_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>[unscopables]</span></a></li> |
| 1505 | <li><a href="#length-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>length</span></a></li> |
| 1506 | <li><a href="#size" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>size</span></a></li> |
| 1507 | <li><a href="#_species_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>[species]</span></a></li> |
| 1508 | <li><a href="#_iterator_-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>[iterator]</span></a></li> |
| 1509 | <li><a href="#at-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>at</span></a></li> |
| 1510 | <li><a href="#checkSize" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>Size</span></a></li> |
| 1511 | <li><a href="#concat-1" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>concat</span></a></li> |
| 1512 | <li><a href="#copyWithin-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>copy<wbr/>Within</span></a></li> |
| 1513 | <li><a href="#empty" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>empty</span></a></li> |
| 1514 | <li><a href="#entries-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>entries</span></a></li> |
| 1515 | <li><a href="#every-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>every</span></a></li> |
| 1516 | <li><a href="#fill-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>fill</span></a></li> |
| 1517 | <li><a href="#filter-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>filter</span></a></li> |
| 1518 | <li><a href="#find-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>find</span></a></li> |
| 1519 | <li><a href="#findIndex-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>find<wbr/>Index</span></a></li> |
| 1520 | <li><a href="#flat-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flat</span></a></li> |
| 1521 | <li><a href="#flatMap-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flat<wbr/>Map</span></a></li> |
| 1522 | <li><a href="#forEach-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>for<wbr/>Each</span></a></li> |
| 1523 | <li><a href="#full" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>full</span></a></li> |
| 1524 | <li><a href="#includes-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>includes</span></a></li> |
| 1525 | <li><a href="#indexOf-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>index<wbr/>Of</span></a></li> |
| 1526 | <li><a href="#join-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>join</span></a></li> |
| 1527 | <li><a href="#keys-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>keys</span></a></li> |
| 1528 | <li><a href="#lastIndexOf-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>last<wbr/>Index<wbr/>Of</span></a></li> |
| 1529 | <li><a href="#map-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>map</span></a></li> |
| 1530 | <li><a href="#pop-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pop</span></a></li> |
| 1531 | <li><a href="#push-1" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>push</span></a></li> |
| 1532 | <li><a href="#reduce-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reduce</span></a></li> |
| 1533 | <li><a href="#reduceRight-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reduce<wbr/>Right</span></a></li> |
| 1534 | <li><a href="#resize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>resize</span></a></li> |
| 1535 | <li><a href="#reverse-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reverse</span></a></li> |
| 1536 | <li><a href="#shift-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>shift</span></a></li> |
| 1537 | <li><a href="#slice-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>slice</span></a></li> |
| 1538 | <li><a href="#some-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>some</span></a></li> |
| 1539 | <li><a href="#sort-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sort</span></a></li> |
| 1540 | <li><a href="#splice-1" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>splice</span></a></li> |
| 1541 | <li><a href="#toLocaleString-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>Locale<wbr/>String</span></a></li> |
| 1542 | <li><a href="#toString-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>String</span></a></li> |
| 1543 | <li><a href="#unshift-1" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unshift</span></a></li> |
| 1544 | <li><a href="#values-1" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>values</span></a></li> |
| 1545 | <li><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from</span></a></li> |
| 1546 | <li><a href="#isArray" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Array</span></a></li> |
| 1547 | <li><a href="#of" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>of</span></a></li></ul></div></details></div> |
| 842d8918 |
1548 | <div class="site-menu"> |
| cc35cd9c |
1549 | <nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>poolifier -<wbr/> v2.6.40</span></a> |
| 842d8918 |
1550 | <ul class="tsd-small-nested-navigation"> |
| 15d6dfaf |
1551 | <li><a href="AbstractPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Abstract<wbr/>Pool</span></a></li> |
| 1552 | <li><a href="AbstractWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Abstract<wbr/>Worker</span></a></li> |
| 1553 | <li><a href="CircularArray.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Circular<wbr/>Array</span></a></li> |
| 1554 | <li><a href="ClusterWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cluster<wbr/>Worker</span></a></li> |
| 31542ddf |
1555 | <li><a href="Deque.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Deque</span></a></li> |
| 15d6dfaf |
1556 | <li><a href="DynamicClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dynamic<wbr/>Cluster<wbr/>Pool</span></a></li> |
| 1557 | <li><a href="DynamicThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dynamic<wbr/>Thread<wbr/>Pool</span></a></li> |
| 1558 | <li><a href="FixedClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Fixed<wbr/>Cluster<wbr/>Pool</span></a></li> |
| 1559 | <li><a href="FixedThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Fixed<wbr/>Thread<wbr/>Pool</span></a></li> |
| f2d2c4a4 |
1560 | <li><a href="Node.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Node</span></a></li> |
| 15d6dfaf |
1561 | <li><a href="PoolEmitter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Pool<wbr/>Emitter</span></a></li> |
| 15d6dfaf |
1562 | <li><a href="ThreadWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Thread<wbr/>Worker</span></a></li> |
| 1563 | <li><a href="WorkerChoiceStrategyContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span></a></li> |
| 1564 | <li><a href="../interfaces/ClusterPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Cluster<wbr/>Pool<wbr/>Options</span></a></li> |
| f05afd16 |
1565 | <li><a href="../interfaces/EventLoopUtilizationMeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Event<wbr/>Loop<wbr/>Utilization<wbr/>Measurement<wbr/>Statistics</span></a></li> |
| 15d6dfaf |
1566 | <li><a href="../interfaces/IPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IPool</span></a></li> |
| 1567 | <li><a href="../interfaces/IWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker</span></a></li> |
| 1568 | <li><a href="../interfaces/IWorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker<wbr/>Choice<wbr/>Strategy</span></a></li> |
| a6b5c73c |
1569 | <li><a href="../interfaces/IWorkerNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker<wbr/>Node</span></a></li> |
| f05afd16 |
1570 | <li><a href="../interfaces/MeasurementOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Measurement<wbr/>Options</span></a></li> |
| 1571 | <li><a href="../interfaces/MeasurementStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Measurement<wbr/>Statistics</span></a></li> |
| 1572 | <li><a href="../interfaces/MeasurementStatisticsRequirements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Measurement<wbr/>Statistics<wbr/>Requirements</span></a></li> |
| 15d6dfaf |
1573 | <li><a href="../interfaces/MessageValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Message<wbr/>Value</span></a></li> |
| 1574 | <li><a href="../interfaces/PoolInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Pool<wbr/>Info</span></a></li> |
| 1575 | <li><a href="../interfaces/PoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Pool<wbr/>Options</span></a></li> |
| 1576 | <li><a href="../interfaces/PromiseResponseWrapper.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Promise<wbr/>Response<wbr/>Wrapper</span></a></li> |
| aba8d9bd |
1577 | <li><a href="../interfaces/StrategyPolicy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Strategy<wbr/>Policy</span></a></li> |
| 15d6dfaf |
1578 | <li><a href="../interfaces/Task.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task</span></a></li> |
| f05afd16 |
1579 | <li><a href="../interfaces/TaskError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Error</span></a></li> |
| 71056a0a |
1580 | <li><a href="../interfaces/TaskPerformance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Performance</span></a></li> |
| afa30fd0 |
1581 | <li><a href="../interfaces/TaskStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Statistics</span></a></li> |
| f05afd16 |
1582 | <li><a href="../interfaces/TaskStatisticsRequirements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task<wbr/>Statistics<wbr/>Requirements</span></a></li> |
| 15d6dfaf |
1583 | <li><a href="../interfaces/TasksQueueOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tasks<wbr/>Queue<wbr/>Options</span></a></li> |
| f45a3823 |
1584 | <li><a href="../interfaces/ThreadPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Thread<wbr/>Pool<wbr/>Options</span></a></li> |
| 15d6dfaf |
1585 | <li><a href="../interfaces/WorkerChoiceStrategyOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a></li> |
| ac2cb9e2 |
1586 | <li><a href="../interfaces/WorkerInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Info</span></a></li> |
| 15d6dfaf |
1587 | <li><a href="../interfaces/WorkerOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Options</span></a></li> |
| 71056a0a |
1588 | <li><a href="../interfaces/WorkerStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Statistics</span></a></li> |
| f05afd16 |
1589 | <li><a href="../interfaces/WorkerUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Usage</span></a></li> |
| 323daa7f |
1590 | <li><a href="../types/ErrorHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Error<wbr/>Handler</span></a></li> |
| 1591 | <li><a href="../types/ExitHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Exit<wbr/>Handler</span></a></li> |
| 1592 | <li><a href="../types/KillBehavior.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Kill<wbr/>Behavior</span></a></li> |
| 1593 | <li><a href="../types/KillHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Kill<wbr/>Handler</span></a></li> |
| 1594 | <li><a href="../types/Measurement.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Measurement</span></a></li> |
| 1595 | <li><a href="../types/MessageHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Message<wbr/>Handler</span></a></li> |
| 1596 | <li><a href="../types/OnlineHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Online<wbr/>Handler</span></a></li> |
| 1597 | <li><a href="../types/PoolEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Pool<wbr/>Event</span></a></li> |
| 1598 | <li><a href="../types/PoolType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Pool<wbr/>Type</span></a></li> |
| 1599 | <li><a href="../types/TaskAsyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Task<wbr/>Async<wbr/>Function</span></a></li> |
| 1600 | <li><a href="../types/TaskFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Task<wbr/>Function</span></a></li> |
| 1601 | <li><a href="../types/TaskFunctions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Task<wbr/>Functions</span></a></li> |
| 1602 | <li><a href="../types/TaskSyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Task<wbr/>Sync<wbr/>Function</span></a></li> |
| 1603 | <li><a href="../types/WorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy</span></a></li> |
| 7ab352a6 |
1604 | <li><a href="../types/WorkerNodeEventCallback.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Worker<wbr/>Node<wbr/>Event<wbr/>Callback</span></a></li> |
| 323daa7f |
1605 | <li><a href="../types/WorkerType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Worker<wbr/>Type</span></a></li> |
| 1606 | <li><a href="../types/Writable.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Writable</span></a></li> |
| 15d6dfaf |
1607 | <li><a href="../variables/KillBehaviors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>Kill<wbr/>Behaviors</span></a></li> |
| f05afd16 |
1608 | <li><a href="../variables/Measurements.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Measurements</span></a></li> |
| 15d6dfaf |
1609 | <li><a href="../variables/PoolEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Pool<wbr/>Events</span></a></li> |
| 1610 | <li><a href="../variables/PoolTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Pool<wbr/>Types</span></a></li> |
| 1611 | <li><a href="../variables/WorkerChoiceStrategies.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategies</span></a></li> |
| a97f9c80 |
1612 | <li><a href="../variables/WorkerTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Worker<wbr/>Types</span></a></li> |
| 1613 | <li><a href="../functions/availableParallelism.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>available<wbr/>Parallelism</span></a></li></ul></nav></div></div></div> |
| 842d8918 |
1614 | <div class="tsd-generator"> |
| 323daa7f |
1615 | <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div> |
| 842d8918 |
1616 | <div class="overlay"></div></body></html> |
repositories / poolifier.git / blame