data-structure-typed 2.5.2 → 2.6.0

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

@@ -6,7 +6,7 @@
 
 # Class: Deque\<E, R\>
 
-Defined in: [data-structures/queue/deque.ts:85](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L85)
+Defined in: [data-structures/queue/deque.ts:85](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L85)
 
 Deque implemented with circular buckets allowing O(1) amortized push/pop at both ends.
 
@@ -103,7 +103,7 @@ Time O(1), Space O(1)
 new Deque<E, R>(elements?, options?): Deque<E, R>;
 ```
 
-Defined in: [data-structures/queue/deque.ts:96](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L96)
+Defined in: [data-structures/queue/deque.ts:96](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L96)
 
 Create a Deque and optionally bulk-insert elements.
 
@@ -145,7 +145,7 @@ Time O(N), Space O(N)
 get autoCompactRatio(): number;
 ```
 
-Defined in: [data-structures/queue/deque.ts:145](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L145)
+Defined in: [data-structures/queue/deque.ts:145](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L145)
 
 Get the auto-compaction ratio.
 When `elements / (bucketCount * bucketSize)` drops below this ratio after
@@ -167,7 +167,7 @@ Current ratio threshold. 0 means auto-compact is disabled.
 set autoCompactRatio(value): void;
 ```
 
-Defined in: [data-structures/queue/deque.ts:154](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L154)
+Defined in: [data-structures/queue/deque.ts:154](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L154)
 
 Set the auto-compaction ratio.
 
@@ -197,7 +197,7 @@ Ratio in [0,1]. 0 disables auto-compact.
 get bucketCount(): number;
 ```
 
-Defined in: [data-structures/queue/deque.ts:220](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L220)
+Defined in: [data-structures/queue/deque.ts:220](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L220)
 
 Get the number of buckets allocated.
 
@@ -221,7 +221,7 @@ Bucket count.
 get bucketFirst(): number;
 ```
 
-Defined in: [data-structures/queue/deque.ts:172](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L172)
+Defined in: [data-structures/queue/deque.ts:172](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L172)
 
 Get the index of the first bucket in use.
 
@@ -245,7 +245,7 @@ Zero-based bucket index.
 get bucketLast(): number;
 ```
 
-Defined in: [data-structures/queue/deque.ts:196](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L196)
+Defined in: [data-structures/queue/deque.ts:196](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L196)
 
 Get the index of the last bucket in use.
 
@@ -269,7 +269,7 @@ Zero-based bucket index.
 get buckets(): E[][];
 ```
 
-Defined in: [data-structures/queue/deque.ts:232](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L232)
+Defined in: [data-structures/queue/deque.ts:232](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L232)
 
 Get the internal buckets array.
 
@@ -293,7 +293,7 @@ Array of buckets storing values.
 get bucketSize(): number;
 ```
 
-Defined in: [data-structures/queue/deque.ts:132](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L132)
+Defined in: [data-structures/queue/deque.ts:132](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L132)
 
 Get the current bucket size.
 
@@ -317,13 +317,9 @@ Bucket capacity per bucket.
 get first(): E | undefined;
 ```
 
-Defined in: [data-structures/queue/deque.ts:303](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L303)
+Defined in: [data-structures/queue/deque.ts:332](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L332)
 
-Get the first element without removing it.
-
-##### Remarks
-
-Time O(1), Space O(1)
+Deque peek at both ends
 
 ##### Example
 
@@ -347,10 +343,6 @@ Time O(1), Space O(1)
 
 `E` \| `undefined`
 
-First element or undefined.
-
- *
-
 ***
 
 ### firstInBucket
@@ -361,7 +353,7 @@ First element or undefined.
 get firstInBucket(): number;
 ```
 
-Defined in: [data-structures/queue/deque.ts:184](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L184)
+Defined in: [data-structures/queue/deque.ts:184](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L184)
 
 Get the index inside the first bucket.
 
@@ -385,7 +377,7 @@ Zero-based index within the first bucket.
 get last(): E | undefined;
 ```
 
-Defined in: [data-structures/queue/deque.ts:354](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L354)
+Defined in: [data-structures/queue/deque.ts:387](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L387)
 
 Get the last element without removing it.
 
@@ -420,7 +412,7 @@ Last element or undefined.
 get lastInBucket(): number;
 ```
 
