data-structure-typed 2.5.3 → 2.6.1

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

@@ -233,7 +233,7 @@ Backing array of elements.
 get first(): E | undefined;
 ```
 
-Defined in: [data-structures/queue/queue.ts:262](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L262)
+Defined in: [data-structures/queue/queue.ts:268](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L268)
 
 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:281](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L281)
+Defined in: [data-structures/queue/queue.ts:287](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L287)
 
 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:208](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L208)
+Defined in: [data-structures/queue/queue.ts:211](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L211)
 
 Get the number of elements currently in the queue.
 
@@ -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:642](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L642)
+Defined in: [data-structures/queue/queue.ts:663](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L663)
 
 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:615](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L615)
+Defined in: [data-structures/queue/queue.ts:636](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L636)
 
 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:738](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L738)
+Defined in: [data-structures/queue/queue.ts:762](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L762)
 
 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:873](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L873)
+Defined in: [data-structures/queue/queue.ts:903](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L903)
 
 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:792](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L792)
+Defined in: [data-structures/queue/queue.ts:819](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L819)
 
 Compact storage by discarding consumed head elements.
 
@@ -675,7 +675,7 @@ Time O(sum(length)), Space O(sum(length))
 delete(element): boolean;
 ```
 
-Defined in: [data-structures/queue/queue.ts:557](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L557)
+Defined in: [data-structures/queue/queue.ts:575](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L575)
 
 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:627](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L627)
+Defined in: [data-structures/queue/queue.ts:648](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L648)
 
 Delete the element at a given index.
 
@@ -754,7 +754,7 @@ Time O(N), Space O(1)
 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)
+Defined in: [data-structures/queue/queue.ts:689](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L689)
 
 Delete the first element that satisfies a predicate.
 
@@ -778,6 +778,30 @@ Time O(N), Space O(N)
 
 ***
 
