es-toolkit 1.10.1 → 1.11.0-dev.263

package/dist/compat/index.d.ts

@@ -8,6 +8,7 @@ export { dropRight } from '../array/dropRight.js';
 export { dropRightWhile } from '../array/dropRightWhile.js';
 export { dropWhile } from '../array/dropWhile.js';
 export { fill } from '../array/fill.js';
+export { flatMap } from '../array/flatMap.js';
 export { flatten } from '../array/flatten.js';
 export { flattenDeep } from '../array/flattenDeep.js';
 export { forEachRight } from '../array/forEachRight.js';
@@ -48,6 +49,7 @@ export { toFilled } from '../array/toFilled.js';
 export { last } from '../array/last.js';
 export { initial } from '../array/initial.js';
 export { AbortError } from '../error/AbortError.js';
+export { TimeoutError } from '../error/TimeoutError.js';
 export { debounce } from '../function/debounce.js';
 export { noop } from '../function/noop.js';
 export { once } from '../function/once.js';
@@ -75,10 +77,12 @@ export { isNotNil } from '../predicate/isNotNil.js';
 export { isNull } from '../predicate/isNull.js';
 export { isUndefined } from '../predicate/isUndefined.js';
 export { delay } from '../promise/delay.js';
+export { withTimeout } from '../promise/withTimeout.js';
 export { camelCase } from '../string/camelCase.js';
 export { snakeCase } from '../string/snakeCase.js';
 export { kebabCase } from '../string/kebabCase.js';
 export { lowerCase } from '../string/lowerCase.js';
+export { startCase } from '../string/startCase.js';
 export { capitalize } from '../string/capitalize.js';
 
 /**
@@ -106,4 +110,391 @@ export { capitalize } from '../string/capitalize.js';
  */
 declare function chunk<T>(arr: readonly T[], size?: number): T[][];
 
