data-structure-typed 2.5.2 → 2.5.3

package/docs-site-docusaurus/docs/api/classes/Queue.md

@@ -6,7 +6,7 @@
 
 # Class: Queue\<E, R\>
 
-Defined in: [data-structures/queue/queue.ts:91](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L91)
+Defined in: [data-structures/queue/queue.ts:91](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L91)
 
 Array-backed queue with amortized O(1) enqueue/dequeue via an offset pointer and optional auto-compaction.
 
@@ -115,7 +115,7 @@ Time O(1), Space O(1)
 new Queue<E, R>(elements?, options?): Queue<E, R>;
 ```
 
-Defined in: [data-structures/queue/queue.ts:100](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L100)
+Defined in: [data-structures/queue/queue.ts:100](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L100)
 
 Create a Queue and optionally bulk-insert elements.
 
@@ -157,7 +157,7 @@ Time O(N), Space O(N)
 get autoCompactRatio(): number;
 ```
 
-Defined in: [data-structures/queue/queue.ts:141](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L141)
+Defined in: [data-structures/queue/queue.ts:141](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L141)
 
 Get the compaction threshold (offset/size).
 
@@ -177,7 +177,7 @@ Auto-compaction ratio in (0,1].
 set autoCompactRatio(value): void;
 ```
 
-Defined in: [data-structures/queue/queue.ts:152](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L152)
+Defined in: [data-structures/queue/queue.ts:152](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L152)
 
 Set the compaction threshold.
 
@@ -209,7 +209,7 @@ void
 get elements(): E[];
 ```
 
-Defined in: [data-structures/queue/queue.ts:117](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L117)
+Defined in: [data-structures/queue/queue.ts:117](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L117)
 
 Get the underlying array buffer.
 
@@ -233,7 +233,7 @@ Backing array of elements.
 get first(): E | undefined;
 ```
 
-Defined in: [data-structures/queue/queue.ts:254](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L254)
+Defined in: [data-structures/queue/queue.ts:262](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L262)
 
 Get the first element (front) without removing it.
 
@@ -268,7 +268,7 @@ Front element or undefined.
 get last(): E | undefined;
 ```
 
-Defined in: [data-structures/queue/queue.ts:264](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L264)
+Defined in: [data-structures/queue/queue.ts:281](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L281)
 
 Get the last element (back) without removing it.
 
@@ -292,7 +292,7 @@ Back element or undefined.
 get length(): number;
 ```
 
-Defined in: [data-structures/queue/queue.ts:204](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L204)
+Defined in: [data-structures/queue/queue.ts:208](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L208)
 
 Get the number of elements currently in the queue.
 
@@ -333,7 +333,7 @@ Current length.
 get maxLen(): number;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:100](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L100)
+Defined in: [data-structures/base/linear-base.ts:100](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L100)
 
 Upper bound for length (if positive), or `-1` when unbounded.
 
@@ -361,7 +361,7 @@ Maximum allowed length.
 get offset(): number;
 ```
 
-Defined in: [data-structures/queue/queue.ts:129](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L129)
+Defined in: [data-structures/queue/queue.ts:129](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L129)
 
 Get the current start offset into the array.
 
@@ -385,7 +385,7 @@ Zero-based offset.
 get toElementFn(): ((rawElement) => E) | undefined;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:48](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L48)
+Defined in: [data-structures/base/iterable-element-base.ts:48](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L48)
 
 Exposes the current `toElementFn`, if configured.
 
@@ -411,7 +411,7 @@ The converter function or `undefined` when not set.
 iterator: IterableIterator<E>;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:61](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L61)
+Defined in: [data-structures/base/iterable-element-base.ts:61](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L61)
 
 Returns an iterator over the structure's elements.
 
@@ -445,7 +445,7 @@ Producing the iterator is O(1); consuming the entire iterator is Time O(n) with
 addAt(index, newElement): boolean;
 ```
 
-Defined in: [data-structures/queue/queue.ts:605](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L605)
+Defined in: [data-structures/queue/queue.ts:642](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L642)
 
 Insert a new element at a given index.
 
@@ -485,7 +485,7 @@ Time O(N), Space O(1)
 at(index): E | undefined;
 ```
 
-Defined in: [data-structures/queue/queue.ts:578](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L578)
+Defined in: [data-structures/queue/queue.ts:615](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L615)
 
 Get the element at a given logical index.
 
@@ -530,7 +530,7 @@ Time O(1), Space O(1)
 clear(): void;
 ```
 
-Defined in: [data-structures/queue/queue.ts:681](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L681)
+Defined in: [data-structures/queue/queue.ts:738](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L738)
 
 Remove all elements and reset offset.
 
@@ -567,7 +567,7 @@ Time O(1), Space O(1)
 clone(): this;
 ```
 