+### entries()
+
+```ts
+entries(): IterableIterator<[number, E]>;
+```
+
+Defined in: [data-structures/base/iterable-element-base.ts:208](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L208)
+
+Return an iterator of `[index, value]` pairs (Array-compatible).
+
+#### Returns
+
+`IterableIterator`\<\[`number`, `E`\]\>
+
+#### Remarks
+
+Provided for familiarity when migrating from Array. Time O(n), Space O(1) per step.
+
+#### Inherited from
+
+[`LinearBase`](LinearBase.md).[`entries`](LinearBase.md#entries)
+
+***
+
 ### every()
 
 ```ts
@@ -873,7 +897,7 @@ Time O(n), Space O(1)
 filter(predicate, thisArg?): this;
 ```
 
-Defined in: [data-structures/queue/queue.ts:930](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L930)
+Defined in: [data-structures/queue/queue.ts:963](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L963)
 
 Filter elements into a new queue of the same class.
 
@@ -1122,6 +1146,40 @@ Time O(n) in the worst case. Space O(1).
 
 ***
 
+### includes()
+
+```ts
+includes(element): boolean;
+```
+
+Defined in: [data-structures/base/iterable-element-base.ts:200](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L200)
+
+Check whether a value exists (Array-compatible alias for `has`).
+
+#### Parameters
+
+##### element
+
+`E`
+
+Element to search for (uses `===`).
+
+#### Returns
+
+`boolean`
+
+`true` if found.
+
+#### Remarks
+
+Provided for familiarity when migrating from Array. Time O(n), Space O(1).
+
+#### Inherited from
+
+[`LinearBase`](LinearBase.md).[`includes`](LinearBase.md#includes)
+
+***
+
 ### indexOf()
 
 ```ts
@@ -1168,7 +1226,7 @@ Time O(n), Space O(1)
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/queue/queue.ts:360](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L360)
+Defined in: [data-structures/queue/queue.ts:369](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L369)
 
 Check whether the queue is empty.
 
@@ -1246,6 +1304,30 @@ Time O(n), Space O(n)
 
 ***
 
+### keys()
+
+```ts
+keys(): IterableIterator<number>;
+```
+
+Defined in: [data-structures/base/iterable-element-base.ts:219](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L219)
+
+Return an iterator of numeric indices (Array-compatible).
+
+#### Returns
+
+`IterableIterator`\<`number`\>
+
+#### Remarks
+
+Provided for familiarity when migrating from Array. Time O(n), Space O(1) per step.
+
+#### Inherited from
+
+[`LinearBase`](LinearBase.md).[`keys`](LinearBase.md#keys)
+
+***
+
 ### lastIndexOf()
 
 ```ts
@@ -1295,7 +1377,7 @@ map<EM, RM>(
 thisArg?): Queue<EM, RM>;
 ```
 
-Defined in: [data-structures/queue/queue.ts:993](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L993)
+Defined in: [data-structures/queue/queue.ts:1029](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1029)
 
 Map each element to a new element in a possibly different-typed queue.
 
@@ -1362,7 +1444,7 @@ Time O(N), Space O(N)
 mapSame(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/queue/queue.ts:1016](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1016)
+Defined in: [data-structures/queue/queue.ts:1052](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1052)
 
 Map each element to a new value of the same type.
 
@@ -1402,7 +1484,7 @@ Time O(N), Space O(N)
 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)
+Defined in: [data-structures/queue/queue.ts:277](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L277)
 
 Peek at the front element without removing it (alias for `first`).
 
@@ -1424,7 +1506,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/main/src/data-structures/base/iterable-element-base.ts#L269)
+Defined in: [data-structures/base/iterable-element-base.ts:301](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L301)
 
 Prints `toVisual()` to the console. Intended for quick debugging.
 
@@ -1450,7 +1532,7 @@ Time O(n) due to materialization, Space O(n) for the intermediate representation
 push(element): boolean;
 ```
 
-Defined in: [data-structures/queue/queue.ts:420](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L420)
+Defined in: [data-structures/queue/queue.ts:432](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L432)
 
 Enqueue one element at the back.
 
@@ -1500,7 +1582,7 @@ Time O(1), Space O(1)
 pushMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/queue/queue.ts:433](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L433)
+Defined in: [data-structures/queue/queue.ts:445](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L445)
 
 Enqueue many elements from an iterable.
 
@@ -1566,7 +1648,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/main/src/data-structures/base/iterable-element-base.ts#L194)
+Defined in: [data-structures/base/iterable-element-base.ts:226](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L226)
 
 ##### Parameters
 
@@ -1588,7 +1670,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/main/src/data-structures/base/iterable-element-base.ts#L195)
+Defined in: [data-structures/base/iterable-element-base.ts:227](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L227)
 
 ##### Parameters
 
@@ -1614,7 +1696,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/main/src/data-structures/base/iterable-element-base.ts#L196)
+Defined in: [data-structures/base/iterable-element-base.ts:228](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L228)
 
 ##### Type Parameters
 
@@ -1694,7 +1776,7 @@ Time O(n), Space O(1)
 reverse(): this;
 ```
 
-Defined in: [data-structures/queue/queue.ts:684](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L684)
+Defined in: [data-structures/queue/queue.ts:705](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L705)
 
 Reverse the queue in-place by compacting then reversing.
 
@@ -1720,7 +1802,7 @@ Time O(N), Space O(N)
 setAt(index, newElement): boolean;
 ```
 
-Defined in: [data-structures/queue/queue.ts:656](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L656)
+Defined in: [data-structures/queue/queue.ts:677](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L677)
 
 Replace the element at a given index.
 
@@ -1760,7 +1842,7 @@ Time O(1), Space O(1)
 shift(): E | undefined;
 ```
 
-Defined in: [data-structures/queue/queue.ts:501](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L501)
+Defined in: [data-structures/queue/queue.ts:516](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L516)
 
 Dequeue one element from the front (amortized via offset).
 
@@ -1919,7 +2001,7 @@ splice(
    items?): this;
 ```
 
-Defined in: [data-structures/queue/queue.ts:807](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L807)
+Defined in: [data-structures/queue/queue.ts:834](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L834)
 
 Remove and/or insert elements at a position (array-like).
 
@@ -1965,7 +2047,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/main/src/data-structures/base/iterable-element-base.ts#L246)
+Defined in: [data-structures/base/iterable-element-base.ts:278](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L278)
 
 Materializes the elements into a new array.
 
@@ -1985,6 +2067,32 @@ Time O(n), Space O(n).
 
 ***
 
+### toReversed()
+
+```ts
+toReversed(): this;
+```
+
+Defined in: [data-structures/base/linear-base.ts:335](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L335)
+
+Return a new instance of the same type with elements in reverse order (non-mutating).
+
+#### Returns
+
+`this`
+
+A new reversed instance.
+
+#### Remarks
+
+Provided for familiarity when migrating from Array (ES2023 `toReversed`). Time O(n), Space O(n).
+
+#### Inherited from
+
+[`LinearBase`](LinearBase.md).[`toReversed`](LinearBase.md#toreversed)
+
+***
+
 ### toReversedArray()
 
 ```ts
@@ -2017,7 +2125,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/main/src/data-structures/base/iterable-element-base.ts#L258)
+Defined in: [data-structures/base/iterable-element-base.ts:290](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L290)
 
 Returns a representation of the structure suitable for quick visualization.
 Defaults to an array of elements; subclasses may override to provide richer visuals.
@@ -2070,7 +2178,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:293](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L293)
+Defined in: [data-structures/queue/queue.ts:299](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L299)
 
 Create a queue from an array of elements.
 
@@ -2139,7 +2247,7 @@ Time O(1), Space O(1).
 protected _createInstance(options?): this;
 ```
 
-Defined in: [data-structures/queue/queue.ts:1076](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1076)
+Defined in: [data-structures/queue/queue.ts:1112](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1112)
 
 (Protected) Create an empty instance of the same concrete class.
 
@@ -2173,7 +2281,7 @@ Time O(1), Space O(1)
 protected _createLike<EM, RM>(elements?, options?): Queue<EM, RM>;
 ```
 
-Defined in: [data-structures/queue/queue.ts:1091](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1091)
+Defined in: [data-structures/queue/queue.ts:1127](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1127)
 
 (Protected) Create a like-kind queue and seed it from an iterable.
 
@@ -2219,7 +2327,7 @@ Time O(N), Space O(N)
 protected _getIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/queue/queue.ts:1052](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1052)
+Defined in: [data-structures/queue/queue.ts:1088](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1088)
 
 (Protected) Iterate elements from front to back.
 
@@ -2245,7 +2353,7 @@ Time O(N), Space O(1)
 protected _getReverseIterator(): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/queue/queue.ts:1062](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1062)
+Defined in: [data-structures/queue/queue.ts:1098](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1098)
 
 (Protected) Iterate elements from back to front.
 
@@ -2271,7 +2379,7 @@ Time O(N), Space O(1)
 protected _setAutoCompactRatio(value): void;
 ```
 
-Defined in: [data-structures/queue/queue.ts:1042](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1042)
+Defined in: [data-structures/queue/queue.ts:1078](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/queue/queue.ts#L1078)
 
 (Protected) Set the internal auto-compaction ratio.