es-toolkit 1.13.1-dev.358 → 1.13.1-dev.360

package/dist/compat/array/flatten.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 object 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 flatten<T, D extends number = 1>(value: T[] | object, depth?: D): Array<FlatArray<T[], D>> | [];
+
+export { flatten };

package/dist/compat/array/flatten.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 object 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 flatten<T, D extends number = 1>(value: T[] | object, depth?: D): Array<FlatArray<T[], D>> | [];
+
+export { flatten };

package/dist/compat/array/flatten.mjs

@@ -0,0 +1,29 @@
+function flatten(value, depth = 1) {
+    const result = [];
+    const flooredDepth = Math.floor(depth);
+    if (!Array.isArray(value)) {
+        return result;
+    }
+    const recursive = (arr, currentDepth) => {
+        for (const item of arr) {
+            if (currentDepth < flooredDepth &&
+                (Array.isArray(item) ||
+                    Boolean(item?.[Symbol.isConcatSpreadable]) ||
+                    (item !== null && typeof item === 'object' && Object.prototype.toString.call(item) === '[object Arguments]'))) {
+                if (Array.isArray(item)) {
+                    recursive(item, currentDepth + 1);
+                }
+                else {
+                    recursive(Array.from(item), currentDepth + 1);
+                }
+            }
+            else {
+                result.push(item);
+            }
+        }
+    };
+    recursive(value, 0);
+    return result;
+}
+
+export { flatten };

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 { flatten } from '../array/flatten.mjs';
 export { flattenDeep } from '../array/flattenDeep.mjs';
 export { forEachRight } from '../array/forEachRight.mjs';
 export { groupBy } from '../array/groupBy.mjs';
@@ -93,10 +92,12 @@ export { kebabCase } from '../string/kebabCase.mjs';
 export { lowerCase } from '../string/lowerCase.mjs';
 export { startCase } from '../string/startCase.mjs';
 export { capitalize } from '../string/capitalize.mjs';
