es-toolkit 1.13.1-dev.363 → 1.13.1-dev.365

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

@@ -0,0 +1,25 @@
+/**
+ * Utility type for recursively unpacking nested array types to extract the type of the innermost element
+ *
+ * @example
+ * ExtractNestedArrayType<(number | (number | number[])[])[]>
+ * // number
+ *
+ * ExtractNestedArrayType<(boolean | (string | number[])[])[]>
+ * // string | number | boolean
+ */
+type ExtractNestedArrayType<T> = T extends ReadonlyArray<infer U> ? ExtractNestedArrayType<U> : T;
+/**
+ * Flattens all depths of a nested array.
+ *
+ * @template T - The type of elements within the array.
+ * @param {T[] | object} value - The value to flatten.
+ * @returns {Array<ExtractNestedArrayType<T>> | []} A new array that has been flattened.
+ *
+ * @example
+ * const value = flattenDeep([1, [2, [3]], [4, [5, 6]]]);
+ * // Returns: [1, 2, 3, 4, 5, 6]
+ */
+declare function flattenDeep<T>(value: readonly T[] | object): Array<ExtractNestedArrayType<T>> | [];
+
+export { flattenDeep };

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

@@ -0,0 +1,25 @@
+/**
+ * Utility type for recursively unpacking nested array types to extract the type of the innermost element
+ *
+ * @example
+ * ExtractNestedArrayType<(number | (number | number[])[])[]>
+ * // number
+ *
+ * ExtractNestedArrayType<(boolean | (string | number[])[])[]>
+ * // string | number | boolean
+ */
+type ExtractNestedArrayType<T> = T extends ReadonlyArray<infer U> ? ExtractNestedArrayType<U> : T;
+/**
+ * Flattens all depths of a nested array.
+ *
+ * @template T - The type of elements within the array.
+ * @param {T[] | object} value - The value to flatten.
+ * @returns {Array<ExtractNestedArrayType<T>> | []} A new array that has been flattened.
+ *
+ * @example
+ * const value = flattenDeep([1, [2, [3]], [4, [5, 6]]]);
+ * // Returns: [1, 2, 3, 4, 5, 6]
+ */
+declare function flattenDeep<T>(value: readonly T[] | object): Array<ExtractNestedArrayType<T>> | [];
+
+export { flattenDeep };

package/dist/compat/array/flattenDeep.mjs

@@ -0,0 +1,7 @@
+import { flatten } from './flatten.mjs';
+
+function flattenDeep(value) {
+    return flatten(value, Infinity);
+}
+
+export { flattenDeep };

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

@@ -0,0 +1,19 @@
+/**
+ * Flattens an array up to the specified depth.
+ *
+ * @template T - The type of elements within the array.
+ * @template D - The depth to which the array should be flattened.
+ * @param {T[] | object} value - The value to flatten.
+ * @param {D} depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
+ * @returns {Array<FlatArray<T[], D>> | []} A new array that has been flattened.
+ *
+ * @example
+ * const arr = flatten([1, [2, 3], [4, [5, 6]]], 1);
+ * // Returns: [1, 2, 3, 4, [5, 6]]
+ *
+ * const arr = flatten([1, [2, 3], [4, [5, 6]]], 2);
+ * // Returns: [1, 2, 3, 4, 5, 6]
+ */
+declare function flattenDepth<T, D extends number = 1>(value: T[] | object, depth?: D): Array<FlatArray<T[], D>> | [];
+
+export { flattenDepth };

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