-Defined in: [data-structures/queue/queue.ts:808](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L808)
+Defined in: [data-structures/queue/queue.ts:873](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L873)
 
 Deep clone this queue and its parameters.
 
@@ -606,7 +606,7 @@ Time O(N), Space O(N)
 compact(): boolean;
 ```
 
-Defined in: [data-structures/queue/queue.ts:731](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L731)
+Defined in: [data-structures/queue/queue.ts:792](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L792)
 
 Compact storage by discarding consumed head elements.
 
@@ -641,7 +641,7 @@ Time O(N), Space O(N)
 concat(...items): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:165](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L165)
+Defined in: [data-structures/base/linear-base.ts:165](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L165)
 
 Concatenate elements and/or containers.
 
@@ -675,7 +675,7 @@ Time O(sum(length)), Space O(sum(length))
 delete(element): boolean;
 ```
 
-Defined in: [data-structures/queue/queue.ts:524](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L524)
+Defined in: [data-structures/queue/queue.ts:557](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L557)
 
 Delete the first occurrence of a specific element.
 
@@ -720,7 +720,7 @@ Time O(N), Space O(1)
 deleteAt(index): E | undefined;
 ```
 
-Defined in: [data-structures/queue/queue.ts:590](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L590)
+Defined in: [data-structures/queue/queue.ts:627](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L627)
 
 Delete the element at a given index.
 
@@ -748,13 +748,43 @@ Time O(N), Space O(1)
 
 ***
 
+### deleteWhere()
+
+```ts
+deleteWhere(predicate): boolean;
+```
+
+Defined in: [data-structures/queue/queue.ts:668](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L668)
+
+Delete the first element that satisfies a predicate.
+
+#### Parameters
+
+##### predicate
+
+(`value`, `index`, `queue`) => `boolean`
+
+Function (value, index, queue) → boolean to decide deletion.
+
+#### Returns
+
+`boolean`
+
+True if a match was removed.
+
+#### Remarks
+
+Time O(N), Space O(N)
+
+***
+
 ### every()
 
 ```ts
 every(predicate, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:87](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L87)
+Defined in: [data-structures/base/iterable-element-base.ts:87](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L87)
 
 Tests whether all elements satisfy the predicate.
 
@@ -797,7 +827,7 @@ fill(
    end?): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:292](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L292)
+Defined in: [data-structures/base/linear-base.ts:292](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L292)
 
 Fill a range with a value.
 
@@ -843,7 +873,7 @@ Time O(n), Space O(1)
 filter(predicate, thisArg?): this;
 ```
 
-Defined in: [data-structures/queue/queue.ts:861](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L861)
+Defined in: [data-structures/queue/queue.ts:930](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L930)
 
 Filter elements into a new queue of the same class.
 
@@ -896,7 +926,7 @@ Time O(N), Space O(N)
 find<S>(predicate, thisArg?): S | undefined;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:163](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L163)
+Defined in: [data-structures/base/iterable-element-base.ts:163](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L163)
 
 Finds the first element that satisfies the predicate and returns it.
 
@@ -942,7 +972,7 @@ Time O(n) in the worst case; may exit early on the first match. Space O(1).
 find(predicate, thisArg?): E | undefined;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:164](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L164)
+Defined in: [data-structures/base/iterable-element-base.ts:164](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L164)
 
 Finds the first element that satisfies the predicate and returns it.
 
@@ -984,7 +1014,7 @@ Time O(n) in the worst case; may exit early on the first match. Space O(1).
 findIndex(predicate, thisArg?): number;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:151](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L151)
+Defined in: [data-structures/base/linear-base.ts:151](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L151)
 
 Find the first index matching a predicate.
 
@@ -1024,7 +1054,7 @@ Time O(n), Space O(1)
 forEach(callbackfn, thisArg?): void;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:133](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L133)
+Defined in: [data-structures/base/iterable-element-base.ts:133](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L133)
 
 Invokes a callback for each element in iteration order.
 
@@ -1064,7 +1094,7 @@ Time O(n), Space O(1).
 has(element): boolean;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:189](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L189)
+Defined in: [data-structures/base/iterable-element-base.ts:189](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L189)
 
 Checks whether a strictly-equal element exists in the structure.
 
@@ -1098,7 +1128,7 @@ Time O(n) in the worst case. Space O(1).
 indexOf(searchElement, fromIndex?): number;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:111](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L111)
+Defined in: [data-structures/base/linear-base.ts:111](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L111)
 
 First index of a value from the left.
 
@@ -1138,7 +1168,7 @@ Time O(n), Space O(1)
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/queue/queue.ts:339](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L339)
+Defined in: [data-structures/queue/queue.ts:360](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L360)
 
 Check whether the queue is empty.
 
@@ -1188,7 +1218,7 @@ Time O(1), Space O(1)
 join(separator?): string;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:228](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L228)
+Defined in: [data-structures/base/linear-base.ts:228](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L228)
 
 Join all elements into a string.
 
@@ -1222,7 +1252,7 @@ Time O(n), Space O(n)
 lastIndexOf(searchElement, fromIndex?): number;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:131](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L131)
+Defined in: [data-structures/base/linear-base.ts:131](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L131)
 
 Last index of a value from the right.
 
@@ -1265,7 +1295,7 @@ map<EM, RM>(
 thisArg?): Queue<EM, RM>;
 ```
 
