data-structure-typed 2.5.3 → 2.6.1

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

@@ -109,7 +109,7 @@ Iterable.[iterator]
 abstract clear(): void;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:289](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L289)
+Defined in: [data-structures/base/iterable-element-base.ts:321](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L321)
 
 Removes all elements from the structure.
 
@@ -131,7 +131,7 @@ Expected Time O(1) or O(n) depending on the implementation; Space O(1).
 abstract clone(): this;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:298](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L298)
+Defined in: [data-structures/base/iterable-element-base.ts:330](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L330)
 
 Creates a structural copy with the same element values and configuration.
 
@@ -147,6 +147,26 @@ Expected Time O(n) to copy elements; 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.
+
+***
+
 ### every()
 
 ```ts
@@ -189,7 +209,7 @@ Time O(n) in the worst case; may exit early when the first failure is found. Spa
 abstract filter(predicate, thisArg?): this;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:341](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L341)
+Defined in: [data-structures/base/iterable-element-base.ts:373](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L373)
 
 Filters elements using the provided predicate and returns the same concrete structure type.
 
@@ -367,13 +387,43 @@ 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).
+
+***
+
 ### isEmpty()
 
 ```ts
 abstract isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:280](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L280)
+Defined in: [data-structures/base/iterable-element-base.ts:312](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L312)
 
 Indicates whether the structure currently contains no elements.
 
@@ -389,6 +439,26 @@ Expected Time O(1), Space O(1) for most implementations.
 
 ***
 
+### 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.
+
+***
+
 ### map()
 
 ```ts
@@ -398,7 +468,7 @@ abstract map<EM, RM>(
 thisArg?): IterableElementBase<EM, RM>;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:313](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L313)
+Defined in: [data-structures/base/iterable-element-base.ts:345](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L345)
 
 Maps each element to a new element and returns a new iterable structure.
 
@@ -454,7 +524,7 @@ Time O(n), Space O(n).
 abstract mapSame(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:329](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L329)
+Defined in: [data-structures/base/iterable-element-base.ts:361](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L361)
 
 Maps each element to the same element type and returns the same concrete structure type.
 
@@ -490,7 +560,7 @@ Time O(n), Space O(n).
 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.
 
@@ -544,7 +614,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
 
@@ -562,7 +632,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
 
@@ -584,7 +654,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
 
@@ -650,7 +720,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: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.
 
@@ -672,7 +742,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.
@@ -775,7 +845,7 @@ Time O(1), Space O(1).
 abstract protected _getIterator(...args): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:352](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L352)
+Defined in: [data-structures/base/iterable-element-base.ts:384](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L384)
 
 Internal iterator factory used by the default iterator.
 

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

@@ -194,7 +194,7 @@ Producing the iterator is O(1); consuming the entire iterator is Time O(n) with
 abstract addAt(index, newElementOrNode): boolean;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:377](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L377)
+Defined in: [data-structures/base/linear-base.ts:388](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L388)
 
 Insert an element/node at a position.
 
@@ -230,7 +230,7 @@ Time O(1)~O(n) depending on implementation, Space O(1)
 abstract at(index): E | undefined;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:360](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L360)
+Defined in: [data-structures/base/linear-base.ts:371](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L371)
 
 Get element at an index.
 
@@ -260,7 +260,7 @@ Time O(1)~O(n) depending on implementation, Space O(1)
 abstract clear(): void;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:289](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L289)
+Defined in: [data-structures/base/iterable-element-base.ts:321](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L321)
 
 Removes all elements from the structure.
 
@@ -342,7 +342,7 @@ Time O(sum(length)), Space O(sum(length))
 abstract delete(elementOrNode): boolean;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:352](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L352)
+Defined in: [data-structures/base/linear-base.ts:363](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L363)
 
 Remove one element or node if present.
 
@@ -372,7 +372,7 @@ Time O(1)~O(n) depending on implementation, Space O(1)
 abstract deleteAt(pos): E | undefined;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:368](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L368)
+Defined in: [data-structures/base/linear-base.ts:379](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L379)
 
 Remove element at a position.
 
@@ -396,6 +396,30 @@ Time O(1)~O(n) depending on implementation, Space O(1)
 
 ***
 
+### 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
+
+[`IterableElementBase`](IterableElementBase.md).[`entries`](IterableElementBase.md#entries)
+
+***
+
 ### every()
 
 ```ts
