@ls-stack/utils 3.32.0 → 3.34.0

package/docs/arrayUtils/README.md

@@ -28,13 +28,51 @@ Defined in: [packages/utils/src/arrayUtils.ts:42](https://github.com/lucasols/ut
 
 ## Functions
 
+### arrayOps()
+
+```ts
+function arrayOps<T>(array): ArrayOps<T>;
+```
+
+Defined in: [packages/utils/src/arrayUtils.ts:289](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L289)
+
+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:108](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L108)
+Defined in: [packages/utils/src/arrayUtils.ts:138](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L138)
 
 #### Type Parameters
 
@@ -60,7 +98,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:108](https://github.com/lucasols/u
 function arrayWithPrevAndIndex<T>(array): object[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:112](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L112)
+Defined in: [packages/utils/src/arrayUtils.ts:142](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L142)
 
 #### Type Parameters
 
@@ -143,7 +181,7 @@ function findAfterIndex<T>(
    predicate): undefined | T;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:135](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L135)
+Defined in: [packages/utils/src/arrayUtils.ts:165](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L165)
 
 #### Type Parameters
 
@@ -180,7 +218,7 @@ function findBeforeIndex<T>(
    predicate): undefined | T;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:149](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L149)
+Defined in: [packages/utils/src/arrayUtils.ts:179](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L179)
 
 #### Type Parameters
 
@@ -208,13 +246,48 @@ Defined in: [packages/utils/src/arrayUtils.ts:149](https://github.com/lucasols/u
 
 ***
 
+### 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:173](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L173)
+Defined in: [packages/utils/src/arrayUtils.ts:203](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L203)
 
 #### Type Parameters
 
@@ -244,7 +317,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:173](https://github.com/lucasols/u
 function isInArray<T, U>(value, oneOf): value is U;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:122](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L122)
+Defined in: [packages/utils/src/arrayUtils.ts:152](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L152)
 
 #### Type Parameters
 
@@ -278,7 +351,7 @@ readonly `U`[]
 function rejectArrayUndefinedValues<T>(array): T;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:169](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L169)
+Defined in: [packages/utils/src/arrayUtils.ts:199](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L199)
 
 #### Type Parameters
 
@@ -304,7 +377,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:169](https://github.com/lucasols/u
 function rejectDuplicates<T>(array, getKey): T[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:190](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L190)
+Defined in: [packages/utils/src/arrayUtils.ts:220](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L220)
 
 #### Type Parameters
 
@@ -337,7 +410,7 @@ function sortBy<T>(
    props): T[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:67](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L67)
+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
 
@@ -359,13 +432,11 @@ Use `Infinity` as as wildcard to absolute max and min values
 
 ##### sortByValue
 
-(`item`) => `string` \| `number` \| (`string` \| `number`)[]
+[`SortByValue`](-internal-.md#sortbyvalue)\<`T`\>
 
 ##### props
 
-[`SortOrder`](-internal-.md#sortorder) | [`SortOrder`](-internal-.md#sortorder)[] | \{
-`order?`: SortOrder \| SortOrder\[\] \| undefined;
-\}
+[`SortByProps`](-internal-.md#sortbyprops) = `'asc'`
 
 #### Returns
 
@@ -396,7 +467,7 @@ function truncateArray<T>(
    appendIfTruncated?): T[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:210](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L210)
+Defined in: [packages/utils/src/arrayUtils.ts:240](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L240)
 
 #### Type Parameters
 

package/docs/stringUtils/README.md

@@ -220,6 +220,26 @@ Defined in: [packages/utils/src/stringUtils.ts:50](https://github.com/lucasols/u
 
 ***
 
+### removeANSIColors()
+
+```ts
+function removeANSIColors(str): string;
+```
+
+Defined in: [packages/utils/src/stringUtils.ts:98](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L98)
+
+#### Parameters
+
+##### str
+
+`string`
+
+#### Returns
+
+`string`
+
+***
+
 ### truncateString()
 
 ```ts

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@ls-stack/utils",
   "description": "Universal TypeScript utilities for browser and Node.js",
-  "version": "3.32.0",
+  "version": "3.34.0",
   "license": "MIT",
   "files": [
-    "lib",
+    "dist",
     "docs"
   ],
   "repository": "github:lucasols/utils",