es-toolkit 1.46.1 → 1.47.0

package/dist/compat/object/keys.js

@@ -1,40 +1,49 @@
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
-const isBuffer = require('../../predicate/isBuffer.js');
-const isPrototype = require('../_internal/isPrototype.js');
-const isArrayLike = require('../predicate/isArrayLike.js');
-const isTypedArray = require('../predicate/isTypedArray.js');
-const times = require('../util/times.js');
-
+const require_isBuffer = require("../../predicate/isBuffer.js");
+const require_isArrayLike = require("../predicate/isArrayLike.js");
+const require_isPrototype = require("../_internal/isPrototype.js");
+const require_isTypedArray = require("../predicate/isTypedArray.js");
+const require_times = require("../util/times.js");
+//#region src/compat/object/keys.ts
+/**
+* Creates an array of the own enumerable property names of `object`.
+*
+* Non-object values are coerced to objects.
+*
+* @param {object} object The object to query.
+* @returns {string[]} Returns the array of property names.
+* @example
+* function Foo() {
+*   this.a = 1;
+*   this.b = 2;
+* }
+* Foo.prototype.c = 3;
+* keys(new Foo); // ['a', 'b'] (iteration order is not guaranteed)
+*
+* keys('hi'); // ['0', '1']
+* keys([1, 2, 3]); // ['0', '1', '2']
+* keys({ a: 1, b: 2 }); // ['a', 'b']
+*/
 function keys(object) {
-    if (isArrayLike.isArrayLike(object)) {
-        return arrayLikeKeys(object);
-    }
-    const result = Object.keys(Object(object));
-    if (!isPrototype.isPrototype(object)) {
-        return result;
-    }
-    return result.filter(key => key !== 'constructor');
+	if (require_isArrayLike.isArrayLike(object)) return arrayLikeKeys(object);
+	const result = Object.keys(Object(object));
+	if (!require_isPrototype.isPrototype(object)) return result;
+	return result.filter((key) => key !== "constructor");
 }
 function arrayLikeKeys(object) {
-    const indices = times.times(object.length, index => `${index}`);
-    const filteredKeys = new Set(indices);
-    if (isBuffer.isBuffer(object)) {
-        filteredKeys.add('offset');
-        filteredKeys.add('parent');
-    }
-    if (isTypedArray.isTypedArray(object)) {
-        filteredKeys.add('buffer');
-        filteredKeys.add('byteLength');
-        filteredKeys.add('byteOffset');
-    }
-    const inheritedKeys = Object.keys(object).filter(key => !filteredKeys.has(key));
-    if (Array.isArray(object)) {
-        return [...indices, ...inheritedKeys];
-    }
-    return [...indices.filter(index => Object.hasOwn(object, index)), ...inheritedKeys];
+	const indices = require_times.times(object.length, (index) => `${index}`);
+	const filteredKeys = new Set(indices);
+	if (require_isBuffer.isBuffer(object)) {
+		filteredKeys.add("offset");
+		filteredKeys.add("parent");
+	}
+	if (require_isTypedArray.isTypedArray(object)) {
+		filteredKeys.add("buffer");
+		filteredKeys.add("byteLength");
+		filteredKeys.add("byteOffset");
+	}
+	const inheritedKeys = Object.keys(object).filter((key) => !filteredKeys.has(key));
+	if (Array.isArray(object)) return [...indices, ...inheritedKeys];
+	return [...indices.filter((index) => Object.hasOwn(object, index)), ...inheritedKeys];
 }
-
+//#endregion
 exports.keys = keys;

package/dist/compat/object/keys.mjs