-Defined in: [data-structures/queue/queue.ts:920](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L920)
+Defined in: [data-structures/queue/queue.ts:993](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L993)
 
 Map each element to a new element in a possibly different-typed queue.
 
@@ -1332,7 +1362,7 @@ Time O(N), Space O(N)
 mapSame(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/queue/queue.ts:943](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L943)
+Defined in: [data-structures/queue/queue.ts:1016](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1016)
 
 Map each element to a new value of the same type.
 
@@ -1366,13 +1396,35 @@ Time O(N), Space O(N)
 
 ***
 
+### peek()
+
+```ts
+peek(): E | undefined;
+```
+
+Defined in: [data-structures/queue/queue.ts:271](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L271)
+
+Peek at the front element without removing it (alias for `first`).
+
+#### Returns
+
+`E` \| `undefined`
+
+Front element or undefined.
+
+#### Remarks
+
+Time O(1), Space O(1)
+
+***
+
 ### print()
 
 ```ts
 print(): void;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:269](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L269)
+Defined in: [data-structures/base/iterable-element-base.ts:269](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L269)
 
 Prints `toVisual()` to the console. Intended for quick debugging.
 
@@ -1398,7 +1450,7 @@ Time O(n) due to materialization, Space O(n) for the intermediate representation
 push(element): boolean;
 ```
 
-Defined in: [data-structures/queue/queue.ts:395](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L395)
+Defined in: [data-structures/queue/queue.ts:420](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L420)
 
 Enqueue one element at the back.
 
@@ -1448,7 +1500,7 @@ Time O(1), Space O(1)
 pushMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/queue/queue.ts:408](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L408)
+Defined in: [data-structures/queue/queue.ts:433](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L433)
 
 Enqueue many elements from an iterable.
 
@@ -1514,7 +1566,7 @@ Time O(n), Space O(1). Throws if called on an empty structure without `initialVa
 reduce(callbackfn): E;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:194](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L194)
+Defined in: [data-structures/base/iterable-element-base.ts:194](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L194)
 
 ##### Parameters
 
@@ -1536,7 +1588,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:194](https://github.c
 reduce(callbackfn, initialValue): E;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:195](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L195)
+Defined in: [data-structures/base/iterable-element-base.ts:195](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L195)
 
 ##### Parameters
 
@@ -1562,7 +1614,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:195](https://github.c
 reduce<U>(callbackfn, initialValue): U;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:196](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L196)
+Defined in: [data-structures/base/iterable-element-base.ts:196](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L196)
 
 ##### Type Parameters
 
@@ -1596,7 +1648,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:196](https://github.c
 reduceRight<U>(callbackfn, initialValue): U;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:256](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L256)
+Defined in: [data-structures/base/linear-base.ts:256](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L256)
 
 Right-to-left reduction over elements.
 
@@ -1642,7 +1694,7 @@ Time O(n), Space O(1)
 reverse(): this;
 ```
 
-Defined in: [data-structures/queue/queue.ts:631](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L631)
+Defined in: [data-structures/queue/queue.ts:684](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L684)
 
 Reverse the queue in-place by compacting then reversing.
 
@@ -1668,7 +1720,7 @@ Time O(N), Space O(N)
 setAt(index, newElement): boolean;
 ```
 
-Defined in: [data-structures/queue/queue.ts:619](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L619)
+Defined in: [data-structures/queue/queue.ts:656](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L656)
 
 Replace the element at a given index.
 
@@ -1708,7 +1760,7 @@ Time O(1), Space O(1)
 shift(): E | undefined;
 ```
 
-Defined in: [data-structures/queue/queue.ts:472](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L472)
+Defined in: [data-structures/queue/queue.ts:501](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L501)
 
 Dequeue one element from the front (amortized via offset).
 
