data-structure-typed 2.5.1 → 2.5.3

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

@@ -6,7 +6,7 @@
 
 # Class: Stack\<E, R\>
 
-Defined in: [data-structures/stack/stack.ts:135](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L135)
+Defined in: [data-structures/stack/stack.ts:135](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L135)
 
 LIFO stack with array storage and optional record→element conversion.
 
@@ -170,7 +170,7 @@ Time O(1), Space O(1)
 new Stack<E, R>(elements?, options?): Stack<E, R>;
 ```
 
-Defined in: [data-structures/stack/stack.ts:146](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L146)
+Defined in: [data-structures/stack/stack.ts:146](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L146)
 
 Create a Stack and optionally bulk-push elements.
 
@@ -212,7 +212,7 @@ Time O(N), Space O(N)
 get elements(): E[];
 ```
 
-Defined in: [data-structures/stack/stack.ts:159](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L159)
+Defined in: [data-structures/stack/stack.ts:159](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L159)
 
 Get the backing array of elements.
 
@@ -236,7 +236,7 @@ Internal elements array.
 get size(): number;
 ```
 
-Defined in: [data-structures/stack/stack.ts:199](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L199)
+Defined in: [data-structures/stack/stack.ts:210](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L210)
 
 Get the number of stored elements.
 
@@ -270,7 +270,7 @@ Current size.
 get toElementFn(): ((rawElement) => E) | undefined;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:47](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L47)
+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.
 
@@ -296,7 +296,7 @@ The converter function or `undefined` when not set.
 iterator: IterableIterator<E>;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:60](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L60)
+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.
 
@@ -330,7 +330,7 @@ Producing the iterator is O(1); consuming the entire iterator is Time O(n) with
 clear(): void;
 ```
 
-Defined in: [data-structures/stack/stack.ts:544](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L544)
+Defined in: [data-structures/stack/stack.ts:621](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L621)
 
 Remove all elements and reset storage.
 
@@ -367,7 +367,7 @@ Time O(1), Space O(1)
 clone(): this;
 ```
 
-Defined in: [data-structures/stack/stack.ts:587](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L587)
+Defined in: [data-structures/stack/stack.ts:675](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L675)
 
 Deep clone this stack.
 
@@ -406,7 +406,7 @@ Time O(N), Space O(N)
 delete(element): boolean;
 ```
 
-Defined in: [data-structures/stack/stack.ts:472](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L472)
+Defined in: [data-structures/stack/stack.ts:538](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L538)
 
 Delete the first occurrence of a specific element.
 
@@ -444,10 +444,10 @@ Time O(N), Space O(1)
 ### deleteAt()
 
 ```ts
-deleteAt(index): boolean;
+deleteAt(index): E | undefined;
 ```
 
-Defined in: [data-structures/stack/stack.ts:484](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L484)
+Defined in: [data-structures/stack/stack.ts:550](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L550)
 
 Delete the element at an index.
 
@@ -461,9 +461,9 @@ Zero-based index from the bottom.
 
 #### Returns
 
-`boolean`
+`E` \| `undefined`
 
-True if removed.
+The removed element, or undefined if the index is out of range.
 
 #### Remarks
 
@@ -477,7 +477,7 @@ Time O(N), Space O(1)
 deleteWhere(predicate): boolean;
 ```
 
-Defined in: [data-structures/stack/stack.ts:497](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L497)
+Defined in: [data-structures/stack/stack.ts:563](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L563)
 
 Delete the first element that satisfies a predicate.
 
@@ -507,7 +507,7 @@ Time O(N), Space O(1)
 every(predicate, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:86](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L86)
+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.
 
@@ -547,7 +547,7 @@ Time O(n) in the worst case; may exit early when the first failure is found. Spa
 filter(predicate, thisArg?): this;
 ```
 
-Defined in: [data-structures/stack/stack.ts:632](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L632)
+Defined in: [data-structures/stack/stack.ts:731](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L731)
 
 Filter elements into a new stack of the same class.
 
@@ -600,7 +600,7 @@ Time O(N), Space O(N)
 find<S>(predicate, thisArg?): S | undefined;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:162](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L162)
+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.
 
@@ -646,7 +646,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:163](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L163)
+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.
 
@@ -688,7 +688,7 @@ Time O(n) in the worst case; may exit early on the first match. Space O(1).
 forEach(callbackfn, thisArg?): void;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:132](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L132)
+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.
 
@@ -728,7 +728,7 @@ Time O(n), Space O(1).
 has(element): boolean;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:188](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L188)
+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.
 
@@ -762,7 +762,7 @@ Time O(n) in the worst case. Space O(1).
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/stack/stack.ts:262](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L262)
+Defined in: [data-structures/stack/stack.ts:284](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L284)
 
 Check whether the stack is empty.
 