@@ -1,36 +1,49 @@
-import { isBuffer } from '../../predicate/isBuffer.mjs';
-import { isPrototype } from '../_internal/isPrototype.mjs';
-import { isArrayLike } from '../predicate/isArrayLike.mjs';
-import { isTypedArray } from '../predicate/isTypedArray.mjs';
-import { times } from '../util/times.mjs';
-
+import { isBuffer } from "../../predicate/isBuffer.mjs";
+import { isArrayLike } from "../predicate/isArrayLike.mjs";
+import { isPrototype } from "../_internal/isPrototype.mjs";
+import { isTypedArray } from "../predicate/isTypedArray.mjs";
+import { times } from "../util/times.mjs";
+//#region src/compat/object/keys.ts
+/**
+* Creates an array of the own enumerable property names of `object`.
+*
+* Non-object values are coerced to objects.
+*
+* @param {object} object The object to query.
+* @returns {string[]} Returns the array of property names.
+* @example
+* function Foo() {
+*   this.a = 1;
+*   this.b = 2;
+* }
+* Foo.prototype.c = 3;
+* keys(new Foo); // ['a', 'b'] (iteration order is not guaranteed)
+*
+* keys('hi'); // ['0', '1']
+* keys([1, 2, 3]); // ['0', '1', '2']
+* keys({ a: 1, b: 2 }); // ['a', 'b']
+*/
 function keys(object) {
-    if (isArrayLike(object)) {
-        return arrayLikeKeys(object);
-    }
-    const result = Object.keys(Object(object));
-    if (!isPrototype(object)) {
-        return result;
-    }
-    return result.filter(key => key !== 'constructor');
+	if (isArrayLike(object)) return arrayLikeKeys(object);
+	const result = Object.keys(Object(object));
+	if (!isPrototype(object)) return result;
+	return result.filter((key) => key !== "constructor");
 }
 function arrayLikeKeys(object) {
-    const indices = times(object.length, index => `${index}`);
-    const filteredKeys = new Set(indices);
-    if (isBuffer(object)) {
-        filteredKeys.add('offset');
-        filteredKeys.add('parent');
-    }
-    if (isTypedArray(object)) {
-        filteredKeys.add('buffer');
-        filteredKeys.add('byteLength');
-        filteredKeys.add('byteOffset');
-    }
-    const inheritedKeys = Object.keys(object).filter(key => !filteredKeys.has(key));
-    if (Array.isArray(object)) {
-        return [...indices, ...inheritedKeys];
-    }
-    return [...indices.filter(index => Object.hasOwn(object, index)), ...inheritedKeys];
+	const indices = times(object.length, (index) => `${index}`);
+	const filteredKeys = new Set(indices);
+	if (isBuffer(object)) {
+		filteredKeys.add("offset");
+		filteredKeys.add("parent");
+	}
+	if (isTypedArray(object)) {
+		filteredKeys.add("buffer");
+		filteredKeys.add("byteLength");
+		filteredKeys.add("byteOffset");
+	}
+	const inheritedKeys = Object.keys(object).filter((key) => !filteredKeys.has(key));
+	if (Array.isArray(object)) return [...indices, ...inheritedKeys];
+	return [...indices.filter((index) => Object.hasOwn(object, index)), ...inheritedKeys];
 }
-
+//#endregion
 export { keys };

package/dist/compat/object/keysIn.d.mts

@@ -1,3 +1,4 @@
+//#region src/compat/object/keysIn.d.ts
 /**
  * This function retrieves the names of string-keyed properties from an object, including those inherited from its prototype.
  *
@@ -22,5 +23,5 @@
  * console.log(keysIn(new Foo())); // ['a']
  */
 declare function keysIn(object?: any): string[];
-
-export { keysIn };
+//#endregion
+export { keysIn };

package/dist/compat/object/keysIn.d.ts

@@ -1,3 +1,4 @@
+//#region src/compat/object/keysIn.d.ts
 /**
  * This function retrieves the names of string-keyed properties from an object, including those inherited from its prototype.
  *
@@ -22,5 +23,5 @@
  * console.log(keysIn(new Foo())); // ['a']
  */
 declare function keysIn(object?: any): string[];
-
-export { keysIn };
+//#endregion
+export { keysIn };

package/dist/compat/object/keysIn.js

