@ls-stack/utils 3.40.0 → 3.41.0

package/docs/typingFnUtils/README.md

@@ -1,317 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / typingFnUtils
-
-# typingFnUtils
-
-## Modules
-
-- [\<internal\>](-internal-.md)
-
-## Variables
-
-### ~~isSubTypeOf()~~
-
-```ts
-const isSubTypeOf: <BaseType, SubType>() => unknown = typeOnRightExtendsLeftType;
-```
-
-Defined in: [packages/utils/src/typingFnUtils.ts:79](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingFnUtils.ts#L79)
-
-Type helper to check if a type is a subtype of another type.
-
-#### Type Parameters
-
-##### BaseType
-
-`BaseType`
-
-The base type to check against
-
-##### SubType
-
-`SubType`
-
-The type that should extend BaseType
-
-#### Returns
-
-`unknown`
-
-Returns undefined, only used for type checking
-
-#### Deprecated
-
-use typeOnRightExtendsLeftType instead
-
-## Functions
-
-### asNonPartial()
-
-```ts
-function asNonPartial<T>(obj): NonPartial<T>;
-```
-
-Defined in: [packages/utils/src/typingFnUtils.ts:4](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingFnUtils.ts#L4)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-#### Parameters
-
-##### obj
-
-`T`
-
-#### Returns
-
-[`NonPartial`](../typingUtils.md#nonpartial)\<`T`\>
-
-***
-
-### asPartialUndefinedValues()
-
-```ts
-function asPartialUndefinedValues<T>(value): T;
-```
-
-Defined in: [packages/utils/src/typingFnUtils.ts:110](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingFnUtils.ts#L110)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-#### Parameters
-
-##### value
-
-\{ \[P in string \| number \| symbol\]: (Partial\<Pick\<T, KeysWithUndefinedValues\<T\>\>\> & Omit\<T, KeysWithUndefinedValues\<T\>\>)\[P\] \}
-
-#### Returns
-
-`T`
-
-***
-
-### asType()
-
-```ts
-function asType<T>(value): T;
-```
-
-Defined in: [packages/utils/src/typingFnUtils.ts:38](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingFnUtils.ts#L38)
-
-a safe way to cast types, use to substitute the `as Type`
-
-#### Type Parameters
-
-##### T
-
-`T` = `unknown`
-
-#### Parameters
-
-##### value
-
-`T`
-
-#### Returns
-
-`T`
-
-***
-
-### isObjKey()
-
-```ts
-function isObjKey<T>(key, obj): key is keyof T;
-```
-
-Defined in: [packages/utils/src/typingFnUtils.ts:86](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingFnUtils.ts#L86)
-
-Type helper to narrow a string to a key of an object.
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-#### Parameters
-
-##### key
-
-`unknown`
-
-##### obj
-
-`T`
-
-#### Returns
-
-`key is keyof T`
-
-***
-
-### narrowStringToUnion()
-
-```ts
-function narrowStringToUnion<T>(key, union): undefined | T;
-```
-
-Defined in: [packages/utils/src/typingFnUtils.ts:47](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingFnUtils.ts#L47)
-
-narrow a string to a union of strings
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `string`
-
-#### Parameters
-
-##### key
-
-`undefined` | `null` | `string`
-
-##### union
-
-`Set`\<`T`\> | `T`[] | readonly `T`[]
-
-#### Returns
-
-`undefined` \| `T`
-
-***
-
-### typedObjectEntries()
-
-```ts
-function typedObjectEntries<T>(obj): NonNullable<{ [K in string | number | symbol]: [K, T[K]] }[keyof T]>[];
-```
-
-Defined in: [packages/utils/src/typingFnUtils.ts:14](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingFnUtils.ts#L14)
-
-a wrapper to Object.entries with a better typing inference
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-#### Parameters
-
-##### obj
-
-`T`
-
-#### Returns
-
-`NonNullable`\<\{ \[K in string \| number \| symbol\]: \[K, T\[K\]\] \}\[keyof `T`\]\>[]
-
-***
-
-### typedObjectKeys()
-
-```ts
-function typedObjectKeys<T>(obj): keyof T[];
-```
-
-Defined in: [packages/utils/src/typingFnUtils.ts:28](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingFnUtils.ts#L28)
-
-a wrapper to Object.keys with a better typing inference
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-#### Parameters
-
-##### obj
-
-`T`
-
-#### Returns
-
-keyof `T`[]
-
-***
-
-### typeOnRightExtendsLeftType()
-
-```ts
-function typeOnRightExtendsLeftType<BaseType, SubType>(): unknown;
-```
-
-Defined in: [packages/utils/src/typingFnUtils.ts:71](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingFnUtils.ts#L71)
-
-Type helper to check if a type is a subtype of another type.
-
-#### Type Parameters
-
-##### BaseType
-
-`BaseType`
-
-The base type to check against
-
-##### SubType
-
-`SubType`
-
-The type that should extend BaseType
-
-#### Returns
-
-`unknown`
-
-Returns undefined, only used for type checking
-
-***
-
-### unionsAreTheSame()
-
-```ts
-function unionsAreTheSame<T, U>(_diff): void;
-```
-
-Defined in: [packages/utils/src/typingFnUtils.ts:108](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingFnUtils.ts#L108)
-
-Type helper to compare two union types and determine their relationship.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-The first union type (left side)
-
-##### U
-
-`U`
-
-The second union type (right side)
-
-#### Parameters
-
-##### \_diff
-
-[`UnionDiff`](-internal-.md#uniondiff)\<`T`, `U`\>
-
-null if unions are identical, or an object describing the errors
-
-#### Returns
-
-`void`

package/docs/typingTestUtils.md

@@ -1,172 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / typingTestUtils
-
-# typingTestUtils
-
-## Type Aliases
-
-### TestTypeIsEqual\<X, Y\>
-
-```ts
-type TestTypeIsEqual<X, Y> = <T>() => T extends X ? 1 : 2 extends <T>() => T extends Y ? 1 : 2 ? true : false;
-```
-
-Defined in: [packages/utils/src/typingTestUtils.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingTestUtils.ts#L1)
-
-#### Type Parameters
-
-##### X
-
-`X`
-
-##### Y
-
-`Y`
-
-***
-
-### TestTypeNotEqual\<X, Y\>
-
-```ts
-type TestTypeNotEqual<X, Y> = true extends TestTypeIsEqual<X, Y> ? false : true;
-```
-
-Defined in: [packages/utils/src/typingTestUtils.ts:4](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingTestUtils.ts#L4)
-
-#### Type Parameters
-
-##### X
-
-`X`
-
-##### Y
-
-`Y`
-
-## Variables
-
-### typingTest
-
-```ts
-const typingTest: object;
-```
-
-Defined in: [packages/utils/src/typingTestUtils.ts:48](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingTestUtils.ts#L48)
-
-#### Type declaration
-
-##### describe()
-
-```ts
-describe: (title, func) => void;
-```
-
-###### Parameters
-
-###### title
-
-`string`
-
-###### func
-
-() => `any`
-
-###### Returns
-
-`void`
-
-##### expectType()
-
-```ts
-expectType: <T>() => T;
-```
-
-Helper function for type testing that ensures a type extends `true`.
-Used in combination with `TestTypeIsEqual` to verify type equality at compile time.
-
-###### Type Parameters
-
-###### T
-
-`T` *extends* `true`
-
-Type that must extend `true`
-
-###### Returns
-
-`T`
-
-An empty object cast to type T
-
-###### Example
-
-```ts
-expectType<TestTypeIsEqual<string, string>>(); // OK
-expectType<TestTypeIsEqual<string, number>>(); // Type error
-```
-
-##### expectTypesAre()
-
-```ts
-expectTypesAre: <X, Y>(result) => void;
-```
-
-Helper function for type testing that compares two types and expects a specific result.
-This function allows for more explicit type equality assertions with a descriptive result.
-
-###### Type Parameters
-
-###### X
-
-`X`
-
-First type to compare
-
-###### Y
-
-`Y`
-
-Second type to compare
-
-###### Parameters
-
-###### result
-
-[`TestTypeIsEqual`](#testtypeisequal)\<`X`, `Y`\> *extends* `true` ? `"equal"` : `"notEqual"`
-
-Expected comparison result: 'equal' if types are equal, 'notEqual' if they differ
-
-###### Returns
-
-`void`
-
-###### Example
-
-```ts
-expectTypesAre<string, string>('equal'); // OK
-expectTypesAre<string, number>('notEqual'); // OK
-expectTypesAre<string, string>('notEqual'); // Type error
-```
-
-##### test()
-
-```ts
-test: (title, func) => void;
-```
-
-###### Parameters
-
-###### title
-
-`string`
-
-###### func
-
-() => `any`
-
-###### Returns
-
-`void`

package/docs/typingUtils.md

@@ -1,135 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / typingUtils
-
-# typingUtils
-
-## Type Aliases
-
-### ~~DeepPrettify\<T\>~~
-
-```ts
-type DeepPrettify<T> = { [K in keyof T]: T[K] extends Record<string, unknown> ? DeepPrettify<T[K]> : T[K] } & object;
-```
-
-Defined in: [packages/utils/src/typingUtils.ts:31](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingUtils.ts#L31)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Deprecated
-
-Use `DeepPrettify` from `@ls-stack/utils/typeUtils` instead
-
-***
-
-### ~~IsAny\<T\>~~
-
-```ts
-type IsAny<T> = unknown extends T ? [keyof T] extends [never] ? false : true : false;
-```
-
-Defined in: [packages/utils/src/typingUtils.ts:18](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingUtils.ts#L18)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Deprecated
-
-Use `IsAny` from `@ls-stack/utils/typeUtils` instead
-
-***
-
-### ~~NonPartial\<T\>~~
-
-```ts
-type NonPartial<T> = { [K in keyof Required<T>]: T[K] };
-```
-
-Defined in: [packages/utils/src/typingUtils.ts:7](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingUtils.ts#L7)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Deprecated
-
-Use `NonPartial` from `@ls-stack/utils/typeUtils` instead
-
-***
-
-### ~~ObjKeysWithValuesOfType\<Obj, ValueType\>~~
-
-```ts
-type ObjKeysWithValuesOfType<Obj, ValueType> = { [K in keyof Obj]: Obj[K] extends ValueType ? K : never }[keyof Obj];
-```
-
-Defined in: [packages/utils/src/typingUtils.ts:10](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingUtils.ts#L10)
-
-#### Type Parameters
-
-##### Obj
-
-`Obj` *extends* `Record`\<`PropertyKey`, `unknown`\>
-
-##### ValueType
-
-`ValueType`
-
-#### Deprecated
-
-Use `ObjKeysWithValuesOfType` from `@ls-stack/utils/typeUtils` instead
-
-***
-
-### ~~PartialRecord\<K, T\>~~
-
-```ts
-type PartialRecord<K, T> = { [P in K]?: T };
-```
-
-Defined in: [packages/utils/src/typingUtils.ts:2](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingUtils.ts#L2)
-
-#### Type Parameters
-
-##### K
-
-`K` *extends* keyof `any`
-
-##### T
-
-`T`
-
-#### Deprecated
-
-Use `PartialRecord` from `@ls-stack/utils/typeUtils` instead
-
-***
-
-### ~~Prettify\<T\>~~
-
-```ts
-type Prettify<T> = { [P in keyof T]: T[P] } & object;
-```
-
-Defined in: [packages/utils/src/typingUtils.ts:26](https://github.com/lucasols/utils/blob/main/packages/utils/src/typingUtils.ts#L26)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-#### Deprecated
-
-Use `DeepPrettify` from `@ls-stack/utils/typeUtils` instead

package/docs/yamlStringify.md

@@ -1,83 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / yamlStringify
-
-# yamlStringify
-
-## Type Aliases
-
-### YamlStringifyOptions
-
-```ts
-type YamlStringifyOptions = object;
-```
-
-Defined in: [packages/utils/src/yamlStringify.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/yamlStringify.ts#L5)
-
-#### Properties
-
-##### addRootObjSpaces?
-
-```ts
-optional addRootObjSpaces: "before" | "after" | "beforeAndAfter" | false;
-```
-
-Defined in: [packages/utils/src/yamlStringify.ts:15](https://github.com/lucasols/utils/blob/main/packages/utils/src/yamlStringify.ts#L15)
-
-##### collapseObjects?
-
-```ts
-optional collapseObjects: boolean;
-```
-
-Defined in: [packages/utils/src/yamlStringify.ts:13](https://github.com/lucasols/utils/blob/main/packages/utils/src/yamlStringify.ts#L13)
-
-##### maxDepth?
-
-```ts
-optional maxDepth: number;
-```
-
-Defined in: [packages/utils/src/yamlStringify.ts:11](https://github.com/lucasols/utils/blob/main/packages/utils/src/yamlStringify.ts#L11)
-
-##### maxLineLength?
-
-```ts
-optional maxLineLength: number;
-```
-
-Defined in: [packages/utils/src/yamlStringify.ts:7](https://github.com/lucasols/utils/blob/main/packages/utils/src/yamlStringify.ts#L7)
-
-##### showUndefined?
-
-```ts
-optional showUndefined: boolean;
-```
-
-Defined in: [packages/utils/src/yamlStringify.ts:9](https://github.com/lucasols/utils/blob/main/packages/utils/src/yamlStringify.ts#L9)
-
-## Functions
-
-### yamlStringify()
-
-```ts
-function yamlStringify(obj, __namedParameters): string;
-```
-
-Defined in: [packages/utils/src/yamlStringify.ts:18](https://github.com/lucasols/utils/blob/main/packages/utils/src/yamlStringify.ts#L18)
-
-#### Parameters
-
-##### obj
-
-`unknown`
-
-##### \_\_namedParameters
-
-[`YamlStringifyOptions`](#yamlstringifyoptions) = `{}`
-
-#### Returns
-
-`string`