1 <!DOCTYPE html
><html class=
"default" lang=
"en"><head><meta charSet=
"utf-8"/><meta http-equiv=
"x-ua-compatible" content=
"IE=edge"/><title>Deque | poolifier - v3.1
.28</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
.28</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=
"Deque.html">Deque
</a></li></ul><h1>Class Deque
<T
><code class=
"tsd-tag ts-flagInternal">Internal
</code> </h1></div><section class=
"tsd-panel tsd-comment"><div class=
"tsd-comment tsd-typography"><p>Deque.
2 Implemented with a doubly linked list.
</p>
3 </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 deque data.
</p>
4 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></section> <aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L22">src/deque.ts:
22</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=
"Deque.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>
5 </div></section><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Properties
</h3><div class=
"tsd-index-list"><a href=
"Deque.html#head" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>head?
</span></a>
6 <a href=
"Deque.html#maxSize" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>max
<wbr/>Size
</span></a>
7 <a href=
"Deque.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>
8 <a href=
"Deque.html#tail" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>tail?
</span></a>
9 </div></section><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Methods
</h3><div class=
"tsd-index-list"><a href=
"Deque.html#_iterator_" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>[iterator]
</span></a>
10 <a href=
"Deque.html#backward" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>backward
</span></a>
11 <a href=
"Deque.html#clear" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>clear
</span></a>
12 <a href=
"Deque.html#incrementSize" 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>increment
<wbr/>Size
</span></a>
13 <a href=
"Deque.html#peekFirst" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>peek
<wbr/>First
</span></a>
14 <a href=
"Deque.html#peekLast" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>peek
<wbr/>Last
</span></a>
15 <a href=
"Deque.html#pop" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>pop
</span></a>
16 <a href=
"Deque.html#push" 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>
17 <a href=
"Deque.html#shift" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>shift
</span></a>
18 <a href=
"Deque.html#unshift" 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>
19 </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_Deque" class=
"tsd-anchor"></a><span class=
"tsd-kind-constructor-signature">new
<wbr/>Deque
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"Deque.html#constructor.new_Deque.T-1">T
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><a href=
"Deque.html" class=
"tsd-signature-type tsd-kind-class">Deque
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"Deque.html#constructor.new_Deque.T-1">T
</a><span class=
"tsd-signature-symbol">></span><a href=
"#constructor.new_Deque" 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_Deque.T-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">T
</span></span></li></ul></section><h4 class=
"tsd-returns-title">Returns
<a href=
"Deque.html" class=
"tsd-signature-type tsd-kind-class">Deque
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"Deque.html#constructor.new_Deque.T-1">T
</a><span class=
"tsd-signature-symbol">></span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L30">src/deque.ts:
30</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-private"><a id=
"head" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <code class=
"tsd-tag ts-flagOptional">Optional
</code> <span>head
</span><a href=
"#head" 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">head
</span><span class=
"tsd-signature-symbol">?:
</span> <a href=
"../interfaces/ILinkedListNode.html" class=
"tsd-signature-type tsd-kind-interface">ILinkedListNode
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"Deque.html#constructor.new_Deque.T-1">T
</a><span class=
"tsd-signature-symbol">></span></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L23">src/deque.ts:
23</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"maxSize" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>max
<wbr/>Size
</span><a href=
"#maxSize" 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">max
<wbr/>Size
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">number
</span></div><div class=
"tsd-comment tsd-typography"><p>The maximum size of the deque.
</p>
20 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L28">src/deque.ts:
28</a></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><div class=
"tsd-comment tsd-typography"><p>The size of the deque.
</p>
21 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L26">src/deque.ts:
26</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"tail" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <code class=
"tsd-tag ts-flagOptional">Optional
</code> <span>tail
</span><a href=
"#tail" 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">tail
</span><span class=
"tsd-signature-symbol">?:
</span> <a href=
"../interfaces/ILinkedListNode.html" class=
"tsd-signature-type tsd-kind-interface">ILinkedListNode
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"Deque.html#constructor.new_Deque.T-1">T
</a><span class=
"tsd-signature-symbol">></span></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L24">src/deque.ts:
24</a></li></ul></aside></section></section><section class=
"tsd-panel-group tsd-member-group"><h2>Methods
</h2><section class=
"tsd-panel tsd-member"><a id=
"_iterator_" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>[iterator]
</span><a href=
"#_iterator_" 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=
"_iterator_._iterator_-1" 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">Iterator
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"Deque.html#constructor.new_Deque.T-1">T
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">any
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol">></span><a href=
"#_iterator_._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></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns an iterator for the deque.
</p>
22 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Iterator
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"Deque.html#constructor.new_Deque.T-1">T
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">any
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol">></span></h4><p>An iterator for the deque.
</p>
23 <div class=
"tsd-comment tsd-typography"><h4>See
</h4><p><a href=
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
</a></p>
24 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L140">src/deque.ts:
140</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"backward" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>backward
</span><a href=
"#backward" 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=
"backward.backward-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">backward
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Iterable
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"Deque.html#constructor.new_Deque.T-1">T
</a><span class=
"tsd-signature-symbol">></span><a href=
"#backward.backward-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 an backward iterator for the deque.
</p>
25 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Iterable
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"Deque.html#constructor.new_Deque.T-1">T
</a><span class=
"tsd-signature-symbol">></span></h4><p>An backward iterator for the deque.
</p>
26 <div class=
"tsd-comment tsd-typography"><h4>See
</h4><p><a href=
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
</a></p>
27 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L166">src/deque.ts:
166</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"clear" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>clear
</span><a href=
"#clear" 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=
"clear.clear-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">clear
</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=
"#clear.clear-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>Clears the deque.
</p>
28 </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"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L127">src/deque.ts:
127</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"incrementSize" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>increment
<wbr/>Size
</span><a href=
"#incrementSize" 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=
"incrementSize.incrementSize-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">increment
<wbr/>Size
</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=
"#incrementSize.incrementSize-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">number
</span></h4><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L190">src/deque.ts:
190</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"peekFirst" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>peek
<wbr/>First
</span><a href=
"#peekFirst" 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=
"peekFirst.peekFirst-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">peek
<wbr/>First
</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=
"Deque.html#constructor.new_Deque.T-1">T
</a><a href=
"#peekFirst.peekFirst-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>Peeks at the first data.
</p>
29 </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=
"Deque.html#constructor.new_Deque.T-1">T
</a></h4><p>The first data or
<code>undefined
</code> if the deque is empty.
</p>
30 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L112">src/deque.ts:
112</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"peekLast" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>peek
<wbr/>Last
</span><a href=
"#peekLast" 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=
"peekLast.peekLast-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">peek
<wbr/>Last
</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=
"Deque.html#constructor.new_Deque.T-1">T
</a><a href=
"#peekLast.peekLast-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>Peeks at the last data.
</p>
31 </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=
"Deque.html#constructor.new_Deque.T-1">T
</a></h4><p>The last data or
<code>undefined
</code> if the deque is empty.
</p>
32 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L120">src/deque.ts:
120</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"pop" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>pop
</span><a href=
"#pop" 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=
"pop.pop-1" 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=
"Deque.html#constructor.new_Deque.T-1">T
</a><a href=
"#pop.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></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Pops data from the deque.
</p>
33 </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=
"Deque.html#constructor.new_Deque.T-1">T
</a></h4><p>The popped data or
<code>undefined
</code> if the deque is empty.
</p>
34 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L73">src/deque.ts:
73</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"push" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>push
</span><a href=
"#push" 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.push-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">push
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">data
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">number
</span><a href=
"#push.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></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Appends data to the deque.
</p>
35 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">data
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"Deque.html#constructor.new_Deque.T-1">T
</a></span><div class=
"tsd-comment tsd-typography"><p>Data to append.
</p>
36 </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><p>The new size of the deque.
</p>
37 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L40">src/deque.ts:
40</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"shift" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>shift
</span><a href=
"#shift" 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=
"shift.shift-1" 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=
"Deque.html#constructor.new_Deque.T-1">T
</a><a href=
"#shift.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></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Shifts data from the deque.
</p>
38 </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=
"Deque.html#constructor.new_Deque.T-1">T
</a></h4><p>The shifted data or
<code>undefined
</code> if the deque is empty.
</p>
39 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L93">src/deque.ts:
93</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"unshift" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>unshift
</span><a href=
"#unshift" 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.unshift-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">unshift
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">data
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">number
</span><a href=
"#unshift.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></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Prepends data to the deque.
</p>
40 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">data
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"Deque.html#constructor.new_Deque.T-1">T
</a></span><div class=
"tsd-comment tsd-typography"><p>Data to prepend.
</p>
41 </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><p>The new size of the deque.
</p>
42 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/d1fc382/src/deque.ts#L57">src/deque.ts:
57</a></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=
"#head" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>head
</span></a><a href=
"#maxSize" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>max
<wbr/>Size
</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=
"#tail" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>tail
</span></a><a href=
"#_iterator_" class=
""><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=
"#backward" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>backward
</span></a><a href=
"#clear" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>clear
</span></a><a href=
"#incrementSize" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>increment
<wbr/>Size
</span></a><a href=
"#peekFirst" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>peek
<wbr/>First
</span></a><a href=
"#peekLast" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>peek
<wbr/>Last
</span></a><a href=
"#pop" class=
""><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" 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=
"#shift" class=
""><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=
"#unshift" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>unshift
</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
.28</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