@@ -1,61 +1,66 @@
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
-const isBuffer = require('../../predicate/isBuffer.js');
-const isPrototype = require('../_internal/isPrototype.js');
-const isArrayLike = require('../predicate/isArrayLike.js');
-const isTypedArray = require('../predicate/isTypedArray.js');
-const times = require('../util/times.js');
-
+const require_isBuffer = require("../../predicate/isBuffer.js");
+const require_isArrayLike = require("../predicate/isArrayLike.js");
+const require_isPrototype = require("../_internal/isPrototype.js");
+const require_isTypedArray = require("../predicate/isTypedArray.js");
+const require_times = require("../util/times.js");
+//#region src/compat/object/keysIn.ts
+/**
+* This function retrieves the names of string-keyed properties from an object, including those inherited from its prototype.
+*
+* - If the value is not an object, it is converted to an object.
+* - Array-like objects are treated like arrays.
+* - Sparse arrays with some missing indices are treated like dense arrays.
+* - If the value is `null` or `undefined`, an empty array is returned.
+* - When handling prototype objects, the `constructor` property is excluded from the results.
+*
+* @param {any} [object] - The object to inspect for keys.
+* @returns {string[]} An array of string keys from the object.
+*
+* @example
+* const obj = { a: 1, b: 2 };
+* console.log(keysIn(obj)); // ['a', 'b']
+*
+* const arr = [1, 2, 3];
+* console.log(keysIn(arr)); // ['0', '1', '2']
+*
+* function Foo() {}
+* Foo.prototype.a = 1;
+* console.log(keysIn(new Foo())); // ['a']
+*/
 function keysIn(object) {
-    if (object == null) {
-        return [];
-    }
-    switch (typeof object) {
-        case 'object':
-        case 'function': {
-            if (isArrayLike.isArrayLike(object)) {
-                return arrayLikeKeysIn(object);
-            }
-            if (isPrototype.isPrototype(object)) {
-                return prototypeKeysIn(object);
-            }
-            return keysInImpl(object);
-        }
-        default: {
-            return keysInImpl(Object(object));
-        }
-    }
+	if (object == null) return [];
+	switch (typeof object) {
+		case "object":
+		case "function":
+			if (require_isArrayLike.isArrayLike(object)) return arrayLikeKeysIn(object);
+			if (require_isPrototype.isPrototype(object)) return prototypeKeysIn(object);
+			return keysInImpl(object);
+		default: return keysInImpl(Object(object));
+	}
 }
 function keysInImpl(object) {
-    const result = [];
-    for (const key in object) {
-        result.push(key);
-    }
-    return result;
+	const result = [];
+	for (const key in object) result.push(key);
+	return result;
 }
 function prototypeKeysIn(object) {
-    const keys = keysInImpl(object);
-    return keys.filter(key => key !== 'constructor');
+	return keysInImpl(object).filter((key) => key !== "constructor");
 }
 function arrayLikeKeysIn(object) {
-    const indices = times.times(object.length, index => `${index}`);
-    const filteredKeys = new Set(indices);
-    if (isBuffer.isBuffer(object)) {
-        filteredKeys.add('offset');
-        filteredKeys.add('parent');
-    }
-    if (isTypedArray.isTypedArray(object)) {
-        filteredKeys.add('buffer');
-        filteredKeys.add('byteLength');
-        filteredKeys.add('byteOffset');
-    }
-    const inheritedKeys = keysInImpl(object).filter(key => !filteredKeys.has(key));
-    if (Array.isArray(object)) {
-        return [...indices, ...inheritedKeys];
-    }
-    return [...indices.filter(index => Object.hasOwn(object, index)), ...inheritedKeys];
+	const indices = require_times.times(object.length, (index) => `${index}`);
+	const filteredKeys = new Set(indices);
+	if (require_isBuffer.isBuffer(object)) {
+		filteredKeys.add("offset");
+		filteredKeys.add("parent");
+	}
+	if (require_isTypedArray.isTypedArray(object)) {
+		filteredKeys.add("buffer");
+		filteredKeys.add("byteLength");
+		filteredKeys.add("byteOffset");
+	}
+	const inheritedKeys = keysInImpl(object).filter((key) => !filteredKeys.has(key));
+	if (Array.isArray(object)) return [...indices, ...inheritedKeys];
+	return [...indices.filter((index) => Object.hasOwn(object, index)), ...inheritedKeys];
 }
-
+//#endregion
 exports.keysIn = keysIn;

package/dist/compat/object/keysIn.mjs