-export { chunk };
+/**
+ * Creates a deeply nested object given arrays of paths and values.
+ *
+ * This function takes two arrays: one containing arrays of property paths, and the other containing corresponding values.
+ * It returns a new object where paths from the first array are used as key paths to set values, with corresponding elements from the second array as values.
+ * Paths can be dot-separated strings or arrays of property names.
+ *
+ * If the `keys` array is longer than the `values` array, the remaining keys will have `undefined` as their values.
+ *
+ * @template V - The type of elements in the array.
+ * @param {string[] | string[][]} keys - An array of property paths, each path can be a dot-separated string or an array of property names.
+ * @param {V[]} values - An array of values corresponding to the property paths.
+ * @returns {object} A new object composed of the given property paths and values.
+ *
+ * @example
+ * const paths = ['a.b.c', 'd.e.f'];
+ * const values = [1, 2];
+ * const result = zipObjectDeep(paths, values);
+ * // result will be { a: { b: { c: 1 } }, d: { e: { f: 2 } } }
+ *
+ * @example
+ * const paths = [['a', 'b', 'c'], ['d', 'e', 'f']];
+ * const values = [1, 2];
+ * const result = zipObjectDeep(paths, values);
+ * // result will be { a: { b: { c: 1 } }, d: { e: { f: 2 } } }
+ *
+ * @example
+ * const paths = ['a.b[0].c', 'a.b[1].d'];
+ * const values = [1, 2];
+ * const result = zipObjectDeep(paths, values);
+ * // result will be { 'a': { 'b': [{ 'c': 1 }, { 'd': 2 }] } }
+ */
+declare function zipObjectDeep<P extends string | number | symbol, V>(keys: P[], values: V[]): {
+    [K in P]: V;
+};
+
+/**
+ * See the definition of `@types/lodash`.
+ */
+type GetIndexedField<T, K> = K extends keyof T ? T[K] : K extends `${number}` ? 'length' extends keyof T ? number extends T['length'] ? number extends keyof T ? T[number] : undefined : undefined : undefined : undefined;
+type FieldWithPossiblyUndefined<T, Key> = Get<Exclude<T, undefined>, Key> | Extract<T, undefined>;
+type IndexedFieldWithPossiblyUndefined<T, Key> = GetIndexedField<Exclude<T, undefined>, Key> | Extract<T, undefined>;
+type Get<T, P> = P extends `${infer Left}.${infer Right}` ? Left extends keyof Exclude<T, undefined> ? FieldWithPossiblyUndefined<Exclude<T, undefined>[Left], Right> | Extract<T, undefined> : Left extends `${infer FieldKey}[${infer IndexKey}]` ? FieldKey extends keyof T ? FieldWithPossiblyUndefined<IndexedFieldWithPossiblyUndefined<T[FieldKey], IndexKey>, Right> : undefined : undefined : P extends keyof T ? T[P] : P extends `${infer FieldKey}[${infer IndexKey}]` ? FieldKey extends keyof T ? IndexedFieldWithPossiblyUndefined<T[FieldKey], IndexKey> : undefined : IndexedFieldWithPossiblyUndefined<T, P>;
+
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K - The type of the key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T} object - The object to query.
+ * @param {K | [K]} path - The path of the property to get.
+ * @returns {T[K]} - Returns the resolved value.
+ */
+declare function get<T extends object, K extends keyof T>(object: T, path: K | [K]): T[K];
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K - The type of the key in the object.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {K | [K]} path - The path of the property to get.
+ * @returns {T[K] | undefined} - Returns the resolved value.
+ */
+declare function get<T extends object, K extends keyof T>(object: T | null | undefined, path: K | [K]): T[K] | undefined;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K - The type of the key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {K | [K]} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<T[K], undefined> | D} - Returns the resolved value.
+ */
+declare function get<T extends object, K extends keyof T, D>(object: T | null | undefined, path: K | [K], defaultValue: D): Exclude<T[K], undefined> | D;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ *
+ * @param {T} object - The object to query.
+ * @param {[K1, K2]} path - The path of the property to get.
+ * @returns {T[K1][K2]} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1]>(object: T, path: [K1, K2]): T[K1][K2];
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2]} path - The path of the property to get.
+ * @returns {T[K1][K2] | undefined} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1]>(object: T | null | undefined, path: [K1, K2]): T[K1][K2] | undefined;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2]} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<T[K1][K2], undefined> | D} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], D>(object: T | null | undefined, path: [K1, K2], defaultValue: D): Exclude<T[K1][K2], undefined> | D;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ *
+ * @param {T} object - The object to query.
+ * @param {[K1, K2, K3]} path - The path of the property to get.
+ * @returns {T[K1][K2][K3]} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2]>(object: T, path: [K1, K2, K3]): T[K1][K2][K3];
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2, K3]} path - The path of the property to get.
+ * @returns {T[K1][K2][K3] | undefined} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2]>(object: T | null | undefined, path: [K1, K2, K3]): T[K1][K2][K3] | undefined;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2, K3]} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<T[K1][K2][K3], undefined> | D} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2], D>(object: T | null | undefined, path: [K1, K2, K3], defaultValue: D): Exclude<T[K1][K2][K3], undefined> | D;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ * @template K4 - The type of the fourth key in the object.
+ *
+ * @param {T} object - The object to query.
+ * @param {[K1, K2, K3, K4]} path - The path of the property to get.
+ * @returns {T[K1][K2][K3][K4]} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2], K4 extends keyof T[K1][K2][K3]>(object: T, path: [K1, K2, K3, K4]): T[K1][K2][K3][K4];
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ * @template K4 - The type of the fourth key in the object.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2, K3, K4]} path - The path of the property to get.
+ * @returns {T[K1][K2][K3][K4] | undefined} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2], K4 extends keyof T[K1][K2][K3]>(object: T | null | undefined, path: [K1, K2, K3, K4]): T[K1][K2][K3][K4] | undefined;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ * @template K4 - The type of the fourth key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2, K3, K4]} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<T[K1][K2][K3][K4], undefined> | D} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2], K4 extends keyof T[K1][K2][K3], D>(object: T | null | undefined, path: [K1, K2, K3, K4], defaultValue: D): Exclude<T[K1][K2][K3][K4], undefined> | D;
+/**
+ * Retrieves the value at a given path from an object with numeric keys. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the value.
+ *
+ * @param {Record<number, T>} object - The object to query.
+ * @param {number} path - The path of the property to get.
+ * @returns {T} - Returns the resolved value.
+ */
+declare function get<T>(object: Record<number, T>, path: number): T;
+/**
+ * Retrieves the value at a given path from an object with numeric keys. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the value.
+ *
+ * @param {Record<number, T> | null | undefined} object - The object to query.
+ * @param {number} path - The path of the property to get.
+ * @returns {T | undefined} - Returns the resolved value.
+ */
+declare function get<T>(object: Record<number, T> | null | undefined, path: number): T | undefined;
+/**
+ * Retrieves the value at a given path from an object with numeric keys. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the value.
+ * @template D - The type of the default value.
+ *
+ * @param {Record<number, T> | null | undefined} object - The object to query.
+ * @param {number} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {T | D} - Returns the resolved value.
+ */
+declare function get<T, D>(object: Record<number, T> | null | undefined, path: number, defaultValue: D): T | D;
+/**
+ * Retrieves the value at a given path from a null or undefined object, returning the default value.
+ *
+ * @template D - The type of the default value.
+ *
+ * @param {null | undefined} object - The object to query.
+ * @param {PropertyKey} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {D} - Returns the default value.
+ */
+declare function get<D>(object: null | undefined, path: PropertyKey, defaultValue: D): D;
+/**
+ * Retrieves the value at a given path from a null or undefined object, returning undefined.
+ *
+ * @param {null | undefined} object - The object to query.
+ * @param {PropertyKey} path - The path of the property to get.
+ * @returns {undefined} - Returns undefined.
+ */
+declare function get(object: null | undefined, path: PropertyKey): undefined;
+/**
+ * Retrieves the value at a given path from a string-keyed object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template P - The type of the path.
+ *
+ * @param {T} data - The object to query.
+ * @param {P} path - The path of the property to get.
+ * @returns {string extends P ? any : Get<T, P>} - Returns the resolved value.
+ */
+declare function get<T, P extends string>(data: T, path: P): string extends P ? any : Get<T, P>;
+/**
+ * Retrieves the value at a given path from a string-keyed object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template P - The type of the path.
+ * @template D - The type of the default value.
+ *
+ * @param {T} data - The object to query.
+ * @param {P} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<Get<T, P>, null | undefined> | D} - Returns the resolved value.
+ */
+declare function get<T, P extends string, D = Get<T, P>>(data: T, path: P, defaultValue: D): Exclude<Get<T, P>, null | undefined> | D;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @param {unknown} object - The object to query.
+ * @param {PropertyKey | readonly PropertyKey[]} path - The path of the property to get.
+ * @param {unknown} [defaultValue] - The value returned if the resolved value is undefined.
+ * @returns {any} - Returns the resolved value.
+ */
+declare function get(object: unknown, path: PropertyKey | readonly PropertyKey[], defaultValue?: unknown): any;
+
+/**
+ * Sets the value at the specified path of the given object. If any part of the path does not exist, it will be created.
+ *
+ * @template T - The type of the object.
+ * @param {Settable} obj - The object to modify.
+ * @param {Path} path - The path of the property to set.
+ * @param {any} value - The value to set.
+ * @returns {T} - The modified object.
+ *
+ * @example
+ * // Set a value in a nested object
+ * const obj = { a: { b: { c: 3 } } };
+ * set(obj, 'a.b.c', 4);
+ * console.log(obj.a.b.c); // 4
+ *
+ * @example
+ * // Set a value in an array
+ * const arr = [1, 2, 3];
+ * set(arr, 1, 4);
+ * console.log(arr[1]); // 4
+ *
+ * @example
+ * // Create non-existent path and set value
+ * const obj = {};
+ * set(obj, 'a.b.c', 4);
+ * console.log(obj); // { a: { b: { c: 4 } } }
+ */
+declare function set<T>(obj: object, path: PropertyKey | readonly PropertyKey[], value: unknown): T;
+
+/**
+ * Checks if a string contains another string at the beginning of the string.
+ *
+ * Checks if one string startsWith another string. Optional position parameter to start searching from a certain index.
+ *
+ * @param {string} str - The string that might contain the target string.
+ * @param {string} target - The string to search for.
+ * @param {number} position - An optional offset to start searching in the str string
+ * @returns {boolean} - True if the str string starts with the target string.
+ *
+ * @example
+ * const isPrefix = startsWith('fooBar', 'foo') // returns true
+ * const isPrefix = startsWith('fooBar', 'bar') // returns false
+ * const isPrefix = startsWith('fooBar', 'abc') // returns false
+ * const isPrefix = startsWith('fooBar', 'Bar', 2) // returns true
+ * const isPrefix = startsWith('fooBar', 'Bar', 5) // returns false
+ */
+declare const startsWith: (str: string, target: string, position?: number) => boolean;
+
+/**
+ * Checks if a string contains another string at the end of the string.
+ *
+ * Checks if one string endsWith another string. Optional position parameter to offset searching before a certain index.
+ *
+ * @param {string} str - The string that might contain the target string.
+ * @param {string} target - The string to search for.
+ * @param {number} position - An optional position from the start to search up to this index
+ * @returns {boolean} - True if the str string ends with the target string.
+ *
+ * @example
+ * const isPrefix = endsWith('fooBar', 'foo') // returns true
+ * const isPrefix = endsWith('fooBar', 'bar') // returns false
+ * const isPrefix = endsWith('fooBar', 'abc') // returns false
+ * const isPrefix = endsWith('fooBar', 'foo', 3) // returns true
+ * const isPrefix = endsWith('fooBar', 'abc', 5) // returns false
+ */
+declare const endsWith: (str: string, target: string, position?: number) => boolean;
+
+/**
+ * Finds the element in an array that has the maximum value.
+ *
+ * @template T - The type of elements in the array.
+ * @param {T[]} items The array of elements to search.
+ * @returns {T} The element with the maximum value.
+ * @example
+ * // Returns 9
+ * max([3, 1, 4, 1, 5, 9])
+ *
+ * @example
+ * // Returns 8
+ * max([0, -3, 2, 8, 7])
+ */
+declare function max<T>(items?: readonly T[]): T;
+
+/**
+ * Finds the element in an array that has the minimum value.
+ *
+ * @template T - The type of elements in the array.
+ * @param {T[]} items The array of elements to search.
+ * @returns {T} The element with the minimum value.
+ * @example
+ * // Returns 1
+ * min([3, 1, 4, 1, 5, 9])
+ *
+ * @example
+ * // Returns -3
+ * min([0, -3, 2, 8, 7])
+ */
+declare function min<T>(items?: readonly T[]): T;
+
+export { chunk, endsWith, get, max, min, set, startsWith, zipObjectDeep };