es-toolkit 1.46.1-dev.1798 → 1.46.1-dev.1800

package/dist/compat/_internal/mapToEntries.mjs

@@ -1,11 +1,10 @@
+//#region src/compat/_internal/mapToEntries.ts
 function mapToEntries(map) {
-    const arr = new Array(map.size);
-    const keys = map.keys();
-    const values = map.values();
-    for (let i = 0; i < arr.length; i++) {
-        arr[i] = [keys.next().value, values.next().value];
-    }
-    return arr;
+	const arr = new Array(map.size);
+	const keys = map.keys();
+	const values = map.values();
+	for (let i = 0; i < arr.length; i++) arr[i] = [keys.next().value, values.next().value];
+	return arr;
 }
-
+//#endregion
 export { mapToEntries };

package/dist/compat/_internal/normalizeForCase.js

@@ -1,14 +1,8 @@
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
-const toString = require('../util/toString.js');
-
+const require_toString = require("../util/toString.js");
+//#region src/compat/_internal/normalizeForCase.ts
 function normalizeForCase(str) {
-    if (typeof str !== 'string') {
-        str = toString.toString(str);
-    }
-    return str.replace(/['\u2019]/g, '');
+	if (typeof str !== "string") str = require_toString.toString(str);
+	return str.replace(/['\u2019]/g, "");
 }
-
+//#endregion
 exports.normalizeForCase = normalizeForCase;

package/dist/compat/_internal/normalizeForCase.mjs

@@ -1,10 +1,8 @@
-import { toString } from '../util/toString.mjs';
-
+import { toString } from "../util/toString.mjs";
+//#region src/compat/_internal/normalizeForCase.ts
 function normalizeForCase(str) {
-    if (typeof str !== 'string') {
-        str = toString(str);
-    }
-    return str.replace(/['\u2019]/g, '');
+	if (typeof str !== "string") str = toString(str);
+	return str.replace(/['\u2019]/g, "");
 }
-
+//#endregion
 export { normalizeForCase };

package/dist/compat/_internal/setToEntries.js

@@ -1,15 +1,12 @@
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
+//#region src/compat/_internal/setToEntries.ts
 function setToEntries(set) {
-    const arr = new Array(set.size);
-    const values = set.values();
-    for (let i = 0; i < arr.length; i++) {
-        const value = values.next().value;
-        arr[i] = [value, value];
-    }
-    return arr;
+	const arr = new Array(set.size);
+	const values = set.values();
+	for (let i = 0; i < arr.length; i++) {
+		const value = values.next().value;
+		arr[i] = [value, value];
+	}
+	return arr;
 }
-
+//#endregion
 exports.setToEntries = setToEntries;

package/dist/compat/_internal/setToEntries.mjs

@@ -1,11 +1,12 @@
+//#region src/compat/_internal/setToEntries.ts
 function setToEntries(set) {
-    const arr = new Array(set.size);
-    const values = set.values();
-    for (let i = 0; i < arr.length; i++) {
-        const value = values.next().value;
-        arr[i] = [value, value];
-    }
-    return arr;
+	const arr = new Array(set.size);
+	const values = set.values();
+	for (let i = 0; i < arr.length; i++) {
+		const value = values.next().value;
+		arr[i] = [value, value];
+	}
+	return arr;
 }
-
+//#endregion
 export { setToEntries };

package/dist/compat/_internal/tags.js

@@ -1,34 +1,31 @@
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
-const regexpTag = '[object RegExp]';
-const stringTag = '[object String]';
-const numberTag = '[object Number]';
-const booleanTag = '[object Boolean]';
-const argumentsTag = '[object Arguments]';
-const symbolTag = '[object Symbol]';
-const dateTag = '[object Date]';
-const mapTag = '[object Map]';
-const setTag = '[object Set]';
-const arrayTag = '[object Array]';
-const functionTag = '[object Function]';
-const arrayBufferTag = '[object ArrayBuffer]';
-const objectTag = '[object Object]';
-const errorTag = '[object Error]';
-const dataViewTag = '[object DataView]';
-const uint8ArrayTag = '[object Uint8Array]';
-const uint8ClampedArrayTag = '[object Uint8ClampedArray]';
-const uint16ArrayTag = '[object Uint16Array]';
-const uint32ArrayTag = '[object Uint32Array]';
-const bigUint64ArrayTag = '[object BigUint64Array]';
-const int8ArrayTag = '[object Int8Array]';
-const int16ArrayTag = '[object Int16Array]';
-const int32ArrayTag = '[object Int32Array]';
-const bigInt64ArrayTag = '[object BigInt64Array]';
-const float32ArrayTag = '[object Float32Array]';
-const float64ArrayTag = '[object Float64Array]';
-
+//#region src/compat/_internal/tags.ts
+const regexpTag = "[object RegExp]";
+const stringTag = "[object String]";
+const numberTag = "[object Number]";
+const booleanTag = "[object Boolean]";
+const argumentsTag = "[object Arguments]";
+const symbolTag = "[object Symbol]";
+const dateTag = "[object Date]";
+const mapTag = "[object Map]";
+const setTag = "[object Set]";
+const arrayTag = "[object Array]";
+const functionTag = "[object Function]";
+const arrayBufferTag = "[object ArrayBuffer]";
+const objectTag = "[object Object]";
+const errorTag = "[object Error]";
+const dataViewTag = "[object DataView]";
+const uint8ArrayTag = "[object Uint8Array]";
+const uint8ClampedArrayTag = "[object Uint8ClampedArray]";
+const uint16ArrayTag = "[object Uint16Array]";
+const uint32ArrayTag = "[object Uint32Array]";
+const bigUint64ArrayTag = "[object BigUint64Array]";
+const int8ArrayTag = "[object Int8Array]";
+const int16ArrayTag = "[object Int16Array]";
+const int32ArrayTag = "[object Int32Array]";
+const bigInt64ArrayTag = "[object BigInt64Array]";
+const float32ArrayTag = "[object Float32Array]";
+const float64ArrayTag = "[object Float64Array]";
+//#endregion
 exports.argumentsTag = argumentsTag;
 exports.arrayBufferTag = arrayBufferTag;
 exports.arrayTag = arrayTag;

package/dist/compat/_internal/tags.mjs

@@ -1,28 +1,29 @@
-const regexpTag = '[object RegExp]';
-const stringTag = '[object String]';
-const numberTag = '[object Number]';
-const booleanTag = '[object Boolean]';
-const argumentsTag = '[object Arguments]';
-const symbolTag = '[object Symbol]';
-const dateTag = '[object Date]';
-const mapTag = '[object Map]';
-const setTag = '[object Set]';
-const arrayTag = '[object Array]';
-const functionTag = '[object Function]';
-const arrayBufferTag = '[object ArrayBuffer]';
-const objectTag = '[object Object]';
-const errorTag = '[object Error]';
-const dataViewTag = '[object DataView]';
-const uint8ArrayTag = '[object Uint8Array]';
-const uint8ClampedArrayTag = '[object Uint8ClampedArray]';
-const uint16ArrayTag = '[object Uint16Array]';
-const uint32ArrayTag = '[object Uint32Array]';
-const bigUint64ArrayTag = '[object BigUint64Array]';
-const int8ArrayTag = '[object Int8Array]';
-const int16ArrayTag = '[object Int16Array]';
-const int32ArrayTag = '[object Int32Array]';
-const bigInt64ArrayTag = '[object BigInt64Array]';
-const float32ArrayTag = '[object Float32Array]';
-const float64ArrayTag = '[object Float64Array]';
-
+//#region src/compat/_internal/tags.ts
+const regexpTag = "[object RegExp]";
+const stringTag = "[object String]";
+const numberTag = "[object Number]";
+const booleanTag = "[object Boolean]";
+const argumentsTag = "[object Arguments]";
+const symbolTag = "[object Symbol]";
+const dateTag = "[object Date]";
+const mapTag = "[object Map]";
+const setTag = "[object Set]";
+const arrayTag = "[object Array]";
+const functionTag = "[object Function]";
+const arrayBufferTag = "[object ArrayBuffer]";
+const objectTag = "[object Object]";
+const errorTag = "[object Error]";
+const dataViewTag = "[object DataView]";
+const uint8ArrayTag = "[object Uint8Array]";
+const uint8ClampedArrayTag = "[object Uint8ClampedArray]";
+const uint16ArrayTag = "[object Uint16Array]";
+const uint32ArrayTag = "[object Uint32Array]";
+const bigUint64ArrayTag = "[object BigUint64Array]";
+const int8ArrayTag = "[object Int8Array]";
+const int16ArrayTag = "[object Int16Array]";
+const int32ArrayTag = "[object Int32Array]";
+const bigInt64ArrayTag = "[object BigInt64Array]";
+const float32ArrayTag = "[object Float32Array]";
+const float64ArrayTag = "[object Float64Array]";
+//#endregion
 export { argumentsTag, arrayBufferTag, arrayTag, bigInt64ArrayTag, bigUint64ArrayTag, booleanTag, dataViewTag, dateTag, errorTag, float32ArrayTag, float64ArrayTag, functionTag, int16ArrayTag, int32ArrayTag, int8ArrayTag, mapTag, numberTag, objectTag, regexpTag, setTag, stringTag, symbolTag, uint16ArrayTag, uint32ArrayTag, uint8ArrayTag, uint8ClampedArrayTag };

package/dist/compat/_internal/toArray.js

@@ -1,9 +1,6 @@
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
+//#region src/compat/_internal/toArray.ts
 function toArray(value) {
-    return Array.isArray(value) ? value : Array.from(value);
+	return Array.isArray(value) ? value : Array.from(value);
 }
-
+//#endregion
 exports.toArray = toArray;

package/dist/compat/_internal/toArray.mjs

@@ -1,5 +1,6 @@
+//#region src/compat/_internal/toArray.ts
 function toArray(value) {
-    return Array.isArray(value) ? value : Array.from(value);
+	return Array.isArray(value) ? value : Array.from(value);
 }
-
+//#endregion
 export { toArray };

package/dist/compat/_internal/toKey.js

@@ -1,15 +1,15 @@
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
+//#region src/compat/_internal/toKey.ts
+/**
+* Converts `value` to a string key if it's not a string or symbol.
+*
+* @private
+* @param {*} value The value to inspect.
+* @returns {string|symbol} Returns the key.
+*/
 function toKey(value) {
-    if (typeof value === 'string' || typeof value === 'symbol') {
-        return value;
-    }
-    if (Object.is(value?.valueOf?.(), -0)) {
-        return '-0';
-    }
-    return String(value);
+	if (typeof value === "string" || typeof value === "symbol") return value;
+	if (Object.is(value?.valueOf?.(), -0)) return "-0";
+	return String(value);
 }
-
+//#endregion
 exports.toKey = toKey;

package/dist/compat/_internal/toKey.mjs

@@ -1,11 +1,15 @@
+//#region src/compat/_internal/toKey.ts
+/**
+* Converts `value` to a string key if it's not a string or symbol.
+*
+* @private
+* @param {*} value The value to inspect.
+* @returns {string|symbol} Returns the key.
+*/
 function toKey(value) {
-    if (typeof value === 'string' || typeof value === 'symbol') {
-        return value;
-    }
-    if (Object.is(value?.valueOf?.(), -0)) {
-        return '-0';
-    }
-    return String(value);
+	if (typeof value === "string" || typeof value === "symbol") return value;
+	if (Object.is(value?.valueOf?.(), -0)) return "-0";
+	return String(value);
 }
-
+//#endregion
 export { toKey };

package/dist/compat/array/castArray.d.mts

@@ -1,3 +1,4 @@
+//#region src/compat/array/castArray.d.ts
 /**
  * Casts value as an array if it's not one.
  *
@@ -25,5 +26,5 @@
  * // Returns: []
  */
 declare function castArray<T>(value?: T | readonly T[]): T[];
-
-export { castArray };
+//#endregion
+export { castArray };

package/dist/compat/array/castArray.d.ts

@@ -1,3 +1,4 @@
+//#region src/compat/array/castArray.d.ts
 /**
  * Casts value as an array if it's not one.
  *
@@ -25,5 +26,5 @@
  * // Returns: []
  */
 declare function castArray<T>(value?: T | readonly T[]): T[];
-
-export { castArray };
+//#endregion
+export { castArray };

package/dist/compat/array/castArray.js

@@ -1,12 +1,33 @@
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
+//#region src/compat/array/castArray.ts
+/**
+* Casts value as an array if it's not one.
+*
+* @template T The type of elements in the array.
+* @param {T | T[]} value The value to be cast to an array.
+* @returns {T[]} An array containing the input value if it wasn't an array, or the original array if it was.
+*
+* @example
+* const arr1 = castArray(1);
+* // Returns: [1]
+*
+* const arr2 = castArray([1]);
+* // Returns: [1]
+*
+* const arr3 = castArray({'a': 1});
+* // Returns: [{'a': 1}]
+*
+* const arr4 = castArray(null);
+* // Returns: [null]
+*
+* const arr5 = castArray(undefined);
+* // Returns: [undefined]
+*
+* const arr6 = castArray();
+* // Returns: []
+*/
 function castArray(value) {
-    if (arguments.length === 0) {
-        return [];
-    }
-    return Array.isArray(value) ? value : [value];
+	if (arguments.length === 0) return [];
+	return Array.isArray(value) ? value : [value];
 }
-
+//#endregion
 exports.castArray = castArray;

package/dist/compat/array/castArray.mjs

@@ -1,8 +1,33 @@
+//#region src/compat/array/castArray.ts
+/**
+* Casts value as an array if it's not one.
+*
+* @template T The type of elements in the array.
+* @param {T | T[]} value The value to be cast to an array.
+* @returns {T[]} An array containing the input value if it wasn't an array, or the original array if it was.
+*
+* @example
+* const arr1 = castArray(1);
+* // Returns: [1]
+*
+* const arr2 = castArray([1]);
+* // Returns: [1]
+*
+* const arr3 = castArray({'a': 1});
+* // Returns: [{'a': 1}]
+*
+* const arr4 = castArray(null);
+* // Returns: [null]
+*
+* const arr5 = castArray(undefined);
+* // Returns: [undefined]
+*
+* const arr6 = castArray();
+* // Returns: []
+*/
 function castArray(value) {
-    if (arguments.length === 0) {
-        return [];
-    }
-    return Array.isArray(value) ? value : [value];
+	if (arguments.length === 0) return [];
+	return Array.isArray(value) ? value : [value];
 }
-
+//#endregion
 export { castArray };

package/dist/compat/array/chunk.d.mts

@@ -1,3 +1,4 @@
+//#region src/compat/array/chunk.d.ts
 /**
  * Splits an array into smaller arrays of a specified length.
  *
@@ -21,5 +22,5 @@
  * // Returns: [['a', 'b', 'c'], ['d', 'e', 'f'], ['g']]
  */
 declare function chunk<T>(arr: ArrayLike<T> | null | undefined, size?: number): T[][];
-
-export { chunk };
+//#endregion
+export { chunk };

package/dist/compat/array/chunk.d.ts

@@ -1,3 +1,4 @@
+//#region src/compat/array/chunk.d.ts
 /**
  * Splits an array into smaller arrays of a specified length.
  *
@@ -21,5 +22,5 @@
  * // Returns: [['a', 'b', 'c'], ['d', 'e', 'f'], ['g']]
  */
 declare function chunk<T>(arr: ArrayLike<T> | null | undefined, size?: number): T[][];
-
-export { chunk };
+//#endregion
+export { chunk };

package/dist/compat/array/chunk.js

@@ -1,17 +1,33 @@
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
-const chunk$1 = require('../../array/chunk.js');
-const toArray = require('../_internal/toArray.js');
-const isArrayLike = require('../predicate/isArrayLike.js');
-
+const require_chunk = require("../../array/chunk.js");
+const require_toArray = require("../_internal/toArray.js");
+const require_isArrayLike = require("../predicate/isArrayLike.js");
+//#region src/compat/array/chunk.ts
+/**
+* Splits an array into smaller arrays of a specified length.
+*
+* This function takes an input array and divides it into multiple smaller arrays,
+* each of a specified length. If the input array cannot be evenly divided,
+* the final sub-array will contain the remaining elements.
+*
+* @template T The type of elements in the array.
+* @param {ArrayLike<T> | null | undefined} arr - The array to be chunked into smaller arrays.
+* @param {number} size - The size of each smaller array. Must be a positive integer.
+* @returns {T[][]} A two-dimensional array where each sub-array has a maximum length of `size`.
+*
+* @example
+* // Splits an array of numbers into sub-arrays of length 2
+* chunk([1, 2, 3, 4, 5], 2);
+* // Returns: [[1, 2], [3, 4], [5]]
+*
+* @example
+* // Splits an array of strings into sub-arrays of length 3
+* chunk(['a', 'b', 'c', 'd', 'e', 'f', 'g'], 3);
+* // Returns: [['a', 'b', 'c'], ['d', 'e', 'f'], ['g']]
+*/
 function chunk(arr, size = 1) {
-    size = Math.max(Math.floor(size), 0);
-    if (size === 0 || !isArrayLike.isArrayLike(arr)) {
-        return [];
-    }
-    return chunk$1.chunk(toArray.toArray(arr), size);
+	size = Math.max(Math.floor(size), 0);
+	if (size === 0 || !require_isArrayLike.isArrayLike(arr)) return [];
+	return require_chunk.chunk(require_toArray.toArray(arr), size);
 }
-
+//#endregion
 exports.chunk = chunk;

package/dist/compat/array/chunk.mjs

@@ -1,13 +1,33 @@
-import { chunk as chunk$1 } from '../../array/chunk.mjs';
-import { toArray } from '../_internal/toArray.mjs';
-import { isArrayLike } from '../predicate/isArrayLike.mjs';
-
+import { chunk as chunk$1 } from "../../array/chunk.mjs";
+import { toArray } from "../_internal/toArray.mjs";
+import { isArrayLike } from "../predicate/isArrayLike.mjs";
+//#region src/compat/array/chunk.ts
+/**
+* Splits an array into smaller arrays of a specified length.
+*
+* This function takes an input array and divides it into multiple smaller arrays,
+* each of a specified length. If the input array cannot be evenly divided,
+* the final sub-array will contain the remaining elements.
+*
+* @template T The type of elements in the array.
+* @param {ArrayLike<T> | null | undefined} arr - The array to be chunked into smaller arrays.
+* @param {number} size - The size of each smaller array. Must be a positive integer.
+* @returns {T[][]} A two-dimensional array where each sub-array has a maximum length of `size`.
+*
+* @example
+* // Splits an array of numbers into sub-arrays of length 2
+* chunk([1, 2, 3, 4, 5], 2);
+* // Returns: [[1, 2], [3, 4], [5]]
+*
+* @example
+* // Splits an array of strings into sub-arrays of length 3
+* chunk(['a', 'b', 'c', 'd', 'e', 'f', 'g'], 3);
+* // Returns: [['a', 'b', 'c'], ['d', 'e', 'f'], ['g']]
+*/
 function chunk(arr, size = 1) {
-    size = Math.max(Math.floor(size), 0);
-    if (size === 0 || !isArrayLike(arr)) {
-        return [];
-    }
-    return chunk$1(toArray(arr), size);
+	size = Math.max(Math.floor(size), 0);
+	if (size === 0 || !isArrayLike(arr)) return [];
+	return chunk$1(toArray(arr), size);
 }
-
+//#endregion
 export { chunk };

package/dist/compat/array/compact.d.mts

@@ -1,3 +1,4 @@
+//#region src/compat/array/compact.d.ts
 type Falsey = false | null | 0 | 0n | '' | undefined;
 /**
  * Removes falsey values (false, null, 0, 0n, '', undefined, NaN) from an array.
@@ -11,5 +12,5 @@ type Falsey = false | null | 0 | 0n | '' | undefined;
  * Returns: [1, 2, 3, 4, 5]
  */
 declare function compact<T>(arr: ArrayLike<T | Falsey> | null | undefined): T[];
-
-export { compact };
+//#endregion
+export { compact };

package/dist/compat/array/compact.d.ts

@@ -1,3 +1,4 @@
+//#region src/compat/array/compact.d.ts
 type Falsey = false | null | 0 | 0n | '' | undefined;
 /**
  * Removes falsey values (false, null, 0, 0n, '', undefined, NaN) from an array.
@@ -11,5 +12,5 @@ type Falsey = false | null | 0 | 0n | '' | undefined;
  * Returns: [1, 2, 3, 4, 5]
  */
 declare function compact<T>(arr: ArrayLike<T | Falsey> | null | undefined): T[];
-
-export { compact };
+//#endregion
+export { compact };

package/dist/compat/array/compact.js

@@ -1,15 +1,20 @@
-'use strict';
-
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
-const compact$1 = require('../../array/compact.js');
-const isArrayLike = require('../predicate/isArrayLike.js');
-
+const require_compact = require("../../array/compact.js");
+const require_isArrayLike = require("../predicate/isArrayLike.js");
+//#region src/compat/array/compact.ts
+/**
+* Removes falsey values (false, null, 0, 0n, '', undefined, NaN) from an array.
+*
+* @template T - The type of elements in the array.
+* @param {ArrayLike<T | Falsey> | null | undefined} arr - The input array to remove falsey values.
+* @returns {Array<Exclude<T, false | null | 0 | 0n | '' | undefined>>} - A new array with all falsey values removed.
+*
+* @example
+* compact([0, 0n, 1, false, 2, '', 3, null, undefined, 4, NaN, 5]);
+* Returns: [1, 2, 3, 4, 5]
+*/
 function compact(arr) {
-    if (!isArrayLike.isArrayLike(arr)) {
-        return [];
-    }
-    return compact$1.compact(Array.from(arr));
+	if (!require_isArrayLike.isArrayLike(arr)) return [];
+	return require_compact.compact(Array.from(arr));
 }
-
+//#endregion
 exports.compact = compact;

package/dist/compat/array/compact.mjs

@@ -1,11 +1,20 @@
-import { compact as compact$1 } from '../../array/compact.mjs';
-import { isArrayLike } from '../predicate/isArrayLike.mjs';
-
+import { compact as compact$1 } from "../../array/compact.mjs";
+import { isArrayLike } from "../predicate/isArrayLike.mjs";
+//#region src/compat/array/compact.ts
+/**
+* Removes falsey values (false, null, 0, 0n, '', undefined, NaN) from an array.
+*
+* @template T - The type of elements in the array.
+* @param {ArrayLike<T | Falsey> | null | undefined} arr - The input array to remove falsey values.
+* @returns {Array<Exclude<T, false | null | 0 | 0n | '' | undefined>>} - A new array with all falsey values removed.
+*
+* @example
+* compact([0, 0n, 1, false, 2, '', 3, null, undefined, 4, NaN, 5]);
+* Returns: [1, 2, 3, 4, 5]
+*/
 function compact(arr) {
-    if (!isArrayLike(arr)) {
-        return [];
-    }
-    return compact$1(Array.from(arr));
+	if (!isArrayLike(arr)) return [];
+	return compact$1(Array.from(arr));
 }
-
+//#endregion
 export { compact };

package/dist/compat/array/concat.d.mts

@@ -1,3 +1,4 @@
+//#region src/compat/array/concat.d.ts
 /**
  * Concatenates multiple arrays and values into a single array.
  *
@@ -26,5 +27,5 @@
  * // returns [1, [2, 3], 4]
  */
 declare function concat<T>(...values: Array<T | readonly T[]>): T[];
-
-export { concat };
+//#endregion
+export { concat };