@@ -1,57 +1,66 @@
-import { isBuffer } from '../../predicate/isBuffer.mjs';
-import { isPrototype } from '../_internal/isPrototype.mjs';
-import { isArrayLike } from '../predicate/isArrayLike.mjs';
-import { isTypedArray } from '../predicate/isTypedArray.mjs';
-import { times } from '../util/times.mjs';
-
+import { isBuffer } from "../../predicate/isBuffer.mjs";
+import { isArrayLike } from "../predicate/isArrayLike.mjs";
+import { isPrototype } from "../_internal/isPrototype.mjs";
+import { isTypedArray } from "../predicate/isTypedArray.mjs";
+import { times } from "../util/times.mjs";
+//#region src/compat/object/keysIn.ts
+/**
+* This function retrieves the names of string-keyed properties from an object, including those inherited from its prototype.
+*
+* - If the value is not an object, it is converted to an object.
+* - Array-like objects are treated like arrays.
+* - Sparse arrays with some missing indices are treated like dense arrays.
+* - If the value is `null` or `undefined`, an empty array is returned.
+* - When handling prototype objects, the `constructor` property is excluded from the results.
+*
+* @param {any} [object] - The object to inspect for keys.
+* @returns {string[]} An array of string keys from the object.
+*
+* @example
+* const obj = { a: 1, b: 2 };
+* console.log(keysIn(obj)); // ['a', 'b']
+*
+* const arr = [1, 2, 3];
+* console.log(keysIn(arr)); // ['0', '1', '2']
+*
+* function Foo() {}
+* Foo.prototype.a = 1;
+* console.log(keysIn(new Foo())); // ['a']
+*/
 function keysIn(object) {
-    if (object == null) {
-        return [];
-    }
-    switch (typeof object) {
-        case 'object':
-        case 'function': {
-            if (isArrayLike(object)) {
-                return arrayLikeKeysIn(object);
-            }
-            if (isPrototype(object)) {
-                return prototypeKeysIn(object);
-            }
-            return keysInImpl(object);
-        }
-        default: {
-            return keysInImpl(Object(object));
-        }
-    }
+	if (object == null) return [];
+	switch (typeof object) {
+		case "object":
+		case "function":
+			if (isArrayLike(object)) return arrayLikeKeysIn(object);
+			if (isPrototype(object)) return prototypeKeysIn(object);
+			return keysInImpl(object);
+		default: return keysInImpl(Object(object));
+	}
 }
 function keysInImpl(object) {
-    const result = [];
-    for (const key in object) {
-        result.push(key);
-    }
-    return result;
+	const result = [];
+	for (const key in object) result.push(key);
+	return result;
 }
 function prototypeKeysIn(object) {
-    const keys = keysInImpl(object);
-    return keys.filter(key => key !== 'constructor');
+	return keysInImpl(object).filter((key) => key !== "constructor");
 }
 function arrayLikeKeysIn(object) {
-    const indices = times(object.length, index => `${index}`);
-    const filteredKeys = new Set(indices);
-    if (isBuffer(object)) {
-        filteredKeys.add('offset');
-        filteredKeys.add('parent');
-    }
-    if (isTypedArray(object)) {
-        filteredKeys.add('buffer');
-        filteredKeys.add('byteLength');
-        filteredKeys.add('byteOffset');
-    }
-    const inheritedKeys = keysInImpl(object).filter(key => !filteredKeys.has(key));
-    if (Array.isArray(object)) {
-        return [...indices, ...inheritedKeys];
-    }
-    return [...indices.filter(index => Object.hasOwn(object, index)), ...inheritedKeys];
+	const indices = times(object.length, (index) => `${index}`);
+	const filteredKeys = new Set(indices);
+	if (isBuffer(object)) {
+		filteredKeys.add("offset");
+		filteredKeys.add("parent");
+	}
+	if (isTypedArray(object)) {
+		filteredKeys.add("buffer");
+		filteredKeys.add("byteLength");
+		filteredKeys.add("byteOffset");
+	}
+	const inheritedKeys = keysInImpl(object).filter((key) => !filteredKeys.has(key));
+	if (Array.isArray(object)) return [...indices, ...inheritedKeys];
+	return [...indices.filter((index) => Object.hasOwn(object, index)), ...inheritedKeys];
 }