@@ -0,0 +1,19 @@
+/**
+ * Flattens an array up to the specified depth.
+ *
+ * @template T - The type of elements within the array.
+ * @template D - The depth to which the array should be flattened.
+ * @param {T[] | object} value - The value to flatten.
+ * @param {D} depth - The depth level specifying how deep a nested array structure should be flattened. Defaults to 1.
+ * @returns {Array<FlatArray<T[], D>> | []} A new array that has been flattened.
+ *
+ * @example
+ * const arr = flatten([1, [2, 3], [4, [5, 6]]], 1);
+ * // Returns: [1, 2, 3, 4, [5, 6]]
+ *
+ * const arr = flatten([1, [2, 3], [4, [5, 6]]], 2);
+ * // Returns: [1, 2, 3, 4, 5, 6]
+ */
+declare function flattenDepth<T, D extends number = 1>(value: T[] | object, depth?: D): Array<FlatArray<T[], D>> | [];
+
+export { flattenDepth };

package/dist/compat/array/flattenDepth.mjs

@@ -0,0 +1,7 @@
+import { flatten } from './flatten.mjs';
+
+function flattenDepth(value, depth = 1) {
+    return flatten(value, depth);
+}
+
+export { flattenDepth };

package/dist/compat/index.d.mts

@@ -7,7 +7,6 @@ export { dropRight } from '../array/dropRight.mjs';
 export { dropRightWhile } from '../array/dropRightWhile.mjs';
 export { dropWhile } from '../array/dropWhile.mjs';
 export { flatMap } from '../array/flatMap.mjs';
-export { flattenDeep } from '../array/flattenDeep.mjs';
 export { forEachRight } from '../array/forEachRight.mjs';
 export { groupBy } from '../array/groupBy.mjs';
 export { intersection } from '../array/intersection.mjs';
@@ -99,6 +98,8 @@ export { concat } from './array/concat.mjs';
 export { difference } from './array/difference.mjs';
 export { fill } from './array/fill.mjs';
 export { flatten } from './array/flatten.mjs';
+export { flattenDeep } from './array/flattenDeep.mjs';
+export { flattenDepth } from './array/flattenDepth.mjs';
 export { zipObjectDeep } from './array/zipObjectDeep.mjs';
 export { get } from './object/get.mjs';
 export { set } from './object/set.mjs';

package/dist/compat/index.d.ts

@@ -7,7 +7,6 @@ export { dropRight } from '../array/dropRight.js';
 export { dropRightWhile } from '../array/dropRightWhile.js';
 export { dropWhile } from '../array/dropWhile.js';
 export { flatMap } from '../array/flatMap.js';
-export { flattenDeep } from '../array/flattenDeep.js';
 export { forEachRight } from '../array/forEachRight.js';
 export { groupBy } from '../array/groupBy.js';
 export { intersection } from '../array/intersection.js';
@@ -99,6 +98,8 @@ export { concat } from './array/concat.js';
 export { difference } from './array/difference.js';
 export { fill } from './array/fill.js';
 export { flatten } from './array/flatten.js';
+export { flattenDeep } from './array/flattenDeep.js';
+export { flattenDepth } from './array/flattenDepth.js';
 export { zipObjectDeep } from './array/zipObjectDeep.js';
 export { get } from './object/get.js';
 export { set } from './object/set.js';

package/dist/compat/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const array_index = require('../array/index.js');
+const size = require('../_chunk/size-CJyNw8.js');
 const isNil = require('../_chunk/isNil-IuJ4cv.js');
 const promise_index = require('../_chunk/index-CwRt_M.js');
 const function_index = require('../function/index.js');
@@ -13,22 +13,22 @@ const predicate_index = require('../predicate/index.js');
 const isPrimitive = require('../_chunk/isPrimitive-BBs6Fb.js');
 const string_index = require('../string/index.js');
 