+export { padStart } from '../string/padStart.mjs';
 export { chunk } from './array/chunk.mjs';
 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 { 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 { flatten } from '../array/flatten.js';
 export { flattenDeep } from '../array/flattenDeep.js';
 export { forEachRight } from '../array/forEachRight.js';
 export { groupBy } from '../array/groupBy.js';
@@ -93,10 +92,12 @@ export { kebabCase } from '../string/kebabCase.js';
 export { lowerCase } from '../string/lowerCase.js';
 export { startCase } from '../string/startCase.js';
 export { capitalize } from '../string/capitalize.js';
+export { padStart } from '../string/padStart.js';
 export { chunk } from './array/chunk.js';
 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 { zipObjectDeep } from './array/zipObjectDeep.js';
 export { get } from './object/get.js';
 export { set } from './object/set.js';

package/dist/compat/index.js

@@ -43,6 +43,34 @@ function fill(array, value, start = 0, end = array.length) {
     return array_index.fill(array, value, start, end);
 }
 
+function flatten(value, depth = 1) {
+    const result = [];
+    const flooredDepth = Math.floor(depth);
+    if (!Array.isArray(value)) {
+        return result;
+    }
+    const recursive = (arr, currentDepth) => {
+        for (const item of arr) {
+            if (currentDepth < flooredDepth &&
+                (Array.isArray(item) ||
+                    Boolean(item?.[Symbol.isConcatSpreadable]) ||
+                    (item !== null && typeof item === 'object' && Object.prototype.toString.call(item) === '[object Arguments]'))) {
+                if (Array.isArray(item)) {
+                    recursive(item, currentDepth + 1);
+                }
+                else {
+                    recursive(Array.from(item), currentDepth + 1);
+                }
+            }
+            else {
+                result.push(item);
+            }
+        }
+    };
+    recursive(value, 0);
+    return result;
+}
+
 const IS_UNSIGNED_INTEGER = /^(?:0|[1-9]\d*)$/;
 function isIndex(value) {
     switch (typeof value) {
@@ -380,7 +408,6 @@ exports.dropRightWhile = array_index.dropRightWhile;
 exports.dropWhile = array_index.dropWhile;
 exports.first = array_index.head;
 exports.flatMap = array_index.flatMap;
-exports.flatten = array_index.flatten;
 exports.flattenDeep = array_index.flattenDeep;
 exports.forEachRight = array_index.forEachRight;
 exports.groupBy = array_index.groupBy;
@@ -464,6 +491,7 @@ exports.camelCase = string_index.camelCase;
 exports.capitalize = string_index.capitalize;
 exports.kebabCase = string_index.kebabCase;
 exports.lowerCase = string_index.lowerCase;
+exports.padStart = string_index.padStart;
 exports.snakeCase = string_index.snakeCase;
 exports.startCase = string_index.startCase;
 exports.chunk = chunk;
@@ -471,6 +499,7 @@ exports.concat = concat;
 exports.difference = difference;
 exports.endsWith = endsWith;
 exports.fill = fill;
+exports.flatten = flatten;
 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 { flatten } from '../array/flatten.mjs';
 export { flattenDeep } from '../array/flattenDeep.mjs';
 export { forEachRight } from '../array/forEachRight.mjs';
 export { groupBy } from '../array/groupBy.mjs';
@@ -93,10 +92,12 @@ export { kebabCase } from '../string/kebabCase.mjs';
 export { lowerCase } from '../string/lowerCase.mjs';
 export { startCase } from '../string/startCase.mjs';
 export { capitalize } from '../string/capitalize.mjs';
+export { padStart } from '../string/padStart.mjs';
 export { chunk } from './array/chunk.mjs';
 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 { zipObjectDeep } from './array/zipObjectDeep.mjs';
 export { get } from './object/get.mjs';
 export { set } from './object/set.mjs';

package/dist/index.d.mts

@@ -99,3 +99,4 @@ export { kebabCase } from './string/kebabCase.mjs';
 export { lowerCase } from './string/lowerCase.mjs';
 export { startCase } from './string/startCase.mjs';
 export { capitalize } from './string/capitalize.mjs';
+export { padStart } from './string/padStart.mjs';

package/dist/index.d.ts

@@ -99,3 +99,4 @@ export { kebabCase } from './string/kebabCase.js';
 export { lowerCase } from './string/lowerCase.js';
 export { startCase } from './string/startCase.js';
 export { capitalize } from './string/capitalize.js';
+export { padStart } from './string/padStart.js';

package/dist/index.js

@@ -114,5 +114,6 @@ exports.camelCase = string_index.camelCase;
 exports.capitalize = string_index.capitalize;
 exports.kebabCase = string_index.kebabCase;
 exports.lowerCase = string_index.lowerCase;
+exports.padStart = string_index.padStart;
 exports.snakeCase = string_index.snakeCase;
 exports.startCase = string_index.startCase;

package/dist/index.mjs

@@ -99,3 +99,4 @@ export { kebabCase } from './string/kebabCase.mjs';
 export { lowerCase } from './string/lowerCase.mjs';
 export { startCase } from './string/startCase.mjs';
 export { capitalize } from './string/capitalize.mjs';
+export { padStart } from './string/padStart.mjs';

package/dist/string/index.d.mts

@@ -4,3 +4,4 @@ export { kebabCase } from './kebabCase.mjs';
 export { lowerCase } from './lowerCase.mjs';
 export { startCase } from './startCase.mjs';
 export { capitalize } from './capitalize.mjs';
+export { padStart } from './padStart.mjs';

package/dist/string/index.d.ts

@@ -4,3 +4,4 @@ export { kebabCase } from './kebabCase.js';
 export { lowerCase } from './lowerCase.js';
 export { startCase } from './startCase.js';
 export { capitalize } from './capitalize.js';
+export { padStart } from './padStart.js';

package/dist/string/index.js

@@ -52,9 +52,17 @@ function startCase(str) {
     return result;
 }
 
+const padStart = (str, length = 0, chars = ' ') => {
+    if (Number.isSafeInteger(length) && length > str.length && chars.length > 0) {
+        return str.padStart(length, chars);
+    }
+    return str;
+};
+
 exports.camelCase = camelCase;
 exports.capitalize = capitalize;
 exports.kebabCase = kebabCase;
 exports.lowerCase = lowerCase;
+exports.padStart = padStart;
 exports.snakeCase = snakeCase;
 exports.startCase = startCase;

package/dist/string/index.mjs

@@ -4,3 +4,4 @@ export { kebabCase } from './kebabCase.mjs';
 export { lowerCase } from './lowerCase.mjs';
 export { startCase } from './startCase.mjs';
 export { capitalize } from './capitalize.mjs';
+export { padStart } from './padStart.mjs';

package/dist/string/padStart.d.mts

@@ -0,0 +1,20 @@
+/**
+ * Pads the start of a string with a given character until it reaches the specified length.
+ * If the length is less than or equal to the original string's length, or if the padding character is an empty string,
+ * the original string is returned unchanged.
+ *
+ * @template T - The type of the input string.
+ * @param {T} str - The string to pad.
+ * @param {number} [length=0] - The length of the resulting string once padded. Default is 0.
+ * @param {string} [chars=' '] - The character(s) to use for padding. Default is a single space.
+ * @returns {string} - The padded string, or the original string if padding is not required.
+ *
+ * @example
+ * const result1 = padStart('abc', 6);          // result will be '   abc'
+ * const result2 = padStart('abc', 6, '_-');    // result will be '_-_abc'
+ * const result3 = padStart('abc', 3);          // result will be 'abc'
+ * const result4 = padStart('abc', 2);          // result will be 'abc'
+ */
+declare const padStart: <T extends string>(str: T, length?: number, chars?: string) => string;
+
+export { padStart };

package/dist/string/padStart.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Pads the start of a string with a given character until it reaches the specified length.
+ * If the length is less than or equal to the original string's length, or if the padding character is an empty string,
+ * the original string is returned unchanged.
+ *
+ * @template T - The type of the input string.
+ * @param {T} str - The string to pad.
+ * @param {number} [length=0] - The length of the resulting string once padded. Default is 0.
+ * @param {string} [chars=' '] - The character(s) to use for padding. Default is a single space.
+ * @returns {string} - The padded string, or the original string if padding is not required.
+ *
+ * @example
+ * const result1 = padStart('abc', 6);          // result will be '   abc'
+ * const result2 = padStart('abc', 6, '_-');    // result will be '_-_abc'
+ * const result3 = padStart('abc', 3);          // result will be 'abc'
+ * const result4 = padStart('abc', 2);          // result will be 'abc'
+ */
+declare const padStart: <T extends string>(str: T, length?: number, chars?: string) => string;
+
+export { padStart };

package/dist/string/padStart.mjs

@@ -0,0 +1,8 @@
+const padStart = (str, length = 0, chars = ' ') => {
+    if (Number.isSafeInteger(length) && length > str.length && chars.length > 0) {
+        return str.padStart(length, chars);
+    }
+    return str;
+};
+
+export { padStart };

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.358+25217a57",
+  "version": "1.13.1-dev.360+8249ed25",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {