@ls-stack/utils 3.24.1 → 3.26.0

package/docs/_media/modules.md

@@ -21,6 +21,7 @@
 - [deepEqual](deepEqual.md)
 - [enhancedMap](enhancedMap.md)
 - [exhaustiveMatch](exhaustiveMatch/README.md)
+- [filterObjectOrArrayKeys](filterObjectOrArrayKeys.md)
 - [getAutoIncrementId](getAutoIncrementId.md)
 - [getCompositeKey](getCompositeKey.md)
 - [getValueStableKey](getValueStableKey.md)

package/docs/arrayUtils/-internal-.md

@@ -14,4 +14,4 @@
 type SortOrder = "desc" | "asc";
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:42](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L42)
+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

@@ -18,7 +18,7 @@
 type FilterAndMapReturn<T> = false | T;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:40](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L40)
+Defined in: [packages/utils/src/arrayUtils.ts:42](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L42)
 
 #### Type Parameters
 
@@ -34,7 +34,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:40](https://github.com/lucasols/ut
 function arrayWithPrev<T>(array): [T, null | T][];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:103](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L103)
+Defined in: [packages/utils/src/arrayUtils.ts:108](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L108)
 
 #### Type Parameters
 
@@ -60,7 +60,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:103](https://github.com/lucasols/u
 function arrayWithPrevAndIndex<T>(array): object[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:107](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L107)
+Defined in: [packages/utils/src/arrayUtils.ts:112](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L112)
 
 #### Type Parameters
 
@@ -86,7 +86,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:107](https://github.com/lucasols/u
 function filterAndMap<T, R>(array, mapFilter): R[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:21](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L21)
+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
 
@@ -143,7 +143,7 @@ function findAfterIndex<T>(
    predicate): undefined | T;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:130](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L130)
+Defined in: [packages/utils/src/arrayUtils.ts:135](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L135)
 
 #### Type Parameters
 
@@ -180,7 +180,7 @@ function findBeforeIndex<T>(
    predicate): undefined | T;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:144](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L144)
+Defined in: [packages/utils/src/arrayUtils.ts:149](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L149)
 
 #### Type Parameters
 
@@ -214,7 +214,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:144](https://github.com/lucasols/u
 function hasDuplicates<T>(array, getKey): boolean;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:168](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L168)
+Defined in: [packages/utils/src/arrayUtils.ts:173](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L173)
 
 #### Type Parameters
 
@@ -244,7 +244,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:168](https://github.com/lucasols/u
 function isInArray<T, U>(value, oneOf): value is U;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:117](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L117)
+Defined in: [packages/utils/src/arrayUtils.ts:122](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L122)
 
 #### Type Parameters
 
@@ -278,7 +278,7 @@ readonly `U`[]
 function rejectArrayUndefinedValues<T>(array): T;
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:164](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L164)
+Defined in: [packages/utils/src/arrayUtils.ts:169](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L169)
 
 #### Type Parameters
 