-Defined in: [data-structures/queue/deque.ts:208](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L208)
+Defined in: [data-structures/queue/deque.ts:208](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L208)
 
 Get the index inside the last bucket.
 
@@ -444,7 +436,7 @@ Zero-based index within the last bucket.
 get length(): number;
 ```
 
-Defined in: [data-structures/queue/deque.ts:244](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L244)
+Defined in: [data-structures/queue/deque.ts:244](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L244)
 
 Get the number of elements in the deque.
 
@@ -472,7 +464,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.
 
@@ -500,7 +492,7 @@ Maximum allowed length.
 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.
 
@@ -526,7 +518,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.
 
@@ -563,7 +555,7 @@ addAt(
    num?): boolean;
 ```
 
-Defined in: [data-structures/queue/deque.ts:876](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L876)
+Defined in: [data-structures/queue/deque.ts:937](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L937)
 
 Insert repeated copies of an element at a position.
 
@@ -609,7 +601,7 @@ Time O(N), Space O(1)
 at(pos): E | undefined;
 ```
 
-Defined in: [data-structures/queue/deque.ts:846](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L846)
+Defined in: [data-structures/queue/deque.ts:907](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L907)
 
 Get the element at a given position.
 
@@ -654,7 +646,7 @@ Time O(1), Space O(1)
 clear(): void;
 ```
 
-Defined in: [data-structures/queue/deque.ts:795](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L795)
+Defined in: [data-structures/queue/deque.ts:852](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L852)
 
 Remove all elements and reset structure.
 
@@ -691,7 +683,7 @@ Time O(1), Space O(1)
 clone(): this;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1358](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1358)
+Defined in: [data-structures/queue/deque.ts:1435](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1435)
 
 Deep clone this deque, preserving options.
 
@@ -730,7 +722,7 @@ Time O(N), Space O(N)
 compact(): boolean;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1284](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1284)
+Defined in: [data-structures/queue/deque.ts:1357](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1357)
 
 Compact the deque by removing unused buckets.
 
@@ -765,7 +757,7 @@ Time O(N), Space O(1)
 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.
 
@@ -799,7 +791,7 @@ Time O(sum(length)), Space O(sum(length))
 cut(pos, isCutSelf?): Deque<E>;
 ```
 
-Defined in: [data-structures/queue/deque.ts:904](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L904)
+Defined in: [data-structures/queue/deque.ts:965](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L965)
 
 Cut the deque to keep items up to index; optionally mutate in-place.
 
@@ -835,7 +827,7 @@ Time O(N), Space O(1)
 cutRest(pos, isCutSelf?): Deque<E>;
 ```
 
-Defined in: [data-structures/queue/deque.ts:971](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L971)
+Defined in: [data-structures/queue/deque.ts:1032](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1032)
 
 Cut the deque to keep items from index onward; optionally mutate in-place.
 
@@ -871,7 +863,7 @@ Time O(N), Space O(1)
 delete(element): boolean;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1070](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1070)
+Defined in: [data-structures/queue/deque.ts:1135](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1135)
 
 Delete the first occurrence of a value.
 
@@ -916,7 +908,7 @@ Time O(N), Space O(1)
 deleteAt(pos): E | undefined;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1000](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1000)
+Defined in: [data-structures/queue/deque.ts:1061](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1061)
 
 Delete the element at a given position.
 
@@ -950,7 +942,7 @@ Time O(N), Space O(1)
 deleteWhere(predicate): boolean;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1094](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1094)
+Defined in: [data-structures/queue/deque.ts:1159](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1159)
 
 Delete the first element matching a predicate.
 
@@ -980,7 +972,7 @@ Time O(N), Space O(1)
 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.
 
@@ -1023,7 +1015,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.
 
@@ -1069,7 +1061,7 @@ Time O(n), Space O(1)
 filter(predicate, thisArg?): this;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1412](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1412)
+Defined in: [data-structures/queue/deque.ts:1493](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1493)
 
 Filter elements into a new deque of the same class.
 
@@ -1122,7 +1114,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.
 
@@ -1168,7 +1160,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.
 
@@ -1210,7 +1202,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.
 
