@isdk/util 0.3.2 → 0.3.3

package/docs/classes/Deque.md

@@ -0,0 +1,1912 @@
+[**@isdk/util**](../README.md)
+
+***
+
+[@isdk/util](../globals.md) / Deque
+
+# Class: Deque\<T\>
+
+Defined in: [src/deque.ts:31](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L31)
+
+## Extends
+
+- `Array`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` = `any`
+
+## Indexable
+
+\[`n`: `number`\]: `T`
+
+## Constructors
+
+### Constructor
+
+> **new Deque**\<`T`\>(`capacity`?, `disableAutoResize`?): `Deque`\<`T`\>
+
+Defined in: [src/deque.ts:37](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L37)
+
+#### Parameters
+
+##### capacity?
+
+`number` | `T`[]
+
+##### disableAutoResize?
+
+`boolean`
+
+#### Returns
+
+`Deque`\<`T`\>
+
+#### Overrides
+
+`Array<T>.constructor`
+
+## Properties
+
+### \[unscopables\]
+
+> `readonly` **\[unscopables\]**: `object`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97
+
+Is an object whose properties have the value 'true'
+when they will be absent when used in a 'with' statement.
+
+#### Index Signature
+
+\[`key`: `number`\]: `undefined` \| `boolean`
+
+#### \[iterator\]?
+
+> `optional` **\[iterator\]**: `boolean`
+
+#### \[unscopables\]?
+
+> `readonly` `optional` **\[unscopables\]**: `boolean`
+
+Is an object whose properties have the value 'true'
+when they will be absent when used in a 'with' statement.
+
+#### at?
+
+> `optional` **at**: `boolean`
+
+#### concat?
+
+> `optional` **concat**: `boolean`
+
+#### copyWithin?
+
+> `optional` **copyWithin**: `boolean`
+
+#### entries?
+
+> `optional` **entries**: `boolean`
+
+#### every?
+
+> `optional` **every**: `boolean`
+
+#### fill?
+
+> `optional` **fill**: `boolean`
+
+#### filter?
+
+> `optional` **filter**: `boolean`
+
+#### find?
+
+> `optional` **find**: `boolean`
+
+#### findIndex?
+
+> `optional` **findIndex**: `boolean`
+
+#### flat?
+
+> `optional` **flat**: `boolean`
+
+#### flatMap?
+
+> `optional` **flatMap**: `boolean`
+
+#### forEach?
+
+> `optional` **forEach**: `boolean`
+
+#### includes?
+
+> `optional` **includes**: `boolean`
+
+#### indexOf?
+
+> `optional` **indexOf**: `boolean`
+
+#### join?
+
+> `optional` **join**: `boolean`
+
+#### keys?
+
+> `optional` **keys**: `boolean`
+
+#### lastIndexOf?
+
+> `optional` **lastIndexOf**: `boolean`
+
+#### length?
+
+> `optional` **length**: `boolean`
+
+Gets or sets the length of the array. This is a number one higher than the highest index in the array.
+
+#### map?
+
+> `optional` **map**: `boolean`
+
+#### pop?
+
+> `optional` **pop**: `boolean`
+
+#### push?
+
+> `optional` **push**: `boolean`
+
+#### reduce?
+
+> `optional` **reduce**: `boolean`
+
+#### reduceRight?
+
+> `optional` **reduceRight**: `boolean`
+
+#### reverse?
+
+> `optional` **reverse**: `boolean`
+
+#### shift?
+
+> `optional` **shift**: `boolean`
+
+#### slice?
+
+> `optional` **slice**: `boolean`
+
+#### some?
+
+> `optional` **some**: `boolean`
+
+#### sort?
+
+> `optional` **sort**: `boolean`
+
+#### splice?
+
+> `optional` **splice**: `boolean`
+
+#### toLocaleString?
+
+> `optional` **toLocaleString**: `boolean`
+
+#### toString?
+
+> `optional` **toString**: `boolean`
+
+#### unshift?
+
+> `optional` **unshift**: `boolean`
+
+#### values?
+
+> `optional` **values**: `boolean`
+
+#### Inherited from
+
+`Array.[unscopables]`
+
+***
+
+### length
+
+> **length**: `number`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1326
+
+Gets or sets the length of the array. This is a number one higher than the highest index in the array.
+
+#### Inherited from
+
+`Array.length`
+
+***
+
+### \[species\]
+
+> `readonly` `static` **\[species\]**: `ArrayConstructor`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316
+
+#### Inherited from
+
+`Array.[species]`
+
+## Accessors
+
+### size
+
+#### Get Signature
+
+> **get** **size**(): `number`
+
+Defined in: [src/deque.ts:172](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L172)
+
+Gets the number of elements in the deque.
+
+##### Example
+
+```ts
+const deque = new Deque([1, 2, 3]);
+console.log(deque.size); // 3
+```
+
+##### Important
+
+Do NOT use the native `Array.length` property. The Deque implementation uses a circular buffer with capacity management, so the native `length` reflects the underlying array capacity, not the actual element count. Always use `size` to get the correct element count.
+
+##### Returns
+
+`number`
+
+The current count of elements in the deque.
+
+## Methods
+
+### \[iterator\]()
+
+> **\[iterator\]**(): `ArrayIterator`\<`T`\>
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:78
+
+Iterator
+
+#### Returns
+
+`ArrayIterator`\<`T`\>
+
+#### Inherited from
+
+`Array.[iterator]`
+
+***
+
+### at()
+
+> **at**(`index`): `undefined` \| `T`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2022.array.d.ts:24
+
+Returns the item located at the specified index.
+
+#### Parameters
+
+##### index
+
+`number`
+
+The zero-based index of the desired code unit. A negative index will count back from the last item.
+
+#### Returns
+
+`undefined` \| `T`
+
+#### Inherited from
+
+`Array.at`
+
+***
+
+### clear()
+
+> **clear**(): `void`
+
+Defined in: [src/deque.ts:206](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L206)
+
+#### Returns
+
+`void`
+
+***
+
+### concat()
+
+#### Call Signature
+
+> **concat**(...`items`): `T`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1350
+
+Combines two or more arrays.
+This method returns a new array without modifying any existing arrays.
+
+##### Parameters
+
+###### items
+
+...`ConcatArray`\<`T`\>[]
+
+Additional arrays and/or items to add to the end of the array.
+
+##### Returns
+
+`T`[]
+
+##### Inherited from
+
+`Array.concat`
+
+#### Call Signature
+
+> **concat**(...`items`): `T`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1356
+
+Combines two or more arrays.
+This method returns a new array without modifying any existing arrays.
+
+##### Parameters
+
+###### items
+
+...(`T` \| `ConcatArray`\<`T`\>)[]
+
+Additional arrays and/or items to add to the end of the array.
+
+##### Returns
+
+`T`[]
+
+##### Inherited from
+
+`Array.concat`
+
+***
+
+### copyWithin()
+
+> **copyWithin**(`target`, `start`, `end`?): `this`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:62
+
+Returns the this object after copying a section of the array identified by start and end
+to the same array starting at position target
+
+#### Parameters
+
+##### target
+
+`number`
+
+If target is negative, it is treated as length+target where length is the
+length of the array.
+
+##### start
+
+`number`
+
+If start is negative, it is treated as length+start. If end is negative, it
+is treated as length+end.
+
+##### end?
+
+`number`
+
+If not specified, length of the this object is used as its default value.
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+`Array.copyWithin`
+
+***
+
+### entries()
+
+> **entries**(): `ArrayIterator`\<\[`number`, `T`\]\>
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:83
+
+Returns an iterable of key, value pairs for every entry in the array
+
+#### Returns
+
+`ArrayIterator`\<\[`number`, `T`\]\>
+
+#### Inherited from
+
+`Array.entries`
+
+***
+
+### every()
+
+#### Call Signature
+
+> **every**\<`S`\>(`predicate`, `thisArg`?): `this is S[]`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1433
+
+Determines whether all the members of an array satisfy the specified test.
+
+##### Type Parameters
+
+###### S
+
+`S`
+
+##### Parameters
+
+###### predicate
+
+(`value`, `index`, `array`) => `value is S`
+
+A function that accepts up to three arguments. The every method calls
+the predicate function for each element in the array until the predicate returns a value
+which is coercible to the Boolean value false, or until the end of the array.
+
+###### thisArg?
+
+`any`
+
+An object to which the this keyword can refer in the predicate function.
+If thisArg is omitted, undefined is used as the this value.
+
+##### Returns
+
+`this is S[]`
+
+##### Inherited from
+
+`Array.every`
+
+#### Call Signature
+
+> **every**(`predicate`, `thisArg`?): `boolean`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1442
+
+Determines whether all the members of an array satisfy the specified test.
+
+##### Parameters
+
+###### predicate
+
+(`value`, `index`, `array`) => `unknown`
+
+A function that accepts up to three arguments. The every method calls
+the predicate function for each element in the array until the predicate returns a value
+which is coercible to the Boolean value false, or until the end of the array.
+
+###### thisArg?
+
+`any`
+
+An object to which the this keyword can refer in the predicate function.
+If thisArg is omitted, undefined is used as the this value.
+
+##### Returns
+
+`boolean`
+
+##### Inherited from
+
+`Array.every`
+
+***
+
+### fill()
+
+> **fill**(`value`, `start`?, `end`?): `this`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:51
+
+Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
+
+#### Parameters
+
+##### value
+
+`T`
+
+value to fill array section with
+
+##### start?
+
+`number`
+
+index to start filling the array at. If start is negative, it is treated as
+length+start where length is the length of the array.
+
+##### end?
+
+`number`
+
+index to stop filling the array at. If end is negative, it is treated as
+length+end.
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+`Array.fill`
+
+***
+
+### filter()
+
+#### Call Signature
+
+> **filter**\<`S`\>(`predicate`, `thisArg`?): `S`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1469
+
+Returns the elements of an array that meet the condition specified in a callback function.
+
+##### Type Parameters
+
+###### S
+
+`S`
+
+##### Parameters
+
+###### predicate
+
+(`value`, `index`, `array`) => `value is S`
+
+A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
+
+###### thisArg?
+
+`any`
+
+An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
+
+##### Returns
+
+`S`[]
+
+##### Inherited from
+
+`Array.filter`
+
+#### Call Signature
+
+> **filter**(`predicate`, `thisArg`?): `T`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1475
+
+Returns the elements of an array that meet the condition specified in a callback function.
+
+##### Parameters
+
+###### predicate
+
+(`value`, `index`, `array`) => `unknown`
+
+A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
+
+###### thisArg?
+
+`any`
+
+An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
+
+##### Returns
+
+`T`[]
+
+##### Inherited from
+
+`Array.filter`
+
+***
+
+### find()
+
+#### Call Signature
+
+> **find**\<`S`\>(`predicate`, `thisArg`?): `undefined` \| `S`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:29
+
+Returns the value of the first element in the array where predicate is true, and undefined
+otherwise.
+
+##### Type Parameters
+
+###### S
+
+`S`
+
+##### Parameters
+
+###### predicate
+
+(`value`, `index`, `obj`) => `value is S`
+
+find calls predicate once for each element of the array, in ascending
+order, until it finds one where predicate returns true. If such an element is found, find
+immediately returns that element value. Otherwise, find returns undefined.
+
+###### thisArg?
+
+`any`
+
+If provided, it will be used as the this value for each invocation of
+predicate. If it is not provided, undefined is used instead.
+
+##### Returns
+
+`undefined` \| `S`
+
+##### Inherited from
+
+`Array.find`
+
+#### Call Signature
+
+> **find**(`predicate`, `thisArg`?): `undefined` \| `T`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:30
+
+##### Parameters
+
+###### predicate
+
+(`value`, `index`, `obj`) => `unknown`
+
+###### thisArg?
+
+`any`
+
+##### Returns
+
+`undefined` \| `T`
+
+##### Inherited from
+
+`Array.find`
+
+***
+
+### findIndex()
+
+> **findIndex**(`predicate`, `thisArg`?): `number`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:41
+
+Returns the index of the first element in the array where predicate is true, and -1
+otherwise.
+
+#### Parameters
+
+##### predicate
+
+(`value`, `index`, `obj`) => `unknown`
+
+find calls predicate once for each element of the array, in ascending
+order, until it finds one where predicate returns true. If such an element is found,
+findIndex immediately returns that element index. Otherwise, findIndex returns -1.
+
+##### thisArg?
+
+`any`
+
+If provided, it will be used as the this value for each invocation of
+predicate. If it is not provided, undefined is used instead.
+
+#### Returns
+
+`number`
+
+#### Inherited from
+
+`Array.findIndex`
+
+***
+
+### flat()
+
+> **flat**\<`A`, `D`\>(`this`, `depth`?): `FlatArray`\<`A`, `D`\>[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2019.array.d.ts:75
+
+Returns a new array with all sub-array elements concatenated into it recursively up to the
+specified depth.
+
+#### Type Parameters
+
+##### A
+
+`A`
+
+##### D
+
+`D` *extends* `number` = `1`
+
+#### Parameters
+
+##### this
+
+`A`
+
+##### depth?
+
+`D`
+
+The maximum recursion depth
+
+#### Returns
+
+`FlatArray`\<`A`, `D`\>[]
+
+#### Inherited from
+
+`Array.flat`
+
+***
+
+### flatMap()
+
+> **flatMap**\<`U`, `This`\>(`callback`, `thisArg`?): `U`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2019.array.d.ts:64
+
+Calls a defined callback function on each element of an array. Then, flattens the result into
+a new array.
+This is identical to a map followed by flat with depth 1.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+##### This
+
+`This` = `undefined`
+
+#### Parameters
+
+##### callback
+
+(`this`, `value`, `index`, `array`) => `U` \| readonly `U`[]
+
+A function that accepts up to three arguments. The flatMap method calls the
+callback function one time for each element in the array.
+
+##### thisArg?
+
+`This`
+
+An object to which the this keyword can refer in the callback function. If
+thisArg is omitted, undefined is used as the this value.
+
+#### Returns
+
+`U`[]
+
+#### Inherited from
+
+`Array.flatMap`
+
+***
+
+### forEach()
+
+> **forEach**(`callbackfn`, `thisArg`?): `void`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1457
+
+Performs the specified action for each element in an array.
+
+#### Parameters
+
+##### callbackfn
+
+(`value`, `index`, `array`) => `void`
+
+A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
+
+##### thisArg?
+
+`any`
+
+An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Array.forEach`
+
+***
+
+### get()
+
+> **get**(`index`): `undefined` \| `T`
+
+Defined in: [src/deque.ts:176](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L176)
+
+#### Parameters
+
+##### index
+
+`number`
+
+#### Returns
+
+`undefined` \| `T`
+
+***
+
+### includes()
+
+> **includes**(`searchElement`, `fromIndex`?): `boolean`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2016.array.include.d.ts:25
+
+Determines whether an array includes a certain element, returning true or false as appropriate.
+
+#### Parameters
+
+##### searchElement
+
+`T`
+
+The element to search for.
+
+##### fromIndex?
+
+`number`
+
+The position in this array at which to begin searching for searchElement.
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+`Array.includes`
+
+***
+
+### indexOf()
+
+> **indexOf**(`searchElement`, `fromIndex`?): `number`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1418
+
+Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
+
+#### Parameters
+
+##### searchElement
+
+`T`
+
+The value to locate in the array.
+
+##### fromIndex?
+
+`number`
+
+The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
+
+#### Returns
+
+`number`
+
+#### Inherited from
+
+`Array.indexOf`
+
+***
+
+### isEmpty()
+
+> **isEmpty**(): `boolean`
+
+Defined in: [src/deque.ts:217](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L217)
+
+#### Returns
+
+`boolean`
+
+***
+
+### join()
+
+> **join**(`separator`?): `string`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1361
+
+Adds all the elements of an array into a string, separated by the specified separator string.
+
+#### Parameters
+
+##### separator?
+
+`string`
+
+A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+`Array.join`
+
+***
+
+### keys()
+
+> **keys**(): `ArrayIterator`\<`number`\>
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:88
+
+Returns an iterable of keys in the array
+
+#### Returns
+
+`ArrayIterator`\<`number`\>
+
+#### Inherited from
+
+`Array.keys`
+
+***
+
+### lastIndexOf()
+
+> **lastIndexOf**(`searchElement`, `fromIndex`?): `number`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1424
+
+Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
+
+#### Parameters
+
+##### searchElement
+
+`T`
+
+The value to locate in the array.
+
+##### fromIndex?
+
+`number`
+
+The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.
+
+#### Returns
+
+`number`
+
+#### Inherited from
+
+`Array.lastIndexOf`
+
+***
+
+### map()
+
+> **map**\<`U`\>(`callbackfn`, `thisArg`?): `U`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1463
+
+Calls a defined callback function on each element of an array, and returns an array that contains the results.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### callbackfn
+
+(`value`, `index`, `array`) => `U`
+
+A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
+
+##### thisArg?
+
+`any`
+
+An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
+
+#### Returns
+
+`U`[]
+
+#### Inherited from
+
+`Array.map`
+
+***
+
+### peekBack()
+
+> **peekBack**(): `undefined` \| `T`
+
+Defined in: [src/deque.ts:190](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L190)
+
+#### Returns
+
+`undefined` \| `T`
+
+***
+
+### peekFront()
+
+> **peekFront**(): `undefined` \| `T`
+
+Defined in: [src/deque.ts:199](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L199)
+
+#### Returns
+
+`undefined` \| `T`
+
+***
+
+### pop()
+
+> **pop**(`skipNull`?): `undefined` \| `T`
+
+Defined in: [src/deque.ts:102](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L102)
+
+Removes and returns the element at the back of the deque.
+
+#### Parameters
+
+##### skipNull?
+
+`boolean`
+
+When `true`, skips trailing `null`/`undefined` values until a valid element is found or all elements are processed.
+
+#### Returns
+
+`undefined` \| `T`
+
+The removed element, or `undefined` if the deque is empty or all elements are skipped.
+
+#### Examples
+
+```ts
+// Normal pop without skipping
+const deque = new Deque([1, 2, 3]);
+deque.pop(); // 3
+```
+
+```ts
+// Skipping null values
+const nullDeque = new Deque([null, 4, null]);
+nullDeque.pop(true); // 4
+nullDeque.pop(true); // undefined (skipped remaining nulls)
+```
+
+```ts
+// Mixed elements with skip
+const mixedDeque = new Deque([5, null, 6, null]);
+mixedDeque.pop(true); // 6
+mixedDeque.pop(false); // null (explicitly not skipping)
+```
+
+#### Overrides
+
+`Array.pop`
+
+***
+
+### push()
+
+> **push**(`item`): `number`
+
+Defined in: [src/deque.ts:52](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L52)
+
+Appends new elements to the end of an array, and returns the new length of the array.
+
+#### Parameters
+
+##### item
+
+`T`
+
+#### Returns
+
+`number`
+
+#### Overrides
+
+`Array.push`
+
+***
+
+### reduce()
+
+#### Call Signature
+
+> **reduce**(`callbackfn`): `T`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1481
+
+Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+
+##### Parameters
+
+###### callbackfn
+
+(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T`
+
+A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
+
+##### Returns
+
+`T`
+
+##### Inherited from
+
+`Array.reduce`
+
+#### Call Signature
+
+> **reduce**(`callbackfn`, `initialValue`): `T`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1482
+
+##### Parameters
+
+###### callbackfn
+
+(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T`
+
+###### initialValue
+
+`T`
+
+##### Returns
+
+`T`
+
+##### Inherited from
+
+`Array.reduce`
+
+#### Call Signature
+
+> **reduce**\<`U`\>(`callbackfn`, `initialValue`): `U`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1488
+
+Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+
+##### Type Parameters
+
+###### U
+
+`U`
+
+##### Parameters
+
+###### callbackfn
+
+(`previousValue`, `currentValue`, `currentIndex`, `array`) => `U`
+
+A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
+
+###### initialValue
+
+`U`
+
+If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+
+##### Returns
+
+`U`
+
+##### Inherited from
+
+`Array.reduce`
+
+***
+
+### reduceRight()
+
+#### Call Signature
+
+> **reduceRight**(`callbackfn`): `T`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1494
+
+Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+
+##### Parameters
+
+###### callbackfn
+
+(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T`
+
+A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
+
+##### Returns
+
+`T`
+
+##### Inherited from
+
+`Array.reduceRight`
+
+#### Call Signature
+
+> **reduceRight**(`callbackfn`, `initialValue`): `T`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1495
+
+##### Parameters
+
+###### callbackfn
+
+(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T`
+
+###### initialValue
+
+`T`
+
+##### Returns
+
+`T`
+
+##### Inherited from
+
+`Array.reduceRight`
+
+#### Call Signature
+
+> **reduceRight**\<`U`\>(`callbackfn`, `initialValue`): `U`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1501
+
+Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
+
+##### Type Parameters
+
+###### U
+
+`U`
+
+##### Parameters
+
+###### callbackfn
+
+(`previousValue`, `currentValue`, `currentIndex`, `array`) => `U`
+
+A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
+
+###### initialValue
+
+`U`
+
+If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
+
+##### Returns
+
+`U`
+
+##### Inherited from
+
+`Array.reduceRight`
+
+***
+
+### removeAt()
+
+> **removeAt**(`index`): `undefined` \| `T`
+
+Defined in: [src/deque.ts:226](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L226)
+
+Removes the element at the specified index.
+
+#### Parameters
+
+##### index
+
+`number`
+
+Logical index position (0 represents the front, length-1 represents the back)
+
+#### Returns
+
+`undefined` \| `T`
+
+The removed element
+
+***
+
+### reverse()
+
+> **reverse**(): `T`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1366
+
+Reverses the elements in an array in place.
+This method mutates the array and returns a reference to the same array.
+
+#### Returns
+
+`T`[]
+
+#### Inherited from
+
+`Array.reverse`
+
+***
+
+### shift()
+
+> **shift**(`skipNull`?): `undefined` \| `T`
+
+Defined in: [src/deque.ts:142](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L142)
+
+Removes and returns the element at the front of the deque.
+
+#### Parameters
+
+##### skipNull?
+
+`boolean`
+
+When `true`, skips leading `null`/`undefined` values until a valid element is found or all elements are processed.
+
+#### Returns
+
+`undefined` \| `T`
+
+The removed element, or `undefined` if the deque is empty or all elements are skipped.
+
+#### Examples
+
+```ts
+// Normal shift without skipping
+const deque = new Deque([1, 2, 3]);
+deque.shift(); // 1
+```
+
+```ts
+// Skipping null values
+const nullDeque = new Deque([null, 4, null]);
+nullDeque.shift(true); // 4
+nullDeque.shift(true); // undefined (skipped remaining nulls)
+```
+
+```ts
+// Mixed elements with skip
+const mixedDeque = new Deque([null, 5, null, 6]);
+mixedDeque.shift(true); // 5
+mixedDeque.shift(false); // null (explicitly not skipping)
+```
+
+#### Overrides
+
+`Array.shift`
+
+***
+
+### slice()
+
+> **slice**(`start`?, `end`?): `T`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1381
+
+Returns a copy of a section of an array.
+For both start and end, a negative index can be used to indicate an offset from the end of the array.
+For example, -2 refers to the second to last element of the array.
+
+#### Parameters
+
+##### start?
+
+`number`
+
+The beginning index of the specified portion of the array.
+If start is undefined, then the slice begins at index 0.
+
+##### end?
+
+`number`
+
+The end index of the specified portion of the array. This is exclusive of the element at the index 'end'.
+If end is undefined, then the slice extends to the end of the array.
+
+#### Returns
+
+`T`[]
+
+#### Inherited from
+
+`Array.slice`
+
+***
+
+### some()
+
+> **some**(`predicate`, `thisArg`?): `boolean`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1451
+
+Determines whether the specified callback function returns true for any element of an array.
+
+#### Parameters
+
+##### predicate
+
+(`value`, `index`, `array`) => `unknown`
+
+A function that accepts up to three arguments. The some method calls
+the predicate function for each element in the array until the predicate returns a value
+which is coercible to the Boolean value true, or until the end of the array.
+
+##### thisArg?
+
+`any`
+
+An object to which the this keyword can refer in the predicate function.
+If thisArg is omitted, undefined is used as the this value.
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+`Array.some`
+
+***
+
+### sort()
+
+> **sort**(`compareFn`?): `this`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1392
+
+Sorts an array in place.
+This method mutates the array and returns a reference to the same array.
+
+#### Parameters
+
+##### compareFn?
+
+(`a`, `b`) => `number`
+
+Function used to determine the order of the elements. It is expected to return
+a negative value if the first argument is less than the second argument, zero if they're equal, and a positive
+value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order.
+```ts
+[11,2,22,1].sort((a, b) => a - b)
+```
+
+#### Returns
+
+`this`
+
+#### Inherited from
+
+`Array.sort`
+
+***
+
+### splice()
+
+#### Call Signature
+
+> **splice**(`start`, `deleteCount`?): `T`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1399
+
+Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
+
+##### Parameters
+
+###### start
+
+`number`
+
+The zero-based location in the array from which to start removing elements.
+
+###### deleteCount?
+
+`number`
+
+The number of elements to remove.
+
+##### Returns
+
+`T`[]
+
+An array containing the elements that were deleted.
+
+##### Inherited from
+
+`Array.splice`
+
+#### Call Signature
+
+> **splice**(`start`, `deleteCount`, ...`items`): `T`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1407
+
+Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
+
+##### Parameters
+
+###### start
+
+`number`
+
+The zero-based location in the array from which to start removing elements.
+
+###### deleteCount
+
+`number`
+
+The number of elements to remove.
+
+###### items
+
+...`T`[]
+
+Elements to insert into the array in place of the deleted elements.
+
+##### Returns
+
+`T`[]
+
+An array containing the elements that were deleted.
+
+##### Inherited from
+
+`Array.splice`
+
+***
+
+### toLocaleString()
+
+#### Call Signature
+
+> **toLocaleString**(): `string`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1334
+
+Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
+
+##### Returns
+
+`string`
+
+##### Inherited from
+
+`Array.toLocaleString`
+
+#### Call Signature
+
+> **toLocaleString**(`locales`, `options`?): `string`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:64
+
+##### Parameters
+
+###### locales
+
+`string` | `string`[]
+
+###### options?
+
+`NumberFormatOptions` & `DateTimeFormatOptions`
+
+##### Returns
+
+`string`
+
+##### Inherited from
+
+`Array.toLocaleString`
+
+***
+
+### toString()
+
+> **toString**(): `string`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1330
+
+Returns a string representation of an array.
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+`Array.toString`
+
+***
+
+### unshift()
+
+> **unshift**(`item`): `number`
+
+Defined in: [src/deque.ts:65](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L65)
+
+Inserts new elements at the start of an array, and returns the new length of the array.
+
+#### Parameters
+
+##### item
+
+`T`
+
+#### Returns
+
+`number`
+
+#### Overrides
+
+`Array.unshift`
+
+***
+
+### values()
+
+> **values**(): `ArrayIterator`\<`T`\>
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:93
+
+Returns an iterable of values in the array
+
+#### Returns
+
+`ArrayIterator`\<`T`\>
+
+#### Inherited from
+
+`Array.values`
+
+***
+
+### from()
+
+#### Call Signature
+
+> `static` **from**\<`T`\>(`arrayLike`): `T`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:72
+
+Creates an array from an array-like object.
+
+##### Type Parameters
+
+###### T
+
+`T`
+
+##### Parameters
+
+###### arrayLike
+
+`ArrayLike`\<`T`\>
+
+An array-like object to convert to an array.
+
+##### Returns
+
+`T`[]
+
+##### Inherited from
+
+`Array.from`
+
+#### Call Signature
+
+> `static` **from**\<`T`, `U`\>(`arrayLike`, `mapfn`, `thisArg`?): `U`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:80
+
+Creates an array from an iterable object.
+
+##### Type Parameters
+
+###### T
+
+`T`
+
+###### U
+
+`U`
+
+##### Parameters
+
+###### arrayLike
+
+`ArrayLike`\<`T`\>
+
+An array-like object to convert to an array.
+
+###### mapfn
+
+(`v`, `k`) => `U`
+
+A mapping function to call on every element of the array.
+
+###### thisArg?
+
+`any`
+
+Value of 'this' used to invoke the mapfn.
+
+##### Returns
+
+`U`[]
+
+##### Inherited from
+
+`Array.from`
+
+#### Call Signature
+
+> `static` **from**\<`T`\>(`iterable`): `T`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:101
+
+Creates an array from an iterable object.
+
+##### Type Parameters
+
+###### T
+
+`T`
+
+##### Parameters
+
+###### iterable
+
+An iterable object to convert to an array.
+
+`Iterable`\<`T`, `any`, `any`\> | `ArrayLike`\<`T`\>
+
+##### Returns
+
+`T`[]
+
+##### Inherited from
+
+`Array.from`
+
+#### Call Signature
+
+> `static` **from**\<`T`, `U`\>(`iterable`, `mapfn`, `thisArg`?): `U`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:109
+
+Creates an array from an iterable object.
+
+##### Type Parameters
+
+###### T
+
+`T`
+
+###### U
+
+`U`
+
+##### Parameters
+
+###### iterable
+
+An iterable object to convert to an array.
+
+`Iterable`\<`T`, `any`, `any`\> | `ArrayLike`\<`T`\>
+
+###### mapfn
+
+(`v`, `k`) => `U`
+
+A mapping function to call on every element of the array.
+
+###### thisArg?
+
+`any`
+
+Value of 'this' used to invoke the mapfn.
+
+##### Returns
+
+`U`[]
+
+##### Inherited from
+
+`Array.from`
+
+***
+
+### isArray()
+
+> `static` **isArray**(`arg`): `arg is any[]`
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1513
+
+#### Parameters
+
+##### arg
+
+`any`
+
+#### Returns
+
+`arg is any[]`
+
+#### Inherited from
+
+`Array.isArray`
+
+***
+
+### of()
+
+> `static` **of**\<`T`\>(...`items`): `T`[]
+
+Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:86
+
+Returns a new array from a set of elements.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### items
+
+...`T`[]
+
+A set of elements to include in the new array object.
+
+#### Returns
+
+`T`[]
+
+#### Inherited from
+
+`Array.of`