@@ -304,7 +304,7 @@ Defined in: [packages/utils/src/arrayUtils.ts:164](https://github.com/lucasols/u
 function rejectDuplicates<T>(array, getKey): T[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:185](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L185)
+Defined in: [packages/utils/src/arrayUtils.ts:190](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L190)
 
 #### Type Parameters
 
@@ -337,7 +337,7 @@ function sortBy<T>(
    props): T[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:62](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L62)
+Defined in: [packages/utils/src/arrayUtils.ts:67](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L67)
 
 Sort an array based on a value
 
@@ -396,7 +396,7 @@ function truncateArray<T>(
    appendIfTruncated?): T[];
 ```
 
-Defined in: [packages/utils/src/arrayUtils.ts:205](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L205)
+Defined in: [packages/utils/src/arrayUtils.ts:210](https://github.com/lucasols/utils/blob/main/packages/utils/src/arrayUtils.ts#L210)
 
 #### Type Parameters
 

package/docs/consoleFmt.md

@@ -28,7 +28,7 @@ bgColor: (color, text) => string;
 
 ###### color
 
-`"green"` | `"red"` | `"blue"` | `"yellow"` | `"magenta"` | `"cyan"` | `"white"` | `"black"` | `"gray"` | `"brightRed"` | `"brightGreen"` | `"brightYellow"` | `"brightBlue"` | `"brightMagenta"` | `"brightCyan"` | `"brightWhite"`
+`"red"` | `"green"` | `"yellow"` | `"blue"` | `"magenta"` | `"cyan"` | `"white"` | `"black"` | `"gray"` | `"brightRed"` | `"brightGreen"` | `"brightYellow"` | `"brightBlue"` | `"brightMagenta"` | `"brightCyan"` | `"brightWhite"`
 
 ###### text
 
@@ -64,7 +64,7 @@ color: (color, text) => string = consoleColors;
 
 ###### color
 
-`"green"` | `"red"` | `"blue"` | `"yellow"` | `"magenta"` | `"cyan"` | `"white"` | `"black"` | `"gray"` | `"brightRed"` | `"brightGreen"` | `"brightYellow"` | `"brightBlue"` | `"brightMagenta"` | `"brightCyan"` | `"brightWhite"`
+`"red"` | `"green"` | `"yellow"` | `"blue"` | `"magenta"` | `"cyan"` | `"white"` | `"black"` | `"gray"` | `"brightRed"` | `"brightGreen"` | `"brightYellow"` | `"brightBlue"` | `"brightMagenta"` | `"brightCyan"` | `"brightWhite"`
 
 ###### text
 

package/docs/exhaustiveMatch/-internal-.md

@@ -30,7 +30,7 @@ Defined in: [packages/utils/src/exhaustiveMatch.ts:2](https://github.com/lucasol
 type Pattern<R> = { [P in K]: ((props: Extract<T, Record<D, P>>) => R) | "_never" };
 ```
 
-Defined in: [packages/utils/src/exhaustiveMatch.ts:52](https://github.com/lucasols/utils/blob/main/packages/utils/src/exhaustiveMatch.ts#L52)
+Defined in: [packages/utils/src/exhaustiveMatch.ts:56](https://github.com/lucasols/utils/blob/main/packages/utils/src/exhaustiveMatch.ts#L56)
 
 #### Type Parameters
 

package/docs/exhaustiveMatch/README.md

@@ -93,7 +93,7 @@ match with early evaluation of the values
 function exhaustiveMatchObjUnion<T, D, K>(obj, key): object;
 ```
 
-Defined in: [packages/utils/src/exhaustiveMatch.ts:47](https://github.com/lucasols/utils/blob/main/packages/utils/src/exhaustiveMatch.ts#L47)
+Defined in: [packages/utils/src/exhaustiveMatch.ts:51](https://github.com/lucasols/utils/blob/main/packages/utils/src/exhaustiveMatch.ts#L51)
 
 #### Type Parameters
 

package/docs/filterObjectOrArrayKeys.md

@@ -0,0 +1,82 @@
+[**@ls-stack/utils**](README.md)
+
+***
+
+[@ls-stack/utils](modules.md) / filterObjectOrArrayKeys
+
+# filterObjectOrArrayKeys
+
+## Functions
+
+### filterObjectOrArrayKeys()
+
+```ts
+function filterObjectOrArrayKeys(objOrArray, options): Record<string, any> | Record<string, any>[];
+```
+
+Defined in: [packages/utils/src/filterObjectOrArrayKeys.ts:40](https://github.com/lucasols/utils/blob/main/packages/utils/src/filterObjectOrArrayKeys.ts#L40)
+
+Filters the keys of an object based on the provided patterns.
+
+Filtering patterns in `rejectKeys` and `filterKeys`:
+- `'prop'` - Only root-level properties named 'prop'
+- `'**prop'` - Any property named exactly 'prop' at any level (root or nested)
+- `'*.prop'` - Any nested property named 'prop' at second level (excludes root-level matches)
+- `'test.*.prop'` - Any property named 'prop' at second level of 'test'
+- `'test.*.test.**prop'` - Any property named 'prop' inside of 'test.*.test'
+- `'prop.nested'` - Exact nested property paths like `obj.prop.nested`
+- `'prop.**nested'` - All nested properties inside root `prop` with name `nested`
+- `'prop[0]'` - The first item of the `prop` array
+- `'prop[*]'` - All items of the `prop` array
+- `'prop[0].nested'` - `nested` prop of the first item of the `prop` array
+- `'prop[*].nested'` - `nested` prop of all items of the `prop` array
+- `'prop[*]**nested'` - all `nested` props of all items of the `prop` array
+- `'prop[0-2]'` - The first three items of the `prop` array
+- `'prop[4-*]'` - All items of the `prop` array from the fourth index to the end
+- `'prop[0-2].nested.**prop'` - Combining multiple nested patterns is supported
+- Root array:
+  - `'[0]'` - The first item of the root array
+  - `'[*]'` - All items of the array
+  - `'[0].nested'` - `nested` prop of the first item of the array
+  - `'[*].nested'` - `nested` prop of all items of the array
+  - `'[*]**nested'` - all `nested` props of all items of the array
+  - `'[0-2]'` - The first three items of the array
+  - `'[4-*]'` - All items of the array from the fourth index to the end
+- Selecting multiple properties:
+  - `'prop.test.(prop1|prop2|prop3)'` - The `prop1`, `prop2`, and `prop3` properties of `prop.test` object
+
+#### Parameters
+
+##### objOrArray
+
+The object or array to filter.
+
+`Record`\<`string`, `any`\> | `Record`\<`string`, `any`\>[]
+
+##### options
+
+The options for the filter.
+
+###### filterKeys?
+
+`string` \| `string`[]
+
+The keys to filter.
+
+###### rejectEmptyObjectsInArray?
+
+`boolean` = `true`
+
+Whether to reject empty objects in arrays (default: true).
+
+###### rejectKeys?
+
+`string` \| `string`[]
+
+The keys to reject.
+
+#### Returns
+
+`Record`\<`string`, `any`\> \| `Record`\<`string`, `any`\>[]
+
+The filtered object or array.

package/docs/modules.md

@@ -21,6 +21,7 @@
 - [deepEqual](deepEqual.md)
 - [enhancedMap](enhancedMap.md)
 - [exhaustiveMatch](exhaustiveMatch/README.md)
+- [filterObjectOrArrayKeys](filterObjectOrArrayKeys.md)
 - [getAutoIncrementId](getAutoIncrementId.md)
 - [getCompositeKey](getCompositeKey.md)
 - [getValueStableKey](getValueStableKey.md)

package/docs/objUtils.md

@@ -14,7 +14,7 @@
 function looseGetObjectProperty<T>(obj, key): undefined | T[keyof T];
 ```
 
-Defined in: [packages/utils/src/objUtils.ts:50](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L50)
+Defined in: [packages/utils/src/objUtils.ts:53](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L53)
 
 #### Type Parameters
 
@@ -44,7 +44,7 @@ Defined in: [packages/utils/src/objUtils.ts:50](https://github.com/lucasols/util
 function mapArrayToObject<T, K, O>(array, mapper): Record<K, O>;
 ```
 
-Defined in: [packages/utils/src/objUtils.ts:18](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L18)
+Defined in: [packages/utils/src/objUtils.ts:21](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L21)
 
 #### Type Parameters
 
@@ -82,7 +82,7 @@ Defined in: [packages/utils/src/objUtils.ts:18](https://github.com/lucasols/util
 function mapObjectToObject<I, K, O>(obj, mapper): Record<K, O>;
 ```
 
-Defined in: [packages/utils/src/objUtils.ts:25](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L25)
+Defined in: [packages/utils/src/objUtils.ts:28](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L28)
 
 #### Type Parameters
 
@@ -120,7 +120,7 @@ Defined in: [packages/utils/src/objUtils.ts:25](https://github.com/lucasols/util
 function objectTypedEntries<T>(obj): [Extract<keyof T, string>, T[keyof T]][];
 ```
 
-Defined in: [packages/utils/src/objUtils.ts:2](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L2)
+Defined in: [packages/utils/src/objUtils.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L5)
 
 #### Type Parameters
 
@@ -150,7 +150,7 @@ use typedObjectEntries from @ls-stack/utils/typingFnUtils instead
 function omit<T, K>(obj, keys): Omit<T, K>;
 ```
 
-Defined in: [packages/utils/src/objUtils.ts:35](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L35)
+Defined in: [packages/utils/src/objUtils.ts:38](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L38)
 
 #### Type Parameters
 
@@ -184,7 +184,7 @@ Defined in: [packages/utils/src/objUtils.ts:35](https://github.com/lucasols/util
 function pick<T, K>(obj, keys): Pick<T, K>;
 ```
 
-Defined in: [packages/utils/src/objUtils.ts:6](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L6)
+Defined in: [packages/utils/src/objUtils.ts:9](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L9)
 
 #### Type Parameters
 
@@ -218,7 +218,7 @@ Defined in: [packages/utils/src/objUtils.ts:6](https://github.com/lucasols/utils
 function rejectObjUndefinedValues<T>(obj): T;
 ```
 
-Defined in: [packages/utils/src/objUtils.ts:57](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L57)
+Defined in: [packages/utils/src/objUtils.ts:60](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L60)
 
 #### Type Parameters
 

package/docs/parallelAsyncCalls/-internal-.md

@@ -72,7 +72,7 @@ Defined in: [packages/utils/src/parallelAsyncCalls.ts:51](https://github.com/luc
 addTuple<T>(...calls): object;
 ```
 
-Defined in: [packages/utils/src/parallelAsyncCalls.ts:63](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L63)
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:66](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L66)
 
 adds calls return tuples with inferred results
 
@@ -139,7 +139,7 @@ runAll(__namedParameters): Promise<Result<Succeeded<R, M>[], {
 }>>;
 ```
 
-Defined in: [packages/utils/src/parallelAsyncCalls.ts:151](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L151)
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:154](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L154)
 
 ###### Parameters
 
@@ -167,7 +167,7 @@ runAllSettled(__namedParameters): Promise<{
 }>;
 ```
 
-Defined in: [packages/utils/src/parallelAsyncCalls.ts:96](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L96)
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:99](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L99)
 
 ###### Parameters
 

package/docs/parallelAsyncCalls/README.md

@@ -18,7 +18,7 @@
 function parallelAsyncCalls<M, R>(): ParallelAsyncResultCalls<M, R>;
 ```
 
-Defined in: [packages/utils/src/parallelAsyncCalls.ts:214](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L214)
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:217](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L217)
 
 Executes multiple asynchronous calls in parallel and collects the results in a easier to use format.
 

package/docs/retryOnError/README.md

@@ -23,7 +23,7 @@ function retryOnError<T>(
 originalMaxRetries): Promise<T>;
 ```
 
-Defined in: [packages/utils/src/retryOnError.ts:36](https://github.com/lucasols/utils/blob/main/packages/utils/src/retryOnError.ts#L36)
+Defined in: [packages/utils/src/retryOnError.ts:38](https://github.com/lucasols/utils/blob/main/packages/utils/src/retryOnError.ts#L38)
 
 Retries a function on error with configurable retry logic.
 

package/docs/runShellCmd/README.md

@@ -21,7 +21,7 @@ function concurrentCmd(
 onResult): Promise<() => void>;
 ```
 
-Defined in: [packages/utils/src/runShellCmd.ts:122](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L122)
+Defined in: [packages/utils/src/runShellCmd.ts:133](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L133)
 
 #### Parameters
 
@@ -60,10 +60,10 @@ import { concurrentCmd } from '@ls-stack/node-utils/runShellCmd';
 function runCmd(
    label, 
    command, 
-__namedParameters): Promise<CmdResult>;
+root0): Promise<CmdResult>;
 ```
 
-Defined in: [packages/utils/src/runShellCmd.ts:31](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L31)
+Defined in: [packages/utils/src/runShellCmd.ts:39](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L39)
 
 #### Parameters
 
@@ -75,7 +75,7 @@ Defined in: [packages/utils/src/runShellCmd.ts:31](https://github.com/lucasols/u
 
 `string` | `string`[]
 
-##### \_\_namedParameters
+##### root0
 
 [`RunCmdOptions`](-internal-.md#runcmdoptions) = `{}`
 
@@ -102,7 +102,7 @@ import { runCmd } from '@ls-stack/node-utils/runShellCmd';
 function runCmdSilent(command): Promise<CmdResult>;
 ```
 
-Defined in: [packages/utils/src/runShellCmd.ts:182](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L182)
+Defined in: [packages/utils/src/runShellCmd.ts:198](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L198)
 
 #### Parameters
 
@@ -133,7 +133,7 @@ import { runCmdSilent } from '@ls-stack/node-utils/runShellCmd';
 function runCmdSilentUnwrap(command): Promise<string>;
 ```
 
-Defined in: [packages/utils/src/runShellCmd.ts:196](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L196)
+Defined in: [packages/utils/src/runShellCmd.ts:213](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L213)
 
 #### Parameters
 
@@ -164,10 +164,10 @@ import { runCmdSilentUnwrap } from '@ls-stack/node-utils/runShellCmd';
 function runCmdUnwrap(
    label, 
    command, 
-__namedParameters): Promise<string>;
+root0): Promise<string>;
 ```
 
-Defined in: [packages/utils/src/runShellCmd.ts:160](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L160)
+Defined in: [packages/utils/src/runShellCmd.ts:175](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L175)
 
 #### Parameters
 
@@ -179,7 +179,7 @@ Defined in: [packages/utils/src/runShellCmd.ts:160](https://github.com/lucasols/
 
 `string` | `string`[]
 
-##### \_\_namedParameters
+##### root0
 
 ###### silent?
 

package/docs/safeJson.md

@@ -14,7 +14,7 @@
 function safeJsonParse(value): unknown;
 ```
 
-Defined in: [packages/utils/src/safeJson.ts:11](https://github.com/lucasols/utils/blob/main/packages/utils/src/safeJson.ts#L11)
+Defined in: [packages/utils/src/safeJson.ts:17](https://github.com/lucasols/utils/blob/main/packages/utils/src/safeJson.ts#L17)
 
 JSON.parse can throw if the value is not valid JSON, this function catches those errors and returns undefined
 
@@ -36,7 +36,7 @@ JSON.parse can throw if the value is not valid JSON, this function catches those
 function safeJsonStringify(value): undefined | string;
 ```
 
-Defined in: [packages/utils/src/safeJson.ts:2](https://github.com/lucasols/utils/blob/main/packages/utils/src/safeJson.ts#L2)
+Defined in: [packages/utils/src/safeJson.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/safeJson.ts#L5)
 
 JSON.stringify can throw if the value is circular or contains functions, this function catches those errors and returns undefined
 

package/docs/saferTyping.md

@@ -14,7 +14,7 @@
 type __FIX_THIS_TYPING__ = any;
 ```
 
-Defined in: [packages/utils/src/saferTyping.ts:48](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L48)
+Defined in: [packages/utils/src/saferTyping.ts:51](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L51)
 
 ***
 
@@ -56,7 +56,7 @@ Defined in: [packages/utils/src/saferTyping.ts:8](https://github.com/lucasols/ut
 type AnyNonPrimitiveValue = object;
 ```
 
-Defined in: [packages/utils/src/saferTyping.ts:56](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L56)
+Defined in: [packages/utils/src/saferTyping.ts:59](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L59)
 
 Any type that is not a primitive (number, string, boolean, null, undefined, symbol, bigint, ...)
 Equivalent to `object` type
@@ -81,7 +81,7 @@ An empty object type, equivalent to `{}` but with safer typing
 function __FIX_THIS_CASTING__<T>(value): T;
 ```
 
-Defined in: [packages/utils/src/saferTyping.ts:44](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L44)
+Defined in: [packages/utils/src/saferTyping.ts:47](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L47)
 
 #### Type Parameters
 
@@ -107,7 +107,7 @@ Defined in: [packages/utils/src/saferTyping.ts:44](https://github.com/lucasols/u
 function __FIX_THIS_TYPING__(value): any;
 ```
 
-Defined in: [packages/utils/src/saferTyping.ts:48](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L48)
+Defined in: [packages/utils/src/saferTyping.ts:51](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L51)
 
 #### Parameters
 
@@ -127,7 +127,7 @@ Defined in: [packages/utils/src/saferTyping.ts:48](https://github.com/lucasols/u
 function __LEGIT_ANY_CAST__<V>(value): any;
 ```
 
-Defined in: [packages/utils/src/saferTyping.ts:20](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L20)
+Defined in: [packages/utils/src/saferTyping.ts:21](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L21)
 
 Cast a value to `any` type. Use this when you have legit usage of `any` casting.
 
@@ -157,7 +157,7 @@ Cast a value to `any` type. Use this when you have legit usage of `any` casting.
 function __LEGIT_CAST__<T, V>(value): T;
 ```
 
-Defined in: [packages/utils/src/saferTyping.ts:30](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L30)
+Defined in: [packages/utils/src/saferTyping.ts:32](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L32)
 
 Cast a value to a specific type T. Use this when you have legit usage of type assertion.
 
@@ -193,7 +193,7 @@ The type to cast to
 function __REFINE_CAST__<T>(value): <R>() => R;
 ```
 
-Defined in: [packages/utils/src/saferTyping.ts:40](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L40)
+Defined in: [packages/utils/src/saferTyping.ts:43](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L43)
 
 Refine a value to a specific type T. Use this when you have legit usage of type assertion.
 

package/docs/stringUtils/README.md

@@ -18,7 +18,7 @@
 const joinStrings: (...args) => string = concatStrings;
 ```
 
-Defined in: [packages/utils/src/stringUtils.ts:33](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L33)
+Defined in: [packages/utils/src/stringUtils.ts:34](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L34)
 
 A util to create more legible conditional concatenated strings
 
@@ -52,7 +52,7 @@ Use [concatStrings](#concatstrings) instead
 function concatStrings(...args): string;
 ```
 
-Defined in: [packages/utils/src/stringUtils.ts:11](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L11)
+Defined in: [packages/utils/src/stringUtils.ts:12](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L12)
 
 A util to create more legible conditional concatenated strings
 
@@ -82,7 +82,7 @@ joinStrings('a', addBString ? 'b' : null, 'c') // 'ac' if addBString is false, '
 function convertToSnakeCase(str): string;
 ```
 
-Defined in: [packages/utils/src/stringUtils.ts:46](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L46)
+Defined in: [packages/utils/src/stringUtils.ts:47](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L47)
 
 #### Parameters
 
@@ -102,7 +102,7 @@ Defined in: [packages/utils/src/stringUtils.ts:46](https://github.com/lucasols/u
 function formatNum(num): string;
 ```
 
-Defined in: [packages/utils/src/stringUtils.ts:35](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L35)
+Defined in: [packages/utils/src/stringUtils.ts:36](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L36)
 
 #### Parameters
 
@@ -122,7 +122,7 @@ Defined in: [packages/utils/src/stringUtils.ts:35](https://github.com/lucasols/u
 function isSnakeCase(str): boolean;
 ```
 
-Defined in: [packages/utils/src/stringUtils.ts:42](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L42)
+Defined in: [packages/utils/src/stringUtils.ts:43](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L43)
 
 #### Parameters
 
@@ -145,7 +145,7 @@ function truncateString(
    ellipsis): string;
 ```
 
-Defined in: [packages/utils/src/stringUtils.ts:53](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L53)
+Defined in: [packages/utils/src/stringUtils.ts:54](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L54)
 
 #### Parameters