@@ -1250,7 +1242,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.
 
@@ -1290,7 +1282,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.
 
@@ -1324,7 +1316,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.
 
@@ -1364,7 +1356,7 @@ Time O(n), Space O(1)
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/queue/deque.ts:747](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L747)
+Defined in: [data-structures/queue/deque.ts:800](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L800)
 
 Check whether the deque is empty.
 
@@ -1400,7 +1392,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.
 
@@ -1434,7 +1426,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.
 
@@ -1477,7 +1469,7 @@ map<EM, RM>(
 thisArg?): Deque<EM, RM>;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1490](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1490)
+Defined in: [data-structures/queue/deque.ts:1575](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1575)
 
 Map elements into a new deque (possibly different element type).
 
@@ -1544,7 +1536,7 @@ Time O(N), Space O(N)
 mapSame(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1431](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1431)
+Defined in: [data-structures/queue/deque.ts:1512](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1512)
 
 Map elements into a new deque of the same element type.
 
@@ -1578,13 +1570,35 @@ Time O(N), Space O(N)
 
 ***
 
+### peek()
+
+```ts
+peek(): E | undefined;
+```
+
+Defined in: [data-structures/queue/deque.ts:311](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L311)
+
+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)
+
+***
+
 ### pop()
 
 ```ts
 pop(): E | undefined;
 ```
 
-Defined in: [data-structures/queue/deque.ts:506](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L506)
+Defined in: [data-structures/queue/deque.ts:547](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L547)
 
 Remove and return the last element.
 
@@ -1617,7 +1631,7 @@ Time O(1), Space O(1)
 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.
 
@@ -1643,7 +1657,7 @@ Time O(n) due to materialization, Space O(n) for the intermediate representation
 push(element): boolean;
 ```
 
-Defined in: [data-structures/queue/deque.ts:441](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L441)
+Defined in: [data-structures/queue/deque.ts:478](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L478)
 
 Append one element at the back.
 
@@ -1701,7 +1715,7 @@ Time O(1) amortized, Space O(1)
 pushMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/queue/deque.ts:673](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L673)
+Defined in: [data-structures/queue/deque.ts:722](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L722)
 
 Append a sequence of elements.
 
@@ -1767,7 +1781,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
 
@@ -1789,7 +1803,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
 
@@ -1815,7 +1829,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
 
@@ -1849,7 +1863,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.
 
@@ -1895,7 +1909,7 @@ Time O(n), Space O(1)
 reverse(): this;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1176](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1176)
+Defined in: [data-structures/queue/deque.ts:1245](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1245)
 
 Reverse the deque by reversing buckets and pointers.
 
@@ -1945,7 +1959,7 @@ Time O(N), Space O(N)
 setAt(pos, element): boolean;
 ```
 
-Defined in: [data-structures/queue/deque.ts:860](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L860)
+Defined in: [data-structures/queue/deque.ts:921](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L921)
 
 Replace the element at a given position.
 
@@ -1985,7 +1999,7 @@ Time O(1), Space O(1)
 setEquality(equals): this;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1112](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1112)
+Defined in: [data-structures/queue/deque.ts:1177](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1177)
 
 Set the equality comparator used by delete operations.
 
@@ -2015,7 +2029,7 @@ Time O(1), Space O(1)
 shift(): E | undefined;
 ```
 
-Defined in: [data-structures/queue/deque.ts:571](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L571)
+Defined in: [data-structures/queue/deque.ts:616](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L616)
 
 Remove and return the first element.
 
@@ -2048,7 +2062,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.
 
@@ -2088,7 +2102,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.
 
@@ -2128,7 +2142,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.
 
@@ -2165,7 +2179,7 @@ splice(
    items?): this;
 ```
 
-Defined in: [data-structures/queue/deque.ts:936](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L936)
+Defined in: [data-structures/queue/deque.ts:997](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L997)
 
 Remove and/or insert elements at a position (array-like behavior).
 
@@ -2211,7 +2225,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.
 
@@ -2237,7 +2251,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.
 
@@ -2263,7 +2277,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.
@@ -2290,7 +2304,7 @@ Time O(n), Space O(n).
 unique(): this;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1194](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1194)