-function chunk(arr, size = 1) {
-    size = Math.max(Math.floor(size), 0);
-    if (size === 0) {
+function chunk(arr, size$1 = 1) {
+    size$1 = Math.max(Math.floor(size$1), 0);
+    if (size$1 === 0) {
         return [];
     }
-    return array_index.chunk(arr, size);
+    return size.chunk(arr, size$1);
 }
 
 function concat(...values) {
-    return array_index.flatten(values);
+    return size.flatten(values);
 }
 
 function difference(arr, ...values) {
     const arr1 = arr;
-    const arr2 = array_index.flatten(values);
-    return array_index.difference(arr1, arr2);
+    const arr2 = size.flatten(values);
+    return size.difference(arr1, arr2);
 }
 
 function fill(array, value, start = 0, end = array.length) {
@@ -40,7 +40,7 @@ function fill(array, value, start = 0, end = array.length) {
     if (!end) {
         end = 0;
     }
-    return array_index.fill(array, value, start, end);
+    return size.fill(array, value, start, end);
 }
 
 function flatten(value, depth = 1) {
@@ -71,6 +71,14 @@ function flatten(value, depth = 1) {
     return result;
 }
 
+function flattenDeep(value) {
+    return flatten(value, Infinity);
+}
+
+function flattenDepth(value, depth = 1) {
+    return flatten(value, depth);
+}
+
 const IS_UNSIGNED_INTEGER = /^(?:0|[1-9]\d*)$/;
 function isIndex(value) {
     switch (typeof value) {
@@ -147,7 +155,7 @@ function set(obj, path, value) {
 
 function zipObjectDeep(keys, values) {
     const result = {};
-    const zipped = array_index.zip(keys, values);
+    const zipped = size.zip(keys, values);
     for (let i = 0; i < zipped.length; i++) {
         const [key, value] = zipped[i];
         if (key != null) {
@@ -398,53 +406,52 @@ function min(items = []) {
     return minElement;
 }
 
-exports.compact = array_index.compact;
-exports.countBy = array_index.countBy;
-exports.differenceBy = array_index.differenceBy;
-exports.differenceWith = array_index.differenceWith;
-exports.drop = array_index.drop;
-exports.dropRight = array_index.dropRight;
-exports.dropRightWhile = array_index.dropRightWhile;
-exports.dropWhile = array_index.dropWhile;
-exports.first = array_index.head;
-exports.flatMap = array_index.flatMap;
-exports.flattenDeep = array_index.flattenDeep;
-exports.forEachRight = array_index.forEachRight;
-exports.groupBy = array_index.groupBy;
-exports.head = array_index.head;
-exports.initial = array_index.initial;
-exports.intersection = array_index.intersection;
-exports.intersectionBy = array_index.intersectionBy;
-exports.intersectionWith = array_index.intersectionWith;
-exports.keyBy = array_index.keyBy;
-exports.last = array_index.last;
-exports.maxBy = array_index.maxBy;
-exports.minBy = array_index.minBy;
-exports.orderBy = array_index.orderBy;
-exports.partition = array_index.partition;
-exports.sample = array_index.sample;
-exports.sampleSize = array_index.sampleSize;
-exports.shuffle = array_index.shuffle;
-exports.size = array_index.size;
-exports.tail = array_index.tail;
-exports.take = array_index.take;
-exports.takeRight = array_index.takeRight;
-exports.takeRightWhile = array_index.takeRightWhile;
-exports.takeWhile = array_index.takeWhile;
-exports.toFilled = array_index.toFilled;
-exports.unionBy = array_index.unionBy;
-exports.unionWith = array_index.unionWith;
-exports.uniqBy = array_index.uniqBy;
-exports.uniqWith = array_index.uniqWith;
-exports.unzip = array_index.unzip;
-exports.unzipWith = array_index.unzipWith;
-exports.without = array_index.without;
-exports.xor = array_index.xor;
-exports.xorBy = array_index.xorBy;
-exports.xorWith = array_index.xorWith;
-exports.zip = array_index.zip;
-exports.zipObject = array_index.zipObject;
-exports.zipWith = array_index.zipWith;
+exports.compact = size.compact;
+exports.countBy = size.countBy;
+exports.differenceBy = size.differenceBy;
+exports.differenceWith = size.differenceWith;
+exports.drop = size.drop;
+exports.dropRight = size.dropRight;
+exports.dropRightWhile = size.dropRightWhile;
+exports.dropWhile = size.dropWhile;
+exports.first = size.head;
+exports.flatMap = size.flatMap;
+exports.forEachRight = size.forEachRight;
+exports.groupBy = size.groupBy;
+exports.head = size.head;
+exports.initial = size.initial;
+exports.intersection = size.intersection;
+exports.intersectionBy = size.intersectionBy;
+exports.intersectionWith = size.intersectionWith;
+exports.keyBy = size.keyBy;
+exports.last = size.last;
+exports.maxBy = size.maxBy;
+exports.minBy = size.minBy;
+exports.orderBy = size.orderBy;
+exports.partition = size.partition;
+exports.sample = size.sample;
+exports.sampleSize = size.sampleSize;
+exports.shuffle = size.shuffle;
+exports.size = size.size;
+exports.tail = size.tail;
+exports.take = size.take;
+exports.takeRight = size.takeRight;
+exports.takeRightWhile = size.takeRightWhile;
+exports.takeWhile = size.takeWhile;
+exports.toFilled = size.toFilled;
+exports.unionBy = size.unionBy;
+exports.unionWith = size.unionWith;
+exports.uniqBy = size.uniqBy;
+exports.uniqWith = size.uniqWith;
+exports.unzip = size.unzip;
+exports.unzipWith = size.unzipWith;
+exports.without = size.without;
+exports.xor = size.xor;
+exports.xorBy = size.xorBy;
+exports.xorWith = size.xorWith;
+exports.zip = size.zip;
+exports.zipObject = size.zipObject;
+exports.zipWith = size.zipWith;
 exports.isNil = isNil.isNil;
 exports.union = isNil.union;
 exports.uniq = isNil.uniq;
@@ -501,6 +508,8 @@ exports.difference = difference;
 exports.endsWith = endsWith;
 exports.fill = fill;
 exports.flatten = flatten;
+exports.flattenDeep = flattenDeep;
+exports.flattenDepth = flattenDepth;
 exports.get = get;
 exports.isArray = isArray;
 exports.isMatch = isMatch;

package/dist/compat/index.mjs

@@ -7,7 +7,6 @@ export { dropRight } from '../array/dropRight.mjs';
 export { dropRightWhile } from '../array/dropRightWhile.mjs';
 export { dropWhile } from '../array/dropWhile.mjs';
 export { flatMap } from '../array/flatMap.mjs';
-export { flattenDeep } from '../array/flattenDeep.mjs';
 export { forEachRight } from '../array/forEachRight.mjs';
 export { groupBy } from '../array/groupBy.mjs';
 export { intersection } from '../array/intersection.mjs';
@@ -99,6 +98,8 @@ export { concat } from './array/concat.mjs';
 export { difference } from './array/difference.mjs';
 export { fill } from './array/fill.mjs';
 export { flatten } from './array/flatten.mjs';
+export { flattenDeep } from './array/flattenDeep.mjs';
+export { flattenDepth } from './array/flattenDepth.mjs';
 export { zipObjectDeep } from './array/zipObjectDeep.mjs';
 export { get } from './object/get.mjs';
 export { set } from './object/set.mjs';

package/dist/index.js

@@ -2,6 +2,7 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
+const size = require('./_chunk/size-CJyNw8.js');
 const array_index = require('./array/index.js');
 const isNil = require('./_chunk/isNil-IuJ4cv.js');
 const promise_index = require('./_chunk/index-CwRt_M.js');
@@ -15,56 +16,56 @@ const string_index = require('./string/index.js');
 
 
 
-exports.chunk = array_index.chunk;
-exports.compact = array_index.compact;
-exports.countBy = array_index.countBy;
-exports.difference = array_index.difference;
-exports.differenceBy = array_index.differenceBy;
-exports.differenceWith = array_index.differenceWith;
-exports.drop = array_index.drop;
-exports.dropRight = array_index.dropRight;
-exports.dropRightWhile = array_index.dropRightWhile;
-exports.dropWhile = array_index.dropWhile;
-exports.fill = array_index.fill;
-exports.flatMap = array_index.flatMap;
-exports.flatten = array_index.flatten;
+exports.chunk = size.chunk;
+exports.compact = size.compact;
+exports.countBy = size.countBy;
+exports.difference = size.difference;
+exports.differenceBy = size.differenceBy;
+exports.differenceWith = size.differenceWith;
+exports.drop = size.drop;
+exports.dropRight = size.dropRight;
+exports.dropRightWhile = size.dropRightWhile;
+exports.dropWhile = size.dropWhile;
+exports.fill = size.fill;
+exports.flatMap = size.flatMap;
+exports.flatten = size.flatten;
+exports.forEachRight = size.forEachRight;
+exports.groupBy = size.groupBy;
+exports.head = size.head;
+exports.initial = size.initial;
+exports.intersection = size.intersection;
+exports.intersectionBy = size.intersectionBy;
+exports.intersectionWith = size.intersectionWith;
+exports.keyBy = size.keyBy;
+exports.last = size.last;
+exports.maxBy = size.maxBy;
+exports.minBy = size.minBy;
+exports.orderBy = size.orderBy;
+exports.partition = size.partition;
+exports.sample = size.sample;
+exports.sampleSize = size.sampleSize;
+exports.shuffle = size.shuffle;
+exports.size = size.size;
+exports.tail = size.tail;
+exports.take = size.take;
+exports.takeRight = size.takeRight;
+exports.takeRightWhile = size.takeRightWhile;
+exports.takeWhile = size.takeWhile;
+exports.toFilled = size.toFilled;
+exports.unionBy = size.unionBy;
+exports.unionWith = size.unionWith;
+exports.uniqBy = size.uniqBy;
+exports.uniqWith = size.uniqWith;
+exports.unzip = size.unzip;
+exports.unzipWith = size.unzipWith;
+exports.without = size.without;
+exports.xor = size.xor;
+exports.xorBy = size.xorBy;
+exports.xorWith = size.xorWith;
+exports.zip = size.zip;
+exports.zipObject = size.zipObject;
+exports.zipWith = size.zipWith;
 exports.flattenDeep = array_index.flattenDeep;
-exports.forEachRight = array_index.forEachRight;
-exports.groupBy = array_index.groupBy;
-exports.head = array_index.head;
-exports.initial = array_index.initial;
-exports.intersection = array_index.intersection;
-exports.intersectionBy = array_index.intersectionBy;
-exports.intersectionWith = array_index.intersectionWith;
-exports.keyBy = array_index.keyBy;
-exports.last = array_index.last;
-exports.maxBy = array_index.maxBy;
-exports.minBy = array_index.minBy;
-exports.orderBy = array_index.orderBy;
-exports.partition = array_index.partition;
-exports.sample = array_index.sample;
-exports.sampleSize = array_index.sampleSize;
-exports.shuffle = array_index.shuffle;
-exports.size = array_index.size;
-exports.tail = array_index.tail;
-exports.take = array_index.take;
-exports.takeRight = array_index.takeRight;
-exports.takeRightWhile = array_index.takeRightWhile;
-exports.takeWhile = array_index.takeWhile;
-exports.toFilled = array_index.toFilled;
-exports.unionBy = array_index.unionBy;
-exports.unionWith = array_index.unionWith;
-exports.uniqBy = array_index.uniqBy;
-exports.uniqWith = array_index.uniqWith;
-exports.unzip = array_index.unzip;
-exports.unzipWith = array_index.unzipWith;
-exports.without = array_index.without;
-exports.xor = array_index.xor;
-exports.xorBy = array_index.xorBy;
-exports.xorWith = array_index.xorWith;
-exports.zip = array_index.zip;
-exports.zipObject = array_index.zipObject;
-exports.zipWith = array_index.zipWith;
 exports.isNil = isNil.isNil;
 exports.union = isNil.union;
 exports.uniq = isNil.uniq;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "es-toolkit",
   "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
-  "version": "1.13.1-dev.363+6356555f",
+  "version": "1.13.1-dev.365+f715a730",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {