@ls-stack/utils 3.40.0 → 3.42.0

package/docs/arrayUtils/-internal-.md

@@ -1,179 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / [arrayUtils](README.md) / \<internal\>
-
-# \<internal\>
-
-## Type Aliases
-
-### ArrayOps\<T\>
-
-```ts
-type ArrayOps<T> = object;
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:259](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L259)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Properties
-
-##### filterAndMap()
-
-```ts
-filterAndMap: <R>(mapFilter) => R[];
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:272](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L272)
-
-Filter and map an array
-
-###### Type Parameters
-
-###### R
-
-`R`
-
-###### Parameters
-
-###### mapFilter
-
-(`item`, `index`) => `false` \| `R`
-
-A function that takes an item and returns a value or `false`
-to reject the item.
-
-###### Returns
-
-`R`[]
-
-###### Example
-
-```ts
-const items = [1, 2, 3];
-
-const enhancedItems = arrayOps(items);
-
-enhancedItems.filterAndMap((item) => item === 2 ? false : item);
-```
-
-##### findAndMap()
-
-```ts
-findAndMap: <R>(predicate) => R | undefined;
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:275](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L275)
-
-###### Type Parameters
-
-###### R
-
-`R`
-
-###### Parameters
-
-###### predicate
-
-(`value`) => `R` \| `false`
-
-###### Returns
-
-`R` \| `undefined`
-
-##### rejectDuplicates()
-
-```ts
-rejectDuplicates: (getKey) => T[];
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:274](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L274)
-
-###### Parameters
-
-###### getKey
-
-(`item`) => `unknown`
-
-###### Returns
-
-`T`[]
-
-##### sortBy()
-
-```ts
-sortBy: (sortByValue, props) => T[];
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:273](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L273)
-
-###### Parameters
-
-###### sortByValue
-
-[`SortByValue`](#sortbyvalue)\<`T`\>
-
-###### props
-
-[`SortByProps`](#sortbyprops)
-
-###### Returns
-
-`T`[]
-
-***
-
-### SortByProps
-
-```ts
-type SortByProps = 
-  | {
-  order?: SortOrder | SortOrder[];
-}
-  | SortOrder
-  | SortOrder[];
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:48](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L48)
-
-***
-
-### SortByValue()\<T\>
-
-```ts
-type SortByValue<T> = (item) => (number | string)[] | number | string;
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:46](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L46)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### item
-
-`T`
-
-#### Returns
-
-(`number` \| `string`)[] \| `number` \| `string`
-
-***
-
-### SortOrder
-
-```ts
-type SortOrder = "desc" | "asc";
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:44](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L44)

package/docs/arrayUtils/README.md