+Defined in: [data-structures/queue/deque.ts:1263](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1263)
 
 Deduplicate consecutive equal elements in-place.
 
@@ -2312,7 +2326,7 @@ Time O(N), Space O(1)
 unshift(element): boolean;
 ```
 
-Defined in: [data-structures/queue/deque.ts:647](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L647)
+Defined in: [data-structures/queue/deque.ts:696](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L696)
 
 Prepend one element at the front.
 
@@ -2363,7 +2377,7 @@ Time O(1) amortized, Space O(1)
 unshiftMany(elements?): boolean[];
 ```
 
-Defined in: [data-structures/queue/deque.ts:692](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L692)
+Defined in: [data-structures/queue/deque.ts:741](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L741)
 
 Prepend a sequence of elements.
 
@@ -2393,7 +2407,7 @@ Time O(N), Space O(1)
 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).
 
@@ -2422,7 +2436,7 @@ static fromArray<E, R>(
    options?): any;
 ```
 
-Defined in: [data-structures/queue/deque.ts:370](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L370)
+Defined in: [data-structures/queue/deque.ts:403](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L403)
 
 Create a Deque from an array of elements.
 
@@ -2477,7 +2491,7 @@ Time O(N), Space O(N)
 protected _compactCounter: number = 0;
 ```
 
-Defined in: [data-structures/queue/deque.ts:162](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L162)
+Defined in: [data-structures/queue/deque.ts:162](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L162)
 
 Counter for shift/pop operations since last compaction check.
 Only checks ratio every `_bucketSize` operations to minimize overhead.
@@ -2490,7 +2504,7 @@ Only checks ratio every `_bucketSize` operations to minimize overhead.
 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`).
 
@@ -2520,7 +2534,7 @@ Time O(1), Space O(1).
 protected _autoCompact(): void;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1222](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1222)
+Defined in: [data-structures/queue/deque.ts:1291](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1291)
 
 (Protected) Trigger auto-compaction if space utilization drops below threshold.
 Only checks every `_bucketSize` operations to minimize hot-path overhead.
@@ -2538,7 +2552,7 @@ Uses element-based ratio: `elements / (bucketCount * bucketSize)`.
 protected _createInstance(options?): this;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1605](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1605)
+Defined in: [data-structures/queue/deque.ts:1690](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1690)
 
 (Protected) Create an empty instance of the same concrete class.
 
@@ -2572,7 +2586,7 @@ Time O(1), Space O(1)
 protected _createLike<T, RR>(elements?, options?): Deque<T, RR>;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1623](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1623)
+Defined in: [data-structures/queue/deque.ts:1708](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1708)
 
 (Protected) Create a like-kind deque seeded by elements.
 
@@ -2618,7 +2632,7 @@ Time O(N), Space O(N)
 protected _getBucketAndPosition(pos): object;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1579](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1579)
+Defined in: [data-structures/queue/deque.ts:1664](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1664)
 
 (Protected) Translate a logical position to bucket/offset.
 
@@ -2660,7 +2674,7 @@ Time O(1), Space O(1)
 protected _getIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1536](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1536)
+Defined in: [data-structures/queue/deque.ts:1621](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1621)
 
 (Protected) Iterate elements from front to back.
 
@@ -2686,7 +2700,7 @@ Time O(N), Space O(1)
 protected _getReverseIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1640](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1640)
+Defined in: [data-structures/queue/deque.ts:1725](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1725)
 
 (Protected) Iterate elements from back to front.
 
@@ -2712,7 +2726,7 @@ Time O(N), Space O(1)
 protected _reallocate(needBucketNum?): void;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1550](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1550)
+Defined in: [data-structures/queue/deque.ts:1635](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1635)
 
 (Protected) Reallocate buckets to make room near the ends.
 
@@ -2742,7 +2756,7 @@ Time O(N), Space O(N)
 protected _setBucketSize(size): void;
 ```
 
-Defined in: [data-structures/queue/deque.ts:1516](https://github.com/zrwusa/data-structure-typed/blob/8292cb978daf85ebe846186c7c7572aece04fb7b/src/data-structures/queue/deque.ts#L1516)
+Defined in: [data-structures/queue/deque.ts:1601](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/deque.ts#L1601)
 
 (Protected) Set the internal bucket size.