@@ -487,7 +511,7 @@ Time O(n), Space O(1)
 abstract filter(predicate, thisArg?): this;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:341](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L341)
+Defined in: [data-structures/base/iterable-element-base.ts:373](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L373)
 
 Filters elements using the provided predicate and returns the same concrete structure type.
 
@@ -721,6 +745,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
+
+[`IterableElementBase`](IterableElementBase.md).[`includes`](IterableElementBase.md#includes)
+
+***
+
 ### indexOf()
 
 ```ts
@@ -763,7 +821,7 @@ Time O(n), Space O(1)
 abstract isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:280](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L280)
+Defined in: [data-structures/base/iterable-element-base.ts:312](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L312)
 
 Indicates whether the structure currently contains no elements.
 
@@ -813,6 +871,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
+
+[`IterableElementBase`](IterableElementBase.md).[`keys`](IterableElementBase.md#keys)
+
+***
+
 ### lastIndexOf()
 
 ```ts
@@ -858,7 +940,7 @@ abstract map<EM, RM>(
 thisArg?): IterableElementBase<EM, RM>;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:313](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L313)
+Defined in: [data-structures/base/iterable-element-base.ts:345](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L345)
 
 Maps each element to a new element and returns a new iterable structure.
 
@@ -918,7 +1000,7 @@ Time O(n), Space O(n).
 abstract mapSame(callback, thisArg?): this;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:329](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L329)
+Defined in: [data-structures/base/iterable-element-base.ts:361](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L361)
 
 Maps each element to the same element type and returns the same concrete structure type.
 
@@ -958,7 +1040,7 @@ Time O(n), Space O(n).
 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.
 
@@ -984,7 +1066,7 @@ Time O(n) due to materialization, Space O(n) for the intermediate representation
 abstract push(elementOrNode): boolean;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:336](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L336)
+Defined in: [data-structures/base/linear-base.ts:347](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L347)
 
 Append one element or node to the tail.
 
@@ -1014,7 +1096,7 @@ Time O(1) amortized typical, Space O(1)
 abstract pushMany(elements): boolean[];
 ```
 
-Defined in: [data-structures/base/linear-base.ts:344](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L344)
+Defined in: [data-structures/base/linear-base.ts:355](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L355)
 
 Append many elements/nodes at once.
 
@@ -1078,7 +1160,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
 
@@ -1100,7 +1182,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
 
@@ -1126,7 +1208,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
 
@@ -1411,7 +1493,7 @@ Time O(n + m), Space O(min(n, m)) where `m = items.length`
 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.
 
@@ -1431,6 +1513,28 @@ 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).
+
+***
+
 ### toReversedArray()
 
 ```ts
@@ -1459,7 +1563,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.
@@ -1545,7 +1649,7 @@ Time O(1), Space O(1).
 abstract protected _createInstance(options?): this;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:385](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L385)
+Defined in: [data-structures/base/linear-base.ts:396](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L396)
 
 Create an empty list of the same species.
 
@@ -1575,7 +1679,7 @@ Time O(1), Space O(1)
 abstract protected _getIterator(...args): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/base/iterable-element-base.ts:352](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L352)
+Defined in: [data-structures/base/iterable-element-base.ts:384](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L384)
 
 Internal iterator factory used by the default iterator.
 
@@ -1609,7 +1713,7 @@ Implementations should yield in O(1) per element with O(1) extra space when poss
 abstract protected _getReverseIterator(...args): IterableIterator<E>;
 ```
 
-Defined in: [data-structures/base/linear-base.ts:392](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L392)
+Defined in: [data-structures/base/linear-base.ts:403](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/linear-base.ts#L403)
 
 Reverse-direction iterator over elements.