-
+//#endregion
 export { keysIn };

package/dist/compat/object/mapKeys.d.mts

@@ -1,6 +1,7 @@
-import { ListIteratee } from '../_internal/ListIteratee.mjs';
-import { ObjectIteratee } from '../_internal/ObjectIteratee.mjs';
+import { ListIteratee } from "../_internal/ListIteratee.mjs";
+import { ObjectIteratee } from "../_internal/ObjectIteratee.mjs";
 
+//#region src/compat/object/mapKeys.d.ts
 /**
  * Creates an object with the same values as `object` and keys generated by running each own enumerable string keyed property through `iteratee`.
  *
@@ -27,5 +28,5 @@ declare function mapKeys<T>(object: ArrayLike<T> | null | undefined, iteratee?:
  * // => { 'a1': 1, 'b2': 2 }
  */
 declare function mapKeys<T extends object>(object: T | null | undefined, iteratee?: ObjectIteratee<T>): Record<string, T[keyof T]>;
-
-export { mapKeys };
+//#endregion
+export { mapKeys };

package/dist/compat/object/mapKeys.d.ts

@@ -1,6 +1,7 @@
-import { ListIteratee } from '../_internal/ListIteratee.js';
-import { ObjectIteratee } from '../_internal/ObjectIteratee.js';
+import { ListIteratee } from "../_internal/ListIteratee.js";
+import { ObjectIteratee } from "../_internal/ObjectIteratee.js";
 
+//#region src/compat/object/mapKeys.d.ts
 /**
  * Creates an object with the same values as `object` and keys generated by running each own enumerable string keyed property through `iteratee`.
  *
@@ -27,5 +28,5 @@ declare function mapKeys<T>(object: ArrayLike<T> | null | undefined, iteratee?:
  * // => { 'a1': 1, 'b2': 2 }
  */
 declare function mapKeys<T extends object>(object: T | null | undefined, iteratee?: ObjectIteratee<T>): Record<string, T[keyof T]>;
-
-export { mapKeys };
+//#endregion
+export { mapKeys };

package/dist/compat/object/mapKeys.js

