@ls-stack/utils 3.39.0 → 3.41.0

package/docs/typeGuards.md

@@ -1,399 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / typeGuards
-
-# typeGuards
-
-## Type Aliases
-
-### NonEmptyArray\<T\>
-
-```ts
-type NonEmptyArray<T> = [T, ...T[]];
-```
-
-Defined in: [packages/utils/src/typeGuards.ts:128](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeGuards.ts#L128)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-## Functions
-
-### arrayHasAtLeastXItems()
-
-#### Call Signature
-
-```ts
-function arrayHasAtLeastXItems<T>(array, minLength): array is [T, ...T[]];
-```
-
-Defined in: [packages/utils/src/typeGuards.ts:136](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeGuards.ts#L136)
-
-##### Type Parameters
-
-###### T
-
-`T`
-
-##### Parameters
-
-###### array
-
-`T`[]
-
-###### minLength
-
-`1`
-
-##### Returns
-
-`array is [T, ...T[]]`
-
-#### Call Signature
-
-```ts
-function arrayHasAtLeastXItems<T>(array, minLength): array is [T, T, ...T[]];
-```
-
-Defined in: [packages/utils/src/typeGuards.ts:140](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeGuards.ts#L140)
-
-##### Type Parameters
-
-###### T
-
-`T`
-
-##### Parameters
-
-###### array
-
-`T`[]
-
-###### minLength
-
-`2`
-
-##### Returns
-
-`array is [T, T, ...T[]]`
-
-#### Call Signature
-
-```ts
-function arrayHasAtLeastXItems<T>(array, minLength): array is [T, T, T, ...T[]];
-```
-
-Defined in: [packages/utils/src/typeGuards.ts:144](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeGuards.ts#L144)
-
-##### Type Parameters
-
-###### T
-
-`T`
-
-##### Parameters
-
-###### array
-
-`T`[]
-
-###### minLength
-
-`3`
-
-##### Returns
-
-`array is [T, T, T, ...T[]]`
-
-#### Call Signature
-
-```ts
-function arrayHasAtLeastXItems<T>(array, minLength): array is [T, T, T, T, ...T[]];
-```
-
-Defined in: [packages/utils/src/typeGuards.ts:148](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeGuards.ts#L148)
-
-##### Type Parameters
-
-###### T
-
-`T`
-
-##### Parameters
-
-###### array
-
-`T`[]
-
-###### minLength
-
-`4`
-
-##### Returns
-
-`array is [T, T, T, T, ...T[]]`
-
-#### Call Signature
-
-```ts
-function arrayHasAtLeastXItems<T>(array, minLength): array is [T, T, T, T, T, ...T[]];
-```
-
-Defined in: [packages/utils/src/typeGuards.ts:152](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeGuards.ts#L152)
-
-##### Type Parameters
-
-###### T
-
-`T`
-
-##### Parameters
-
-###### array
-
-`T`[]
-
-###### minLength
-
-`5`
-
-##### Returns
-
-`array is [T, T, T, T, T, ...T[]]`
-
-***
-
-### isFunction()
-
-```ts
-function isFunction(value): value is (args: any[]) => any;
-```
-
-Defined in: [packages/utils/src/typeGuards.ts:51](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeGuards.ts#L51)
-
-Type guard to check if a value is a function.
-
-Returns true if the value is a function of any kind (regular function,
-arrow function, method, constructor, etc.).
-
-#### Parameters
-
-##### value
-
-`unknown`
-
-The value to check
-
-#### Returns
-
-`value is (args: any[]) => any`
-
-True if the value is a function, false otherwise
-
-#### Example
-
-```typescript
-if (isFunction(value)) {
-  // TypeScript knows value is (...args: any[]) => any
-  const result = value();
-}
-
-isFunction(() => {});           // true
-isFunction(function() {});      // true
-isFunction(Math.max);           // true
-isFunction('string');           // false
-isFunction({});                 // false
-```
-
-***
-
-### isNonEmptyArray()
-
-```ts
-function isNonEmptyArray<T>(value): value is NonEmptyArray<T>;
-```
-
-Defined in: [packages/utils/src/typeGuards.ts:130](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeGuards.ts#L130)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### value
-
-`T`[] | readonly `T`[]
-
-#### Returns
-
-`value is NonEmptyArray<T>`
-
-***
-
-### isObject()
-
-```ts
-function isObject(value): value is Record<string, unknown>;
-```
-
-Defined in: [packages/utils/src/typeGuards.ts:24](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeGuards.ts#L24)
-
-Type guard to check if a value is a plain object (not null, not an array).
-
-Returns true if the value is an object that is not null and not an array.
-This is useful for distinguishing between objects and other types.
-
-#### Parameters
-
-##### value
-
-`unknown`
-
-The value to check
-
-#### Returns
-
-`value is Record<string, unknown>`
-
-True if the value is a plain object, false otherwise
-
-#### Example
-
-```typescript
-if (isObject(value)) {
-  // TypeScript knows value is Record<string, unknown>
-  console.log(value.someProperty);
-}
-
-isObject({});           // true
-isObject({ a: 1 });     // true
-isObject(null);         // false
-isObject([]);           // false
-isObject('string');     // false
-```
-
-***
-
-### isPlainObject()
-
-```ts
-function isPlainObject(value): value is Record<string, unknown>;
-```
-
-Defined in: [packages/utils/src/typeGuards.ts:109](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeGuards.ts#L109)
-
-Type guard to check if a value is a plain object (created by Object literal or Object constructor).
-
-Returns true if the value is a plain object - an object created by the Object
-constructor or object literal syntax. This excludes instances of classes,
-built-in objects like Date, RegExp, etc.
-
-#### Parameters
-
-##### value
-
-`any`
-
-The value to check
-
-#### Returns
-
-`value is Record<string, unknown>`
-
-True if the value is a plain object, false otherwise
-
-#### Example
-
-```typescript
-if (isPlainObject(value)) {
-  // TypeScript knows value is Record<string, unknown>
-  console.log(Object.keys(value));
-}
-
-isPlainObject({});                    // true
-isPlainObject({ a: 1 });              // true
-isPlainObject(Object.create(null));   // true
-isPlainObject(new Date());            // false
-isPlainObject(/regex/);               // false
-isPlainObject(new MyClass());         // false
-isPlainObject([]);                    // false
-```
-
-***
-
-### isPromise()
-
-```ts
-function isPromise(value): value is Promise<unknown>;
-```
-
-Defined in: [packages/utils/src/typeGuards.ts:79](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeGuards.ts#L79)
-
-Type guard to check if a value is a Promise or thenable object.
-
-Returns true if the value is an object with a `then` method that is a function.
-This covers both native Promises and thenable objects that implement the
-Promise interface.
-
-#### Parameters
-
-##### value
-
-`unknown`
-
-The value to check
-
-#### Returns
-
-`value is Promise<unknown>`
-
-True if the value is a Promise or thenable, false otherwise
-
-#### Example
-
-```typescript
-if (isPromise(value)) {
-  // TypeScript knows value is Promise<unknown>
-  const result = await value;
-}
-
-isPromise(Promise.resolve());           // true
-isPromise(new Promise(() => {}));       // true
-isPromise({ then: () => {} });          // true
-isPromise({ then: 'not a function' });  // false
-isPromise('string');                    // false
-```
-
-***
-
-### isTruthy()
-
-```ts
-function isTruthy<T>(value): value is Exclude<T, undefined | null | false | "" | 0 | 0n>;
-```
-
-Defined in: [packages/utils/src/typeGuards.ts:163](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeGuards.ts#L163)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### value
-
-`T`
-
-#### Returns
-
-value is Exclude\<T, undefined \| null \| false \| "" \| 0 \| 0n\>

package/docs/typeUtils/-internal-.md

@@ -1,99 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / [typeUtils](README.md) / \<internal\>
-
-# \<internal\>
-
-## Type Aliases
-
-### BuildArrayPath\<BasePath\>
-
-```ts
-type BuildArrayPath<BasePath> = BasePath extends "$" ? "[*]" : `${BasePath}[*]`;
-```
-
-Defined in: [packages/utils/src/typeUtils.ts:62](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L62)
-
-#### Type Parameters
-
-##### BasePath
-
-`BasePath` *extends* `string`
-
-***
-
-### BuildPath\<BasePath, Key\>
-
-```ts
-type BuildPath<BasePath, Key> = BasePath extends "$" ? Key extends string | number ? `${Key}` : never : Key extends string | number ? `${BasePath}.${Key}` : never;
-```
-
-Defined in: [packages/utils/src/typeUtils.ts:54](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L54)
-
-#### Type Parameters
-
-##### BasePath
-
-`BasePath` *extends* `string`
-
-##### Key
-
-`Key` *extends* `PropertyKey`
-
-***
-
-### DeepReplaceValueImpl\<T, ReplaceType, NewType, SkipPaths, SkipType, Path\>
-
-```ts
-type DeepReplaceValueImpl<T, ReplaceType, NewType, SkipPaths, SkipType, Path> = SkipPaths extends string ? PathMatches<Path, SkipPaths> extends true ? T : T extends ReplaceType ? T extends SkipType ? T : NewType : T extends readonly infer U[] ? DeepReplaceValueImpl<U, ReplaceType, NewType, SkipPaths, SkipType, BuildArrayPath<Path>>[] : T extends SkipType ? T : T extends Record<string, any> ? { [K in keyof T]: DeepReplaceValueImpl<T[K], ReplaceType, NewType, SkipPaths, SkipType, BuildPath<Path, K>> } : T : T extends ReplaceType ? T extends SkipType ? T : NewType : T extends readonly infer U[] ? DeepReplaceValueImpl<U, ReplaceType, NewType, SkipPaths, SkipType, BuildArrayPath<Path>>[] : T extends SkipType ? T : T extends Record<string, any> ? { [K in keyof T]: DeepReplaceValueImpl<T[K], ReplaceType, NewType, SkipPaths, SkipType, BuildPath<Path, K>> } : T;
-```
-
-Defined in: [packages/utils/src/typeUtils.ts:65](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L65)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-##### ReplaceType
-
-`ReplaceType`
-
-##### NewType
-
-`NewType`
-
-##### SkipPaths
-
-`SkipPaths` *extends* `string` \| `undefined`
-
-##### SkipType
-
-`SkipType`
-
-##### Path
-
-`Path` *extends* `string` = `"$"`
-
-***
-
-### PathMatches\<CurrentPath, SkipPaths\>
-
-```ts
-type PathMatches<CurrentPath, SkipPaths> = true extends SkipPaths extends any ? CurrentPath extends SkipPaths ? true : SkipPaths extends `${infer Prefix}[*]${infer Suffix}` ? CurrentPath extends `${Prefix}[${string}]${Suffix}` ? true : false : false : false ? true : false;
-```
-
-Defined in: [packages/utils/src/typeUtils.ts:40](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L40)
-
-#### Type Parameters
-
-##### CurrentPath
-
-`CurrentPath` *extends* `string`
-
-##### SkipPaths
-
-`SkipPaths` *extends* `string`

package/docs/typeUtils/README.md

@@ -1,195 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / typeUtils
-
-# typeUtils
-
-## Modules
-
-- [\<internal\>](-internal-.md)
-
-## 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/typeUtils.ts:25](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L25)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-***
-
-### DeepReplaceValue\<T, ReplaceType, NewType, SkipPaths, SkipTypes\>
-
-```ts
-type DeepReplaceValue<T, ReplaceType, NewType, SkipPaths, SkipTypes> = DeepReplaceValueImpl<T, ReplaceType, NewType, SkipPaths, SkipTypes>;
-```
-
-Defined in: [packages/utils/src/typeUtils.ts:141](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L141)
-
-Replaces all values that extends `ReplaceType` with `NewType` in a deeply nested object or array.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-The object or array to replace values in.
-
-##### ReplaceType
-
-`ReplaceType`
-
-The type to replace.
-
-##### NewType
-
-`NewType`
-
-The new type to replace with.
-
-##### SkipPaths
-
-`SkipPaths` *extends* `string` \| `undefined` = `undefined`
-
-The paths to skip in transverse. e.g. 'a.b.c' | 'array[*].b'
-
-##### SkipTypes
-
-`SkipTypes` = [`DefaultSkipTransverseDeepReplace`](#defaultskiptransversedeepreplace)
-
-The types to skip in transverse and replace.
-
-***
-
-### DefaultSkipTransverseDeepReplace
-
-```ts
-type DefaultSkipTransverseDeepReplace = 
-  | Date
-  | RegExp
-  | (...args) => any
-  | Error
-  | Set<any>
-  | Map<any, any>
-  | WeakSet<any>
-| WeakMap<any, any>;
-```
-
-Defined in: [packages/utils/src/typeUtils.ts:30](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L30)
-
-***
-
-### IsAny\<T\>
-
-```ts
-type IsAny<T> = unknown extends T ? [keyof T] extends [never] ? false : true : false;
-```
-
-Defined in: [packages/utils/src/typeUtils.ts:14](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L14)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-***
-
-### NonPartial\<T\>
-
-```ts
-type NonPartial<T> = { [K in keyof Required<T>]: T[K] };
-```
-
-Defined in: [packages/utils/src/typeUtils.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L5)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-***
-
-### 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/typeUtils.ts:7](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L7)
-
-#### Type Parameters
-
-##### Obj
-
-`Obj` *extends* `Record`\<`PropertyKey`, `unknown`\>
-
-##### ValueType
-
-`ValueType`
-
-***
-
-### PartialPossiblyUndefinedValues\<T\>
-
-```ts
-type PartialPossiblyUndefinedValues<T> = Prettify<Partial<Pick<T, KeysWithUndefinedValues<T>>> & Omit<T, KeysWithUndefinedValues<T>>>;
-```
-
-Defined in: [packages/utils/src/typeUtils.ts:156](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L156)
-
-Marks all possible undefined values as partial at the root level of the object.
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-***
-
-### PartialRecord\<K, T\>
-
-```ts
-type PartialRecord<K, T> = { [P in K]?: T };
-```
-
-Defined in: [packages/utils/src/typeUtils.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L1)
-
-#### Type Parameters
-
-##### K
-
-`K` *extends* keyof `any`
-
-##### T
-
-`T`
-
-***
-
-### Prettify\<T\>
-
-```ts
-type Prettify<T> = { [P in keyof T]: T[P] } & object;
-```
-
-Defined in: [packages/utils/src/typeUtils.ts:21](https://github.com/lucasols/utils/blob/main/packages/utils/src/typeUtils.ts#L21)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>

package/docs/typeUtils.typesTest.md

@@ -1,7 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / typeUtils.typesTest
-
-# typeUtils.typesTest