@ls-stack/utils 3.39.0 → 3.41.0

package/docs/saferTyping.md

@@ -1,228 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / saferTyping
-
-# saferTyping
-
-## Type Aliases
-
-### \_\_FIX\_THIS\_TYPING\_\_
-
-```ts
-type __FIX_THIS_TYPING__ = any;
-```
-
-Defined in: [packages/utils/src/saferTyping.ts:51](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L51)
-
-***
-
-### \_\_LEGIT\_ANY\_\_
-
-```ts
-type __LEGIT_ANY__ = any;
-```
-
-Defined in: [packages/utils/src/saferTyping.ts:4](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L4)
-
-Use this only when you have 100% of certainty that this will not break the types
-
-***
-
-### \_\_LEGIT\_ANY\_FUNCTION\_\_()
-
-```ts
-type __LEGIT_ANY_FUNCTION__ = (...params) => __LEGIT_ANY__;
-```
-
-Defined in: [packages/utils/src/saferTyping.ts:8](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L8)
-
-#### Parameters
-
-##### params
-
-...`any`
-
-#### Returns
-
-[`__LEGIT_ANY__`](#__legit_any__)
-
-***
-
-### AnyNonPrimitiveValue
-
-```ts
-type AnyNonPrimitiveValue = object;
-```
-
-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
-
-***
-
-### EmptyObject
-
-```ts
-type EmptyObject = Record<string, never>;
-```
-
-Defined in: [packages/utils/src/saferTyping.ts:13](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L13)
-
-An empty object type, equivalent to `{}` but with safer typing
-
-## Functions
-
-### \_\_FIX\_THIS\_CASTING\_\_()
-
-```ts
-function __FIX_THIS_CASTING__<T>(value): T;
-```
-
-Defined in: [packages/utils/src/saferTyping.ts:47](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L47)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### value
-
-`unknown`
-
-#### Returns
-
-`T`
-
-***
-
-### \_\_FIX\_THIS\_TYPING\_\_()
-
-```ts
-function __FIX_THIS_TYPING__(value): any;
-```
-
-Defined in: [packages/utils/src/saferTyping.ts:51](https://github.com/lucasols/utils/blob/main/packages/utils/src/saferTyping.ts#L51)
-
-#### Parameters
-
-##### value
-
-`unknown`
-
-#### Returns
-
-`any`
-
-***
-
-### \_\_LEGIT\_ANY\_CAST\_\_()
-
-```ts
-function __LEGIT_ANY_CAST__<V>(value): any;
-```
-
-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.
-
-#### Type Parameters
-
-##### V
-
-`V` = `unknown`
-
-(optional) - When used enforces that the casted value is assignable to the type V, use it for safer casts
-
-#### Parameters
-
-##### value
-
-`V`
-
-#### Returns
-
-`any`
-
-***
-
-### \_\_LEGIT\_CAST\_\_()
-
-```ts
-function __LEGIT_CAST__<T, V>(value): T;
-```
-
-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.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-The type to cast to
-
-##### V
-
-`V` = `unknown`
-
-(optional) - When used enforces that the casted value is assignable to the type V, use it for safer casts
-
-#### Parameters
-
-##### value
-
-`V`
-
-#### Returns
-
-`T`
-
-***
-
-### \_\_REFINE\_CAST\_\_()
-
-```ts
-function __REFINE_CAST__<T>(value): <R>() => R;
-```
-
-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.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-The type to cast to
-
-#### Parameters
-
-##### value
-
-`T`
-
-#### Returns
-
-```ts
-<R>(): R;
-```
-
-##### Type Parameters
-
-###### R
-
-`R`
-
-##### Returns
-
-`R`

package/docs/serializeXML.md

@@ -1,100 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / serializeXML
-
-# serializeXML
-
-## Type Aliases
-
-### SerializeOptions
-
-```ts
-type SerializeOptions = object;
-```
-
-Defined in: [packages/utils/src/serializeXML.ts:36](https://github.com/lucasols/utils/blob/main/packages/utils/src/serializeXML.ts#L36)
-
-#### Properties
-
-##### escapeText?
-
-```ts
-optional escapeText: boolean;
-```
-
-Defined in: [packages/utils/src/serializeXML.ts:38](https://github.com/lucasols/utils/blob/main/packages/utils/src/serializeXML.ts#L38)
-
-##### indent?
-
-```ts
-optional indent: number | string;
-```
-
-Defined in: [packages/utils/src/serializeXML.ts:37](https://github.com/lucasols/utils/blob/main/packages/utils/src/serializeXML.ts#L37)
-
-##### invalidNodes?
-
-```ts
-optional invalidNodes: "throw" | "reject";
-```
-
-Defined in: [packages/utils/src/serializeXML.ts:40](https://github.com/lucasols/utils/blob/main/packages/utils/src/serializeXML.ts#L40)
-
-##### validateTagName?
-
-```ts
-optional validateTagName: boolean;
-```
-
-Defined in: [packages/utils/src/serializeXML.ts:39](https://github.com/lucasols/utils/blob/main/packages/utils/src/serializeXML.ts#L39)
-
-***
-
-### XMLNode
-
-```ts
-type XMLNode = 
-  | {
-  attrs?: Record<string, string | number | boolean | null | undefined>;
-  children?: (XMLNode | null | undefined | false)[] | string;
-  escapeText?: boolean;
-  name: string;
-  type?: "node";
-}
-  | {
-  content: string;
-  escapeText?: boolean;
-  type: "comment";
-}
-  | {
-  type: "emptyLine";
-};
-```
-
-Defined in: [packages/utils/src/serializeXML.ts:19](https://github.com/lucasols/utils/blob/main/packages/utils/src/serializeXML.ts#L19)
-
-## Functions
-
-### serializeXML()
-
-```ts
-function serializeXML(node, options?): string;
-```
-
-Defined in: [packages/utils/src/serializeXML.ts:43](https://github.com/lucasols/utils/blob/main/packages/utils/src/serializeXML.ts#L43)
-
-#### Parameters
-
-##### node
-
-[`XMLNode`](#xmlnode) | false \| XMLNode \| null \| undefined[]
-
-##### options?
-
-[`SerializeOptions`](#serializeoptions)
-
-#### Returns
-
-`string`

package/docs/shallowEqual.md

@@ -1,33 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / shallowEqual
-
-# shallowEqual
-
-## Functions
-
-### shallowEqual()
-
-```ts
-function shallowEqual(foo, bar): boolean;
-```
-
-Defined in: [packages/utils/src/shallowEqual.ts:11](https://github.com/lucasols/utils/blob/main/packages/utils/src/shallowEqual.ts#L11)
-
-shallow equal version of https://github.com/lukeed/dequal
-
-#### Parameters
-
-##### foo
-
-`any`
-
-##### bar
-
-`any`
-
-#### Returns
-
-`boolean`

package/docs/sleep.md

@@ -1,27 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / sleep
-
-# sleep
-
-## Functions
-
-### sleep()
-
-```ts
-function sleep(ms): Promise<unknown>;
-```
-
-Defined in: [packages/utils/src/sleep.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/sleep.ts#L1)
-
-#### Parameters
-
-##### ms
-
-`number`
-
-#### Returns
-
-`Promise`\<`unknown`\>

package/docs/stringUtils/-internal-.md

@@ -1,17 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / [stringUtils](README.md) / \<internal\>
-
-# \<internal\>
-
-## Type Aliases
-
-### Arg
-
-```ts
-type Arg = string | false | undefined | null;
-```
-
-Defined in: [packages/utils/src/stringUtils.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L1)

package/docs/stringUtils/README.md

@@ -1,270 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / stringUtils
-
-# stringUtils
-
-## Modules
-
-- [\<internal\>](-internal-.md)
-
-## Variables
-
-### ~~joinStrings()~~
-
-```ts
-const joinStrings: (...args) => string = concatStrings;
-```
-
-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
-
-#### Parameters
-
-##### args
-
-...([`Arg`](-internal-.md#arg) \| [`Arg`](-internal-.md#arg)[])[]
-
-#### Returns
-
-`string`
-
-#### Example
-
-```ts
-joinStrings('a', 'b', 'c') // 'abc'
-joinStrings('a', false, 'c') // 'ac'
-joinStrings('a', addBString ? 'b' : null, 'c') // 'ac' if addBString is false, 'abc' if addBString is true
-```
-
-#### Deprecated
-
-Use [concatStrings](#concatstrings) instead
-
-## Functions
-
-### concatStrings()
-
-```ts
-function concatStrings(...args): string;
-```
-
-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
-
-#### Parameters
-
-##### args
-
-...([`Arg`](-internal-.md#arg) \| [`Arg`](-internal-.md#arg)[])[]
-
-#### Returns
-
-`string`
-
-#### Example
-
-```ts
-joinStrings('a', 'b', 'c') // 'abc'
-joinStrings('a', false, 'c') // 'ac'
-joinStrings('a', addBString ? 'b' : null, 'c') // 'ac' if addBString is false, 'abc' if addBString is true
-```
-
-***
-
-### convertToCamelCase()
-
-```ts
-function convertToCamelCase(str): string;
-```
-
-Defined in: [packages/utils/src/stringUtils.ts:72](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L72)
-
-#### Parameters
-
-##### str
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### convertToPascalCase()
-
-```ts
-function convertToPascalCase(str): string;
-```
-
-Defined in: [packages/utils/src/stringUtils.ts:65](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L65)
-
-#### Parameters
-
-##### str
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### convertToSentenceCase()
-
-```ts
-function convertToSentenceCase(str): string;
-```
-
-Defined in: [packages/utils/src/stringUtils.ts:77](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L77)
-
-#### Parameters
-
-##### str
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### convertToSnakeCase()
-
-```ts
-function convertToSnakeCase(str): string;
-```
-
-Defined in: [packages/utils/src/stringUtils.ts:54](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L54)
-
-#### Parameters
-
-##### str
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### convertToTitleCase()
-
-```ts
-function convertToTitleCase(str): string;
-```
-
-Defined in: [packages/utils/src/stringUtils.ts:85](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L85)
-
-#### Parameters
-
-##### str
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### formatNum()
-
-```ts
-function formatNum(num, maxDecimalsOrOptions): string;
-```
-
-Defined in: [packages/utils/src/stringUtils.ts:36](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L36)
-
-#### Parameters
-
-##### num
-
-`number`
-
-##### maxDecimalsOrOptions
-
-`number` | `NumberFormatOptions`
-
-#### Returns
-
-`string`
-
-***
-
-### isSnakeCase()
-
-```ts
-function isSnakeCase(str): boolean;
-```
-
-Defined in: [packages/utils/src/stringUtils.ts:50](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L50)
-
-#### Parameters
-
-##### str
-
-`string`
-
-#### Returns
-
-`boolean`
-
-***
-
-### 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
-function truncateString(
-   str, 
-   length, 
-   ellipsis): string;
-```
-
-Defined in: [packages/utils/src/stringUtils.ts:92](https://github.com/lucasols/utils/blob/main/packages/utils/src/stringUtils.ts#L92)
-
-#### Parameters
-
-##### str
-
-`string`
-
-##### length
-
-`number`
-
-##### ellipsis
-
-`string` = `'…'`
-
-#### Returns
-
-`string`