@@ -803,7 +803,7 @@ map<EM, RM>(
 thisArg?): Stack<EM, RM>;
 ```
 
-Defined in: [data-structures/stack/stack.ts:701](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L701)
+Defined in: [data-structures/stack/stack.ts:811](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L811)
 
 Map values into a new stack (possibly different element type).
 
@@ -870,7 +870,7 @@ Time O(N), Space O(N)
 mapSame(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/stack/stack.ts:650](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L650)
+Defined in: [data-structures/stack/stack.ts:749](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L749)
 
 Map values into a new stack of the same element type.
 
@@ -910,7 +910,7 @@ Time O(N), Space O(N)
 peek(): E | undefined;
 ```
 
-Defined in: [data-structures/stack/stack.ts:305](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L305)
+Defined in: [data-structures/stack/stack.ts:338](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L338)
 
 Get the top element without removing it.
 
@@ -943,7 +943,7 @@ Time O(1), Space O(1)
 pop(): E | undefined;
 ```
 
-Defined in: [data-structures/stack/stack.ts:415](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L415)
+Defined in: [data-structures/stack/stack.ts:470](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L470)
 
 Pop and return the top element.
 
@@ -989,7 +989,7 @@ Time O(1), Space O(1)
 print(): void;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:268](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L268)
+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.
 
@@ -1015,7 +1015,7 @@ Time O(n) due to materialization, Space O(n) for the intermediate representation
 push(element): boolean;
 ```
 
-Defined in: [data-structures/stack/stack.ts:358](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L358)
+Defined in: [data-structures/stack/stack.ts:402](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L402)
 
 Push one element onto the top.
 
@@ -1065,7 +1065,7 @@ Time O(1), Space O(1)
 pushMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/stack/stack.ts:426](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L426)
+Defined in: [data-structures/stack/stack.ts:481](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L481)
 
 Push many elements from an iterable.
 
@@ -1127,7 +1127,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:193](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L193)
+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
 
@@ -1149,7 +1149,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:193](https://github.c
 reduce(callbackfn, initialValue): E;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:194](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L194)
+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
 
@@ -1175,7 +1175,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:194](https://github.c
 reduce<U>(callbackfn, initialValue): U;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:195](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L195)
+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
 
@@ -1209,7 +1209,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:195](https://github.c
 setEquality(equals): this;
 ```
 
-Defined in: [data-structures/stack/stack.ts:722](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L722)
+Defined in: [data-structures/stack/stack.ts:832](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L832)
 
 Set the equality comparator used by delete/search operations.
 
@@ -1239,7 +1239,7 @@ Time O(1), Space O(1)
 some(predicate, thisArg?): boolean;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:109](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L109)
+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.
 
@@ -1279,7 +1279,7 @@ Time O(n) in the worst case; may exit early on first success. Space O(1).
 toArray(): E[];
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:245](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L245)
+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.
 
@@ -1305,7 +1305,7 @@ Time O(n), Space O(n).
 toVisual(): E[];
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:257](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L257)
+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.
@@ -1332,7 +1332,7 @@ Time O(n), Space O(n).
 values(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:71](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L71)
+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).
 
@@ -1361,7 +1361,7 @@ static fromArray<E, R>(
    options?): any;
 ```
 
-Defined in: [data-structures/stack/stack.ts:214](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L214)
+Defined in: [data-structures/stack/stack.ts:225](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L225)
 
 Create a stack from an array of elements.
 
@@ -1416,7 +1416,7 @@ Time O(N), Space O(N)
 protected optional _toElementFn?: (rawElement) => E;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:38](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/iterable-element-base.ts#L38)
+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`).
 
@@ -1446,7 +1446,7 @@ Time O(1), Space O(1).
 protected _createInstance(options?): this;
 ```
 
-Defined in: [data-structures/stack/stack.ts:746](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L746)
+Defined in: [data-structures/stack/stack.ts:856](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L856)
 
 (Protected) Create an empty instance of the same concrete class.
 
@@ -1476,7 +1476,7 @@ Time O(1), Space O(1)
 protected _createLike<T, RR>(elements?, options?): Stack<T, RR>;
 ```
 
-Defined in: [data-structures/stack/stack.ts:761](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L761)
+Defined in: [data-structures/stack/stack.ts:871](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L871)
 
 (Protected) Create a like-kind stack and seed it from an iterable.
 
@@ -1522,7 +1522,7 @@ Time O(N), Space O(N)
 protected _getIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/stack/stack.ts:778](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L778)
+Defined in: [data-structures/stack/stack.ts:888](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L888)
 
 (Protected) Iterate elements from bottom to top.
 
@@ -1548,7 +1548,7 @@ Time O(N), Space O(1)
 protected _indexOfByEquals(target): number;
 ```
 
-Defined in: [data-structures/stack/stack.ts:734](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/stack/stack.ts#L734)
+Defined in: [data-structures/stack/stack.ts:844](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/stack/stack.ts#L844)
 
 (Protected) Find the index of a target element using the equality function.