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 - v3.1
.21</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/icons.js" id=
"tsd-icons-script"></script><script async
src=
"../assets/search.js" id=
"tsd-search-script"></script><script async
src=
"../assets/navigation.js" id=
"tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem(
"tsd-theme") ||
"os";document.body.style.
display=
"none";setTimeout(() =
> app?app.showPage():document.body.style.removeProperty(
"display"),
500)
</script><header class=
"tsd-page-toolbar"><div class=
"tsd-toolbar-contents container"><div class=
"table-cell" id=
"tsd-search" data-base=
".."><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"><use href=
"../assets/icons.svg#icon-search"></use></svg></label><input type=
"text" id=
"tsd-search-field" aria-label=
"Search"/></div><div class=
"field"><div id=
"tsd-toolbar-links"></div></div><ul class=
"results"><li class=
"state loading">Preparing search index...
</li><li class=
"state failure">The search index is not available
</li></ul><a href=
"../index.html" class=
"title">poolifier - v3.1
.21</a></div><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"><use href=
"../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class=
"container container-main"><div class=
"col-content"><div class=
"tsd-page-title"><ul class=
"tsd-breadcrumb"><li><a href=
"../index.html">poolifier
</a></li><li><a href=
"CircularArray.html">CircularArray
</a></li></ul><h1>Class CircularArray
<T
><code class=
"tsd-tag ts-flagInternal">Internal
</code> </h1></div><section class=
"tsd-panel tsd-comment"><div class=
"tsd-comment tsd-typography"><p>Array with a maximum length and shifting items when full.
</p>
2 </div><div class=
"tsd-comment tsd-typography"></div></section> <section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"T" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">T
</span></span><div class=
"tsd-comment tsd-typography"><p>Type of items.
</p>
3 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></section> <section class=
"tsd-panel tsd-hierarchy"><h4>Hierarchy
</h4><ul class=
"tsd-hierarchy"><li><span class=
"tsd-signature-type">Array
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">></span><ul class=
"tsd-hierarchy"><li><span class=
"target">CircularArray
</span></li></ul></li></ul></section><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0e86917/src/circular-array.ts#L11">src/circular-array.ts:
11</a></li></ul></aside><section class=
"tsd-panel-group tsd-index-group"><section class=
"tsd-panel tsd-index-panel"><details class=
"tsd-index-content tsd-index-accordion" open
><summary class=
"tsd-accordion-summary tsd-index-summary"><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"><use href=
"../assets/icons.svg#icon-chevronSmall"></use></svg> Index
</h5></summary><div class=
"tsd-accordion-details"><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Constructors
</h3><div class=
"tsd-index-list"><a href=
"CircularArray.html#constructor" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-512"></use></svg><span>constructor
</span></a>
4 </div></section><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Properties
</h3><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"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>[unscopables]
</span></a>
5 <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=
"../assets/icons.svg#icon-1024"></use></svg><span>length
</span></a>
6 <a href=
"CircularArray.html#size" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>size
</span></a>
7 <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=
"../assets/icons.svg#icon-1024"></use></svg><span>[species]
</span></a>
8 </div></section><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Methods
</h3><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"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>[iterator]
</span></a>
9 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>at
</span></a>
10 <a href=
"CircularArray.html#checkSize" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Size
</span></a>
11 <a href=
"CircularArray.html#concat-1" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>concat
</span></a>
12 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>copy
<wbr/>Within
</span></a>
13 <a href=
"CircularArray.html#empty" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>empty
</span></a>
14 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>entries
</span></a>
15 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>every
</span></a>
16 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>fill
</span></a>
17 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>filter
</span></a>
18 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>find
</span></a>
19 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>find
<wbr/>Index
</span></a>
20 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>flat
</span></a>
21 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>flat
<wbr/>Map
</span></a>
22 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>for
<wbr/>Each
</span></a>
23 <a href=
"CircularArray.html#full" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>full
</span></a>
24 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>includes
</span></a>
25 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>index
<wbr/>Of
</span></a>
26 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>join
</span></a>
27 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>keys
</span></a>
28 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>last
<wbr/>Index
<wbr/>Of
</span></a>
29 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>map
</span></a>
30 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>pop
</span></a>
31 <a href=
"CircularArray.html#push-1" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>push
</span></a>
32 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>reduce
</span></a>
33 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>reduce
<wbr/>Right
</span></a>
34 <a href=
"CircularArray.html#resize" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>resize
</span></a>
35 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>reverse
</span></a>
36 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>shift
</span></a>
37 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>slice
</span></a>
38 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>some
</span></a>
39 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>sort
</span></a>
40 <a href=
"CircularArray.html#splice-1" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>splice
</span></a>
41 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>to
<wbr/>Locale
<wbr/>String
</span></a>
42 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>to
<wbr/>String
</span></a>
43 <a href=
"CircularArray.html#unshift-1" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>unshift
</span></a>
44 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>values
</span></a>
45 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>from
</span></a>
46 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>is
<wbr/>Array
</span></a>
47 <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=
"../assets/icons.svg#icon-2048"></use></svg><span>of
</span></a>
48 </div></section></div></details></section></section><section class=
"tsd-panel-group tsd-member-group"><h2>Constructors
</h2><section class=
"tsd-panel tsd-member"><a id=
"constructor" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>constructor
</span><a href=
"#constructor" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"constructor.new_CircularArray" class=
"tsd-anchor"></a><span class=
"tsd-kind-constructor-signature">new
<wbr/>Circular
<wbr/>Array
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"constructor.new_CircularArray.T-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">T
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">size
</span>:
<span class=
"tsd-signature-type">number
</span><span class=
"tsd-signature-symbol"> = DEFAULT_CIRCULAR_ARRAY_SIZE
</span></span></li><li><span><code class=
"tsd-tag ts-flagRest">Rest
</code> <span class=
"tsd-signature-symbol">...
</span><span class=
"tsd-kind-parameter">items
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">></span></h4><aside class=
"tsd-sources"><p>Overrides Array
<T
>.constructor
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0e86917/src/circular-array.ts#L14">src/circular-array.ts:
14</a></li></ul></aside></li></ul></section></section><section class=
"tsd-panel-group tsd-member-group"><h2>Properties
</h2><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"_unscopables_" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><div class=
"tsd-comment tsd-typography"><p>Is an object whose properties have the value
'true
'
49 when they will be absent when used in a
'with
' statement.
</p>
50 </div><div class=
"tsd-type-declaration"><h4>Type declaration
</h4><ul class=
"tsd-parameters"><li class=
"tsd-parameter"><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><div class=
"tsd-comment tsd-typography"><p>Is an object whose properties have the value
'true
'
51 when they will be absent when used in a
'with
' statement.
</p>
52 </div><div class=
"tsd-comment tsd-typography"></div></li><li class=
"tsd-parameter"><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><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>
53 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.[unscopables]
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:
97</li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"length-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><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><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>
54 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.length
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1326</li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"size" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><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"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0e86917/src/circular-array.ts#L12">src/circular-array.ts:
12</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"_species_" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><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"><p>Inherited from Array.[species]
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:
316</li></ul></aside></section></section><section class=
"tsd-panel-group tsd-member-group"><h2>Methods
</h2><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"_iterator_-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"_iterator_-1._iterator_-2" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Iterator
</p>
55 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">IterableIterator
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.[iterator]
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:
58</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"at-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"at-1.at-2" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><a href=
"#at-1.at-2" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns the item located at the specified index.
</p>
56 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span><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>
57 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.at
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2022.array.d.ts:
24</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"checkSize" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"checkSize.checkSize-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">size
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0e86917/src/circular-array.ts#L101">src/circular-array.ts:
101</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"concat-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"concat-1.concat-2" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-type">ConcatArray
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Overrides Array.concat
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0e86917/src/circular-array.ts#L42">src/circular-array.ts:
42</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"copyWithin-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"copyWithin-1.copyWithin-2" class=
"tsd-anchor"></a><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><span class=
"tsd-signature-type">this
</span><a href=
"#copyWithin-1.copyWithin-2" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns the this object after copying a section of the array identified by start and end
58 to the same array starting at position target
</p>
59 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">target
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>If target is negative, it is treated as length+target where length is the
60 length of the array.
</p>
61 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><span class=
"tsd-kind-parameter">start
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>If start is negative, it is treated as length+start. If end is negative, it
62 is treated as length+end.
</p>
63 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">end
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>If not specified, length of the this object is used as its default value.
</p>
64 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">this
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.copyWithin
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.core.d.ts:
62</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"empty" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"empty.empty-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0e86917/src/circular-array.ts#L93">src/circular-array.ts:
93</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"entries-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"entries-1.entries-2" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns an iterable of key, value pairs for every entry in the array
</p>
65 </div><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">]
</span><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.entries
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:
63</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"every-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"every-1.every-2" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">every
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#every-1.every-2.S">S
</a><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-keyword"> is
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#every-1.every-2.S">S
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Determines whether all the members of an array satisfy the specified test.
</p>
66 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"every-1.every-2.S" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">S
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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-keyword"> is
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#every-1.every-2.S">S
</a><span class=
"tsd-signature-symbol">)
</span></span><div class=
"tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The every method calls
67 the predicate function for each element in the array until the predicate returns a value
68 which is coercible to the Boolean value false, or until the end of the array.
</p>
69 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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-keyword"> is
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#every-1.every-2.S">S
</a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">value
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-kind-parameter">value
</span><span class=
"tsd-signature-keyword"> is
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#every-1.every-2.S">S
</a></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<span class=
"tsd-signature-type">any
</span></span><div class=
"tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the predicate function.
70 If thisArg is omitted, undefined is used as the this value.
</p>
71 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-kind-parameter">this
</span><span class=
"tsd-signature-keyword"> is
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#every-1.every-2.S">S
</a><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.every
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1433</li></ul></aside></li><li class=
"tsd-signature tsd-anchor-link"><a id=
"every-1.every-3" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Determines whether all the members of an array satisfy the specified test.
</p>
72 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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></span><div class=
"tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The every method calls
73 the predicate function for each element in the array until the predicate returns a value
74 which is coercible to the Boolean value false, or until the end of the array.
</p>
75 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">value
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">unknown
</span></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<span class=
"tsd-signature-type">any
</span></span><div class=
"tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the predicate function.
76 If thisArg is omitted, undefined is used as the this value.
</p>
77 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.every
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1442</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"fill-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"fill-1.fill-2" class=
"tsd-anchor"></a><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><span class=
"tsd-signature-type">this
</span><a href=
"#fill-1.fill-2" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><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>
78 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">value
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span><div class=
"tsd-comment tsd-typography"><p>value to fill array section with
</p>
79 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">start
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>index to start filling the array at. If start is negative, it is treated as
80 length+start where length is the length of the array.
</p>
81 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">end
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>index to stop filling the array at. If end is negative, it is treated as
83 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">this
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.fill
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.core.d.ts:
51</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"filter-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"filter-1.filter-2" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">filter
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#filter-1.filter-2.S-1">S
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#filter-1.filter-2.S-1">S
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns the elements of an array that meet the condition specified in a callback function.
</p>
84 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"filter-1.filter-2.S-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">S
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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-keyword"> is
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#filter-1.filter-2.S-1">S
</a><span class=
"tsd-signature-symbol">)
</span></span><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>
85 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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-keyword"> is
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#filter-1.filter-2.S-1">S
</a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">value
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-kind-parameter">value
</span><span class=
"tsd-signature-keyword"> is
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#filter-1.filter-2.S-1">S
</a></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<span class=
"tsd-signature-type">any
</span></span><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>
86 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#filter-1.filter-2.S-1">S
</a><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.filter
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1469</li></ul></aside></li><li class=
"tsd-signature tsd-anchor-link"><a id=
"filter-1.filter-3" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns the elements of an array that meet the condition specified in a callback function.
</p>
87 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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></span><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>
88 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">value
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">unknown
</span></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<span class=
"tsd-signature-type">any
</span></span><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>
89 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.filter
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1475</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"find-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"find-1.find-2" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">find
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#find-1.find-2.S-2">S
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#find-1.find-2.S-2">S
</a><a href=
"#find-1.find-2" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns the value of the first element in the array where predicate is true, and undefined
91 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"find-1.find-2.S-2" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">S
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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-keyword"> is
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#find-1.find-2.S-2">S
</a><span class=
"tsd-signature-symbol">)
</span></span><div class=
"tsd-comment tsd-typography"><p>find calls predicate once for each element of the array, in ascending
92 order, until it finds one where predicate returns true. If such an element is found, find
93 immediately returns that element value. Otherwise, find returns undefined.
</p>
94 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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-keyword"> is
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#find-1.find-2.S-2">S
</a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">value
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">obj
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-kind-parameter">value
</span><span class=
"tsd-signature-keyword"> is
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#find-1.find-2.S-2">S
</a></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<span class=
"tsd-signature-type">any
</span></span><div class=
"tsd-comment tsd-typography"><p>If provided, it will be used as the this value for each invocation of
95 predicate. If it is not provided, undefined is used instead.
</p>
96 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#find-1.find-2.S-2">S
</a></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.find
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.core.d.ts:
29</li></ul></aside></li><li class=
"tsd-signature tsd-anchor-link"><a id=
"find-1.find-3" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><a href=
"#find-1.find-3" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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></span><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">value
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">obj
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">unknown
</span></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<span class=
"tsd-signature-type">any
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></h4><aside class=
"tsd-sources"><p>Inherited from Array.find
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.core.d.ts:
30</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"findIndex-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"findIndex-1.findIndex-2" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns the index of the first element in the array where predicate is true, and -
1
98 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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></span><div class=
"tsd-comment tsd-typography"><p>find calls predicate once for each element of the array, in ascending
99 order, until it finds one where predicate returns true. If such an element is found,
100 findIndex immediately returns that element index. Otherwise, findIndex returns -
1.
</p>
101 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">value
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">obj
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">unknown
</span></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<span class=
"tsd-signature-type">any
</span></span><div class=
"tsd-comment tsd-typography"><p>If provided, it will be used as the this value for each invocation of
102 predicate. If it is not provided, undefined is used instead.
</p>
103 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.findIndex
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.core.d.ts:
41</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"flat-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"flat-1.flat-2" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">flat
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flat-1.flat-2.A">A
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flat-1.flat-2.D">D
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flat-1.flat-2.A">A
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flat-1.flat-2.D">D
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns a new array with all sub-array elements concatenated into it recursively up to the
105 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"flat-1.flat-2.A" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">A
</span></span></li><li><span><a id=
"flat-1.flat-2.D" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">D
</span><span class=
"tsd-signature-keyword"> extends
</span><span class=
"tsd-signature-type">number
</span> =
<span class=
"tsd-signature-type">1</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">this
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flat-1.flat-2.A">A
</a></span></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">depth
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flat-1.flat-2.D">D
</a></span><div class=
"tsd-comment tsd-typography"><p>The maximum recursion depth
</p>
106 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">FlatArray
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flat-1.flat-2.A">A
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flat-1.flat-2.D">D
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.flat
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2019.array.d.ts:
75</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"flatMap-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"flatMap-1.flatMap-2" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">flat
<wbr/>Map
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flatMap-1.flatMap-2.U">U
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flatMap-1.flatMap-2.This">This
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flatMap-1.flatMap-2.U">U
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Calls a defined callback function on each element of an array. Then, flattens the result into
108 This is identical to a map followed by flat with depth
1.
</p>
109 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"flatMap-1.flatMap-2.U" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">U
</span></span></li><li><span><a id=
"flatMap-1.flatMap-2.This" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">This
</span> =
<span class=
"tsd-signature-type">undefined
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flatMap-1.flatMap-2.U">U
</a><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-keyword">readonly
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flatMap-1.flatMap-2.U">U
</a><span class=
"tsd-signature-symbol">[]
</span><span class=
"tsd-signature-symbol">)
</span></span><div class=
"tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The flatMap method calls the
110 callback function one time for each element in the array.
</p>
111 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flatMap-1.flatMap-2.U">U
</a><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-keyword">readonly
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flatMap-1.flatMap-2.U">U
</a><span class=
"tsd-signature-symbol">[]
</span></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">this
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flatMap-1.flatMap-2.This">This
</a></span></li><li><span><span class=
"tsd-kind-parameter">value
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flatMap-1.flatMap-2.U">U
</a><span class=
"tsd-signature-symbol"> |
</span><span class=
"tsd-signature-keyword">readonly
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flatMap-1.flatMap-2.U">U
</a><span class=
"tsd-signature-symbol">[]
</span></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flatMap-1.flatMap-2.This">This
</a></span><div class=
"tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the callback function. If
112 thisArg is omitted, undefined is used as the this value.
</p>
113 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#flatMap-1.flatMap-2.U">U
</a><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.flatMap
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2019.array.d.ts:
64</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"forEach-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"forEach-1.forEach-2" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Performs the specified action for each element in an array.
</p>
114 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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></span><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>
115 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">value
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<span class=
"tsd-signature-type">any
</span></span><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>
116 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.forEach
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1457</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"full" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"full.full-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0e86917/src/circular-array.ts#L97">src/circular-array.ts:
97</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"includes-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"includes-1.includes-2" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Determines whether an array includes a certain element, returning true or false as appropriate.
</p>
117 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">searchElement
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span><div class=
"tsd-comment tsd-typography"><p>The element to search for.
</p>
118 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">fromIndex
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The position in this array at which to begin searching for searchElement.
</p>
119 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.includes
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2016.array.include.d.ts:
25</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"indexOf-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"indexOf-1.indexOf-2" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><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>
120 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">searchElement
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span><div class=
"tsd-comment tsd-typography"><p>The value to locate in the array.
</p>
121 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">fromIndex
</span>:
<span class=
"tsd-signature-type">number
</span></span><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>
122 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.indexOf
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1418</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"join-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"join-1.join-2" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Adds all the elements of an array into a string, separated by the specified separator string.
</p>
123 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">separator
</span>:
<span class=
"tsd-signature-type">string
</span></span><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>
124 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">string
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.join
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1361</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"keys-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"keys-1.keys-2" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns an iterable of keys in the array
</p>
125 </div><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><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.keys
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:
68</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"lastIndexOf-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"lastIndexOf-1.lastIndexOf-2" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><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>
126 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">searchElement
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span><div class=
"tsd-comment tsd-typography"><p>The value to locate in the array.
</p>
127 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">fromIndex
</span>:
<span class=
"tsd-signature-type">number
</span></span><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>
128 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.lastIndexOf
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1424</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"map-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"map-1.map-2" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">map
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#map-1.map-2.U-1">U
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#map-1.map-2.U-1">U
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><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>
129 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"map-1.map-2.U-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">U
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#map-1.map-2.U-1">U
</a><span class=
"tsd-signature-symbol">)
</span></span><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>
130 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#map-1.map-2.U-1">U
</a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">value
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#map-1.map-2.U-1">U
</a></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<span class=
"tsd-signature-type">any
</span></span><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>
131 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#map-1.map-2.U-1">U
</a><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.map
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1463</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"pop-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"pop-1.pop-2" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><a href=
"#pop-1.pop-2" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Removes the last element from an array and returns it.
132 If the array is empty, undefined is returned and the array is not modified.
</p>
133 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.pop
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1339</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"push-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"push-1.push-2" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><code class=
"tsd-tag ts-flagRest">Rest
</code> <span class=
"tsd-signature-symbol">...
</span><span class=
"tsd-kind-parameter">items
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Overrides Array.push
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0e86917/src/circular-array.ts#L24">src/circular-array.ts:
24</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"reduce-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"reduce-1.reduce-2" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><a href=
"#reduce-1.reduce-2" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><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>
134 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">)
</span></span><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>
135 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">previousValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">currentValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">currentIndex
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></h4></li></ul></li></ul></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.reduce
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1481</li></ul></aside></li><li class=
"tsd-signature tsd-anchor-link"><a id=
"reduce-1.reduce-3" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><a href=
"#reduce-1.reduce-3" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">)
</span></span><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">previousValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">currentValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">currentIndex
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></h4></li></ul></li></ul></li><li><span><span class=
"tsd-kind-parameter">initialValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></h4><aside class=
"tsd-sources"><p>Inherited from Array.reduce
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1482</li></ul></aside></li><li class=
"tsd-signature tsd-anchor-link"><a id=
"reduce-1.reduce-4" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">reduce
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduce-1.reduce-4.U-2">U
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduce-1.reduce-4.U-2">U
</a><a href=
"#reduce-1.reduce-4" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><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>
136 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"reduce-1.reduce-4.U-2" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">U
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduce-1.reduce-4.U-2">U
</a><span class=
"tsd-signature-symbol">)
</span></span><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>
137 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduce-1.reduce-4.U-2">U
</a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">previousValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduce-1.reduce-4.U-2">U
</a></span></li><li><span><span class=
"tsd-kind-parameter">currentValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">currentIndex
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduce-1.reduce-4.U-2">U
</a></h4></li></ul></li></ul></li><li><span><span class=
"tsd-kind-parameter">initialValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduce-1.reduce-4.U-2">U
</a></span><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>
138 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduce-1.reduce-4.U-2">U
</a></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.reduce
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1488</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"reduceRight-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"reduceRight-1.reduceRight-2" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><a href=
"#reduceRight-1.reduceRight-2" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><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>
139 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">)
</span></span><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>
140 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">previousValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">currentValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">currentIndex
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></h4></li></ul></li></ul></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.reduceRight
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1494</li></ul></aside></li><li class=
"tsd-signature tsd-anchor-link"><a id=
"reduceRight-1.reduceRight-3" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><a href=
"#reduceRight-1.reduceRight-3" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">)
</span></span><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">previousValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">currentValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">currentIndex
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></h4></li></ul></li></ul></li><li><span><span class=
"tsd-kind-parameter">initialValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></h4><aside class=
"tsd-sources"><p>Inherited from Array.reduceRight
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1495</li></ul></aside></li><li class=
"tsd-signature tsd-anchor-link"><a id=
"reduceRight-1.reduceRight-4" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">reduce
<wbr/>Right
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduceRight-1.reduceRight-4.U-3">U
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduceRight-1.reduceRight-4.U-3">U
</a><a href=
"#reduceRight-1.reduceRight-4" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><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>
141 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"reduceRight-1.reduceRight-4.U-3" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">U
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduceRight-1.reduceRight-4.U-3">U
</a><span class=
"tsd-signature-symbol">)
</span></span><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>
142 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduceRight-1.reduceRight-4.U-3">U
</a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">previousValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduceRight-1.reduceRight-4.U-3">U
</a></span></li><li><span><span class=
"tsd-kind-parameter">currentValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">currentIndex
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduceRight-1.reduceRight-4.U-3">U
</a></h4></li></ul></li></ul></li><li><span><span class=
"tsd-kind-parameter">initialValue
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduceRight-1.reduceRight-4.U-3">U
</a></span><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>
143 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#reduceRight-1.reduceRight-4.U-3">U
</a></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.reduceRight
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1501</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"resize" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"resize.resize-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">size
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0e86917/src/circular-array.ts#L81">src/circular-array.ts:
81</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"reverse-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"reverse-1.reverse-2" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Reverses the elements in an array in place.
144 This method mutates the array and returns a reference to the same array.
</p>
145 </div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.reverse
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1366</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"shift-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"shift-1.shift-2" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><a href=
"#shift-1.shift-2" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Removes the first element from an array and returns it.
146 If the array is empty, undefined is returned and the array is not modified.
</p>
147 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.shift
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1371</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"slice-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"slice-1.slice-2" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns a copy of a section of an array.
148 For both start and end, a negative index can be used to indicate an offset from the end of the array.
149 For example, -
2 refers to the second to last element of the array.
</p>
150 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">start
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The beginning index of the specified portion of the array.
151 If start is undefined, then the slice begins at index
0.
</p>
152 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">end
</span>:
<span class=
"tsd-signature-type">number
</span></span><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
'.
153 If end is undefined, then the slice extends to the end of the array.
</p>
154 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.slice
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1381</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"some-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"some-1.some-2" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Determines whether the specified callback function returns true for any element of an array.
</p>
155 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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></span><div class=
"tsd-comment tsd-typography"><p>A function that accepts up to three arguments. The some method calls
156 the predicate function for each element in the array until the predicate returns a value
157 which is coercible to the Boolean value true, or until the end of the array.
</p>
158 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">value
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><span class=
"tsd-kind-parameter">array
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">unknown
</span></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<span class=
"tsd-signature-type">any
</span></span><div class=
"tsd-comment tsd-typography"><p>An object to which the this keyword can refer in the predicate function.
159 If thisArg is omitted, undefined is used as the this value.
</p>
160 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.some
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1451</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"sort-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"sort-1.sort-2" class=
"tsd-anchor"></a><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><span class=
"tsd-signature-type">this
</span><a href=
"#sort-1.sort-2" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Sorts an array in place.
161 This method mutates the array and returns a reference to the same array.
</p>
162 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><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></span><div class=
"tsd-comment tsd-typography"><p>Function used to determine the order of the elements. It is expected to return
163 a negative value if the first argument is less than the second argument, zero if they
're equal, and a positive
164 value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.
</p>
165 <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>
166 </code><button>Copy
</button></pre>
167 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">a
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">b
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4></li></ul></li></ul></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">this
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.sort
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1392</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"splice-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"splice-1.splice-2" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">start
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">deleteCount
</span>:
<span class=
"tsd-signature-type">number
</span></span></li><li><span><code class=
"tsd-tag ts-flagRest">Rest
</code> <span class=
"tsd-signature-symbol">...
</span><span class=
"tsd-kind-parameter">items
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Overrides Array.splice
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0e86917/src/circular-array.ts#L57">src/circular-array.ts:
57</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"toLocaleString-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"toLocaleString-1.toLocaleString-2" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><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>
168 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">string
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.toLocaleString
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1334</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"toString-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"toString-1.toString-2" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns a string representation of an array.
</p>
169 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">string
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.toString
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1330</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"unshift-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"unshift-1.unshift-2" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><code class=
"tsd-tag ts-flagRest">Rest
</code> <span class=
"tsd-signature-symbol">...
</span><span class=
"tsd-kind-parameter">items
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">[]
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><div class=
"tsd-comment tsd-typography"><h4>Inherit Doc
</h4></div><aside class=
"tsd-sources"><p>Overrides Array.unshift
</p><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/0e86917/src/circular-array.ts#L33">src/circular-array.ts:
33</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"values-1" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"values-1.values-2" class=
"tsd-anchor"></a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns an iterable of values in the array
</p>
170 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">IterableIterator
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#constructor.new_CircularArray.T-1">T
</a><span class=
"tsd-signature-symbol">></span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.values
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:
73</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"from" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"from.from-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">from
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-1.T-2">T
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-1.T-2">T
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Creates an array from an array-like object.
</p>
171 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"from.from-1.T-2" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">T
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">arrayLike
</span>:
<span class=
"tsd-signature-type">ArrayLike
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-1.T-2">T
</a><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>An array-like object to convert to an array.
</p>
172 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-1.T-2">T
</a><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.from
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.core.d.ts:
70</li></ul></aside></li><li class=
"tsd-signature tsd-anchor-link"><a id=
"from.from-2" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">from
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-2.T-3">T
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-2.U-4">U
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-2.U-4">U
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Creates an array from an iterable object.
</p>
173 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"from.from-2.T-3" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">T
</span></span></li><li><span><a id=
"from.from-2.U-4" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">U
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">arrayLike
</span>:
<span class=
"tsd-signature-type">ArrayLike
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-2.T-3">T
</a><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>An array-like object to convert to an array.
</p>
174 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-2.U-4">U
</a><span class=
"tsd-signature-symbol">)
</span></span><div class=
"tsd-comment tsd-typography"><p>A mapping function to call on every element of the array.
</p>
175 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-2.U-4">U
</a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">v
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-2.T-3">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">k
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-2.U-4">U
</a></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<span class=
"tsd-signature-type">any
</span></span><div class=
"tsd-comment tsd-typography"><p>Value of
'this
' used to invoke the mapfn.
</p>
176 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-2.U-4">U
</a><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.from
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.core.d.ts:
78</li></ul></aside></li><li class=
"tsd-signature tsd-anchor-link"><a id=
"from.from-3" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">from
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-3.T-4">T
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-3.T-4">T
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Creates an array from an iterable object.
</p>
177 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"from.from-3.T-4" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">T
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">iterable
</span>:
<span class=
"tsd-signature-type">Iterable
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-3.T-4">T
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-3.T-4">T
</a><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>An iterable object to convert to an array.
</p>
178 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-3.T-4">T
</a><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.from
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:
81</li></ul></aside></li><li class=
"tsd-signature tsd-anchor-link"><a id=
"from.from-4" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">from
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-4.T-5">T
</a><span class=
"tsd-signature-symbol">,
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-4.U-5">U
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-4.U-5">U
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Creates an array from an iterable object.
</p>
179 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"from.from-4.T-5" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">T
</span></span></li><li><span><a id=
"from.from-4.U-5" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">U
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">iterable
</span>:
<span class=
"tsd-signature-type">Iterable
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-4.T-5">T
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-4.T-5">T
</a><span class=
"tsd-signature-symbol">></span></span><div class=
"tsd-comment tsd-typography"><p>An iterable object to convert to an array.
</p>
180 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-4.U-5">U
</a><span class=
"tsd-signature-symbol">)
</span></span><div class=
"tsd-comment tsd-typography"><p>A mapping function to call on every element of the array.
</p>
181 </div><div class=
"tsd-comment tsd-typography"></div><ul class=
"tsd-parameters"><li class=
"tsd-parameter-signature"><ul class=
"tsd-signatures tsd-is-external"><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-4.U-5">U
</a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">v
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-4.T-5">T
</a></span></li><li><span><span class=
"tsd-kind-parameter">k
</span>:
<span class=
"tsd-signature-type">number
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-4.U-5">U
</a></h4></li></ul></li></ul></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">thisArg
</span>:
<span class=
"tsd-signature-type">any
</span></span><div class=
"tsd-comment tsd-typography"><p>Value of
'this
' used to invoke the mapfn.
</p>
182 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#from.from-4.U-5">U
</a><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.from
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:
89</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"isArray" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"isArray.isArray-1" class=
"tsd-anchor"></a><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-keyword"> 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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">arg
</span>:
<span class=
"tsd-signature-type">any
</span></span></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-kind-parameter">arg
</span><span class=
"tsd-signature-keyword"> is
</span><span class=
"tsd-signature-type">any
</span><span class=
"tsd-signature-symbol">[]
</span></h4><aside class=
"tsd-sources"><p>Inherited from Array.isArray
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es5.d.ts:
1513</li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id=
"of" class=
"tsd-anchor"></a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-inherited tsd-is-external"><li class=
"tsd-signature tsd-anchor-link"><a id=
"of.of-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">of
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#of.of-1.T-6">T
</a><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><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#of.of-1.T-6">T
</a><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=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns a new array from a set of elements.
</p>
183 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"of.of-1.T-6" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">T
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><code class=
"tsd-tag ts-flagRest">Rest
</code> <span class=
"tsd-signature-symbol">...
</span><span class=
"tsd-kind-parameter">items
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#of.of-1.T-6">T
</a><span class=
"tsd-signature-symbol">[]
</span></span><div class=
"tsd-comment tsd-typography"><p>A set of elements to include in the new array object.
</p>
184 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"CircularArray.html#of.of-1.T-6">T
</a><span class=
"tsd-signature-symbol">[]
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><p>Inherited from Array.of
</p><ul><li>Defined in node_modules/.pnpm/typescript@
5.4.2/node_modules/typescript/lib/lib.es2015.core.d.ts:
84</li></ul></aside></li></ul></section></section></div><div class=
"col-sidebar"><div class=
"page-menu"><div class=
"tsd-navigation settings"><details class=
"tsd-index-accordion"><summary class=
"tsd-accordion-summary"><h3><svg width=
"20" height=
"20" viewBox=
"0 0 24 24" fill=
"none"><use href=
"../assets/icons.svg#icon-chevronDown"></use></svg>Settings
</h3></summary><div class=
"tsd-accordion-details"><div class=
"tsd-filter-visibility"><h4 class=
"uppercase">Member Visibility
</h4><form><ul id=
"tsd-filter-options"><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><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><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><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><div class=
"tsd-theme-toggle"><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><details open
class=
"tsd-index-accordion tsd-page-navigation"><summary class=
"tsd-accordion-summary"><h3><svg width=
"20" height=
"20" viewBox=
"0 0 24 24" fill=
"none"><use href=
"../assets/icons.svg#icon-chevronDown"></use></svg>On This Page
</h3></summary><div class=
"tsd-accordion-details"><a href=
"#constructor" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-512"></use></svg><span>constructor
</span></a><a href=
"#_unscopables_" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>[unscopables]
</span></a><a href=
"#length-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>length
</span></a><a href=
"#size" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>size
</span></a><a href=
"#_species_" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>[species]
</span></a><a href=
"#_iterator_-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>[iterator]
</span></a><a href=
"#at-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>at
</span></a><a href=
"#checkSize" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Size
</span></a><a href=
"#concat-1" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>concat
</span></a><a href=
"#copyWithin-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>copy
<wbr/>Within
</span></a><a href=
"#empty" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>empty
</span></a><a href=
"#entries-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>entries
</span></a><a href=
"#every-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>every
</span></a><a href=
"#fill-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>fill
</span></a><a href=
"#filter-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>filter
</span></a><a href=
"#find-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>find
</span></a><a href=
"#findIndex-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>find
<wbr/>Index
</span></a><a href=
"#flat-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>flat
</span></a><a href=
"#flatMap-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>flat
<wbr/>Map
</span></a><a href=
"#forEach-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>for
<wbr/>Each
</span></a><a href=
"#full" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>full
</span></a><a href=
"#includes-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>includes
</span></a><a href=
"#indexOf-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>index
<wbr/>Of
</span></a><a href=
"#join-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>join
</span></a><a href=
"#keys-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>keys
</span></a><a href=
"#lastIndexOf-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>last
<wbr/>Index
<wbr/>Of
</span></a><a href=
"#map-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>map
</span></a><a href=
"#pop-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>pop
</span></a><a href=
"#push-1" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>push
</span></a><a href=
"#reduce-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>reduce
</span></a><a href=
"#reduceRight-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>reduce
<wbr/>Right
</span></a><a href=
"#resize" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>resize
</span></a><a href=
"#reverse-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>reverse
</span></a><a href=
"#shift-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>shift
</span></a><a href=
"#slice-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>slice
</span></a><a href=
"#some-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>some
</span></a><a href=
"#sort-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>sort
</span></a><a href=
"#splice-1" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>splice
</span></a><a href=
"#toLocaleString-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>to
<wbr/>Locale
<wbr/>String
</span></a><a href=
"#toString-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>to
<wbr/>String
</span></a><a href=
"#unshift-1" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>unshift
</span></a><a href=
"#values-1" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>values
</span></a><a href=
"#from" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>from
</span></a><a href=
"#isArray" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>is
<wbr/>Array
</span></a><a href=
"#of" class=
"tsd-is-inherited tsd-is-external"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>of
</span></a></div></details></div><div class=
"site-menu"><nav class=
"tsd-navigation"><a href=
"../index.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1"></use></svg><span>poolifier - v3.1
.21</span></a><ul class=
"tsd-small-nested-navigation" id=
"tsd-nav-container" data-base=
".."><li>Loading...
</li></ul></nav></div></div></div><div class=
"tsd-generator"><p>Generated using
<a href=
"https://typedoc.org/" target=
"_blank">TypeDoc
</a></p></div><div class=
"overlay"></div></body></html>
repositories / poolifier.git / blob