@@ -1,550 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / arrayUtils
-
-# arrayUtils
-
-## Modules
-
-- [\<internal\>](-internal-.md)
-
-## Type Aliases
-
-### FilterAndMapReturn\<T\>
-
-```ts
-type FilterAndMapReturn<T> = false | T;
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:42](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L42)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-## Functions
-
-### arrayOps()
-
-```ts
-function arrayOps<T>(array): ArrayOps<T>;
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:318](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L318)
-
-Enhance an array with extra methods
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### array
-
-`T`[]
-
-#### Returns
-
-[`ArrayOps`](-internal-.md#arrayops)\<`T`\>
-
-#### Example
-
-```ts
-const enhancedItems = arrayOps(array);
-
-enhancedItems.filterAndMap((item) => item === 2 ? false : item);
-enhancedItems.sortBy((item) => item);
-enhancedItems.rejectDuplicates((item) => item);
-```
-
-***
-
-### arrayWithPrev()
-
-```ts
-function arrayWithPrev<T>(array): [T, null | T][];
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:138](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L138)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### array
-
-`T`[]
-
-#### Returns
-
-\[`T`, `null` \| `T`\][]
-
-***
-
-### arrayWithPrevAndIndex()
-
-```ts
-function arrayWithPrevAndIndex<T>(array): object[];
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:142](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L142)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### array
-
-`T`[]
-
-#### Returns
-
-`object`[]
-
-***
-
-### filterAndMap()
-
-```ts
-function filterAndMap<T, R>(array, mapFilter): R[];
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:23](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L23)
-
-allow to filter and map with better typing ergonomics
-
-In the `mapFilter` function return `false` to reject the item, or any other
-value to map it.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-##### R
-
-`R`
-
-#### Parameters
-
-##### array
-
-`IterableIterator`\<`T`, `any`, `any`\> | readonly `T`[]
-
-##### mapFilter
-
-(`item`, `index`) => `false` \| `R`
-
-#### Returns
-
-`R`[]
-
-#### Example
-
-```ts
-// Filter reject and turn value into `value mapped`
-const items = ['value', 'value', 'reject', 'reject'];
-
-const mappedItems = filterAndMap(items, (item) =>
-  item === 'reject'
-    ? false
-    : `${item} mapped`,
-);
-
-mappedItems; // ['value mapped', 'value mapped']
-```
-
-***
-
-### findAfterIndex()
-
-```ts
-function findAfterIndex<T>(
-   array, 
-   index, 
-   predicate): undefined | T;
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:165](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L165)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### array
-
-`T`[]
-
-##### index
-
-`number`
-
-##### predicate
-
-(`item`) => `boolean`
-
-#### Returns
-
-`undefined` \| `T`
-
-***
-
-### findAndMap()
-
-```ts
-function findAndMap<T, R>(array, predicate): undefined | R;
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:295](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L295)
-
-Finds the first item in an array where the predicate returns a non-false value and returns that mapped value.
-
-Combines find and map operations - applies the predicate to each item until one returns
-a value that is not `false`, then returns that mapped value. If no item matches, returns `undefined`.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-##### R
-
-`R`
-
-#### Parameters
-
-##### array
-
-`T`[]
-
-The array to search through
-
-##### predicate
-
-(`value`) => `false` \| `R`
-
-Function that returns a mapped value or `false` to skip the item
-
-#### Returns
-
-`undefined` \| `R`
-
-The first mapped value that is not `false`, or `undefined` if no item matches
-
-#### Example
-
-```ts
-const users = [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }];
-
-const foundName = findAndMap(users, (user) => 
-  user.id === 2 ? user.name.toUpperCase() : false
-);
-// foundName is 'BOB'
-```
-
-***
-
-### findBeforeIndex()
-
-```ts
-function findBeforeIndex<T>(
-   array, 
-   index, 
-   predicate): undefined | T;
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:179](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L179)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### array
-
-`T`[]
-
-##### index
-
-`number`
-
-##### predicate
-
-(`item`) => `boolean`
-
-#### Returns
-
-`undefined` \| `T`
-
-***
-
-### getAscIndexOrder()
-
-```ts
-function getAscIndexOrder(index): number;
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:134](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L134)
-
-Get the correct 0 based value for sync with other array in ascending order
-
-#### Parameters
-
-##### index
-
-`undefined` | `number`
-
-#### Returns
-
-`number`
-
-#### Example
-
-```ts
-const items = [1, 2, 3];
-
-const index = sortBy(
-  items,
-  (item) => getAscIndexOrder(
-    followOrder.findIndex((order) => order === item)
-  )
-);
-```
-
-***
-
-### hasDuplicates()
-
-```ts
-function hasDuplicates<T>(array, getKey): boolean;
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:203](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L203)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### array
-
-`T`[]
-
-##### getKey
-
-(`item`) => `unknown`
-
-#### Returns
-
-`boolean`
-
-***
-
-### isInArray()
-
-```ts
-function isInArray<T, U>(value, oneOf): value is U;
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:152](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L152)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-##### U
-
-`U`
-
-#### Parameters
-
-##### value
-
-`T`
-
-##### oneOf
-
-readonly `U`[]
-
-#### Returns
-
-`value is U`
-
-***
-
-### rejectArrayUndefinedValues()
-
-```ts
-function rejectArrayUndefinedValues<T>(array): T;
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:199](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L199)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `unknown`[]
-
-#### Parameters
-
-##### array
-
-`T`
-
-#### Returns
-
-`T`
-
-***
-
-### rejectDuplicates()
-
-```ts
-function rejectDuplicates<T>(array, getKey): T[];
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:220](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L220)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### array
-
-`T`[]
-
-##### getKey
-
-(`item`) => `unknown`
-
-#### Returns
-
-`T`[]
-
-***
-
-### sortBy()
-
-```ts
-function sortBy<T>(
-   arr, 
-   sortByValue, 
-   props): T[];
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:76](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L76)
-
-Sort an array based on a value
-
-Sort by `ascending` order by default
-
-Use `Infinity` as as wildcard to absolute max and min values
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### arr
-
-`T`[]
-
-##### sortByValue
-
-[`SortByValue`](-internal-.md#sortbyvalue)\<`T`\>
-
-##### props
-
-[`SortByProps`](-internal-.md#sortbyprops) = `'asc'`
-
-#### Returns
-
-`T`[]
-
-#### Example
-
-```ts
-const items = [1, 3, 2, 4];
-
-const sortedItems = sortBy(items, (item) => item);
-// [1, 2, 3, 4]
-
-const items2 = [{ a: 1, b: 2 }, { a: 2, b: 1 }, { a: 1, b: 1}]
-
-// return a array to sort by multiple values
-const sortedItems = sortBy(items, (item) => [item.a, item.b]);
-```
-
-***
-
-### truncateArray()
-
-```ts
-function truncateArray<T>(
-   array, 
-   maxLength, 
-   appendIfTruncated?): T[];
-```
-
-Defined in: [packages/utils/src/arrayUtils.ts:240](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L240)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### array
-
-`T`[]
-
-##### maxLength
-
-`number`
-
-##### appendIfTruncated?
-
-`T` | (`truncatedCount`) => `T`
-
-#### Returns
-
-`T`[]