@@ -1,16 +1,28 @@
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
-const identity = require('../../function/identity.js');
-const mapKeys$1 = require('../../object/mapKeys.js');
-const iteratee = require('../util/iteratee.js');
-
-function mapKeys(object, getNewKey = identity.identity) {
-    if (object == null) {
-        return {};
-    }
-    return mapKeys$1.mapKeys(object, iteratee.iteratee(getNewKey));
+const require_identity = require("../../function/identity.js");
+const require_mapKeys = require("../../object/mapKeys.js");
+const require_iteratee = require("../util/iteratee.js");
+//#region src/compat/object/mapKeys.ts
+/**
+* Creates a new object with the same values as the given object, but with keys generated
+* by running each own enumerable property of the object through the iteratee function.
+*
+* @template T - The type of the object.
+* @template K1 - The type of the keys in the object.
+* @template K2 - The type of the new keys generated by the iteratee function.
+*
+* @param {T} object - The object to iterate over.
+* @param {(value: T[K1], key: K1, object: T) => K2} [getNewKey] - The function invoked per own enumerable property, or a path to generate new keys.
+* @returns {Record<K2, T[K1]>} - Returns the new mapped object.
+*
+* @example
+* // Example usage:
+* const obj = { a: 1, b: 2 };
+* const result = mapKeys(obj, (value, key) => key + value);
+* console.log(result); // { a1: 1, b2: 2 }
+*/
+function mapKeys(object, getNewKey = require_identity.identity) {
+	if (object == null) return {};
+	return require_mapKeys.mapKeys(object, require_iteratee.iteratee(getNewKey));
 }
-
+//#endregion
 exports.mapKeys = mapKeys;

package/dist/compat/object/mapKeys.mjs

@@ -1,12 +1,28 @@
-import { identity } from '../../function/identity.mjs';
-import { mapKeys as mapKeys$1 } from '../../object/mapKeys.mjs';
-import { iteratee } from '../util/iteratee.mjs';
-
+import { identity } from "../../function/identity.mjs";
+import { mapKeys as mapKeys$1 } from "../../object/mapKeys.mjs";
+import { iteratee } from "../util/iteratee.mjs";
+//#region src/compat/object/mapKeys.ts
+/**
+* Creates a new object with the same values as the given object, but with keys generated
+* by running each own enumerable property of the object through the iteratee function.
+*
+* @template T - The type of the object.
+* @template K1 - The type of the keys in the object.
+* @template K2 - The type of the new keys generated by the iteratee function.
+*
+* @param {T} object - The object to iterate over.
+* @param {(value: T[K1], key: K1, object: T) => K2} [getNewKey] - The function invoked per own enumerable property, or a path to generate new keys.
+* @returns {Record<K2, T[K1]>} - Returns the new mapped object.
+*
+* @example
+* // Example usage:
+* const obj = { a: 1, b: 2 };
+* const result = mapKeys(obj, (value, key) => key + value);
+* console.log(result); // { a1: 1, b2: 2 }
+*/
 function mapKeys(object, getNewKey = identity) {
-    if (object == null) {
-        return {};
-    }
-    return mapKeys$1(object, iteratee(getNewKey));
+	if (object == null) return {};
+	return mapKeys$1(object, iteratee(getNewKey));
 }
-
+//#endregion
 export { mapKeys };

package/dist/compat/object/mapValues.d.mts

@@ -1,7 +1,8 @@
-import { ArrayIterator } from '../_internal/ArrayIterator.mjs';
-import { ObjectIterator } from '../_internal/ObjectIterator.mjs';
-import { StringIterator } from '../_internal/StringIterator.mjs';
+import { ArrayIterator } from "../_internal/ArrayIterator.mjs";
+import { ObjectIterator } from "../_internal/ObjectIterator.mjs";
+import { StringIterator } from "../_internal/StringIterator.mjs";
 
+//#region src/compat/object/mapValues.d.ts
 /**
  * Creates a new object by mapping each character in a string to a value.
  * @param obj - The string to iterate over
@@ -31,9 +32,7 @@ declare function mapValues<T, U>(array: T[], callback: ArrayIterator<T, U>): Rec
  * mapValues({ a: 1, b: 2 }, (num) => num * 2)
  * // => { a: 2, b: 4 }
  */
-declare function mapValues<T extends object, U>(obj: T | null | undefined, callback: ObjectIterator<T, U>): {
-    [P in keyof T]: U;
-};
+declare function mapValues<T extends object, U>(obj: T | null | undefined, callback: ObjectIterator<T, U>): { [P in keyof T]: U };
 /**
  * Creates a new object by checking each value against a matcher object.
  * @param obj - The object to iterate over
@@ -53,9 +52,7 @@ declare function mapValues<T>(obj: Record<string, T> | Record<number, T> | null
  * mapValues({ a: { x: 1 }, b: { x: 2 } }, { x: 2 })
  * // => { a: false, b: true }
  */
-declare function mapValues<T extends object>(obj: T | null | undefined, iteratee: object): {
-    [P in keyof T]: boolean;
-};
+declare function mapValues<T extends object>(obj: T | null | undefined, iteratee: object): { [P in keyof T]: boolean };
 /**
  * Creates a new object by extracting a property from each value.
  * @param obj - The object to iterate over
@@ -85,9 +82,7 @@ declare function mapValues<T>(obj: Record<string, T> | Record<number, T> | null
  * mapValues({ a: { x: { y: 1 } }, b: { x: { y: 2 } } }, 'x.y')
  * // => { a: 1, b: 2 }
  */
-declare function mapValues<T extends object>(obj: T | null | undefined, iteratee: string): {
-    [P in keyof T]: any;
-};
+declare function mapValues<T extends object>(obj: T | null | undefined, iteratee: string): { [P in keyof T]: any };
 /**
  * Creates a new object from a string using identity function.
  * @param obj - The string to convert
@@ -126,5 +121,5 @@ declare function mapValues<T extends object>(obj: T): T;
  * // => {}
  */
 declare function mapValues<T extends object>(obj: T | null | undefined): Partial<T>;
-
-export { mapValues };
+//#endregion
+export { mapValues };