@@ -1750,7 +1802,7 @@ Time O(1) amortized, Space O(1)
 slice(start?, end?): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:273](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L273)
+Defined in: [data-structures/base/linear-base.ts:273](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L273)
 
 Create a shallow copy of a subrange.
 
@@ -1790,7 +1842,7 @@ Time O(n), Space O(n)
 some(predicate, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:110](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L110)
+Defined in: [data-structures/base/iterable-element-base.ts:110](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L110)
 
 Tests whether at least one element satisfies the predicate.
 
@@ -1830,7 +1882,7 @@ Time O(n) in the worst case; may exit early on first success. Space O(1).
 sort(compareFn?): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:185](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L185)
+Defined in: [data-structures/base/linear-base.ts:185](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L185)
 
 In-place stable order via array sort semantics.
 
@@ -1867,7 +1919,7 @@ splice(
    items?): this;
 ```
 
-Defined in: [data-structures/queue/queue.ts:746](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L746)
+Defined in: [data-structures/queue/queue.ts:807](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L807)
 
 Remove and/or insert elements at a position (array-like).
 
@@ -1913,7 +1965,7 @@ Time O(N + M), Space O(M)
 toArray(): E[];
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:246](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L246)
+Defined in: [data-structures/base/iterable-element-base.ts:246](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L246)
 
 Materializes the elements into a new array.
 
@@ -1939,7 +1991,7 @@ Time O(n), Space O(n).
 toReversedArray(): E[];
 ```
 
-Defined in: [data-structures/base/linear-base.ts:237](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/linear-base.ts#L237)
+Defined in: [data-structures/base/linear-base.ts:237](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L237)
 
 Snapshot elements into a reversed array.
 
@@ -1965,7 +2017,7 @@ Time O(n), Space O(n)
 toVisual(): E[];
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:258](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L258)
+Defined in: [data-structures/base/iterable-element-base.ts:258](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L258)
 
 Returns a representation of the structure suitable for quick visualization.
 Defaults to an array of elements; subclasses may override to provide richer visuals.
@@ -1992,7 +2044,7 @@ Time O(n), Space O(n).
 values(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:72](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L72)
+Defined in: [data-structures/base/iterable-element-base.ts:72](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L72)
 
 Returns an iterator over the values (alias of the default iterator).
 
@@ -2018,7 +2070,7 @@ Creating the iterator is O(1); full iteration is Time O(n), Space O(1).
 static fromArray<E>(elements): Queue<E>;
 ```
 
-Defined in: [data-structures/queue/queue.ts:276](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L276)
+Defined in: [data-structures/queue/queue.ts:293](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L293)
 
 Create a queue from an array of elements.
 
@@ -2057,7 +2109,7 @@ Time O(N), Space O(N)
 protected optional _toElementFn?: (rawElement) => E;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:39](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/base/iterable-element-base.ts#L39)
+Defined in: [data-structures/base/iterable-element-base.ts:39](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L39)
 
 The converter used to transform a raw element (`R`) into a public element (`E`).
 
@@ -2087,7 +2139,7 @@ Time O(1), Space O(1).
 protected _createInstance(options?): this;
 ```
 
-Defined in: [data-structures/queue/queue.ts:1003](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L1003)
+Defined in: [data-structures/queue/queue.ts:1076](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1076)
 
 (Protected) Create an empty instance of the same concrete class.
 
@@ -2121,7 +2173,7 @@ Time O(1), Space O(1)
 protected _createLike<EM, RM>(elements?, options?): Queue<EM, RM>;
 ```
 
-Defined in: [data-structures/queue/queue.ts:1018](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L1018)
+Defined in: [data-structures/queue/queue.ts:1091](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1091)
 
 (Protected) Create a like-kind queue and seed it from an iterable.
 
@@ -2167,7 +2219,7 @@ Time O(N), Space O(N)
 protected _getIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/queue/queue.ts:979](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L979)
+Defined in: [data-structures/queue/queue.ts:1052](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1052)
 
 (Protected) Iterate elements from front to back.
 
@@ -2193,7 +2245,7 @@ Time O(N), Space O(1)
 protected _getReverseIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/queue/queue.ts:989](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L989)
+Defined in: [data-structures/queue/queue.ts:1062](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1062)
 
 (Protected) Iterate elements from back to front.
 
@@ -2219,7 +2271,7 @@ Time O(N), Space O(1)
 protected _setAutoCompactRatio(value): void;
 ```
 
-Defined in: [data-structures/queue/queue.ts:969](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/queue.ts#L969)
+Defined in: [data-structures/queue/queue.ts:1042](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1042)
 
 (Protected) Set the internal auto-compaction ratio.