es-toolkit 1.17.0 → 1.18.0-dev.571

package/dist/compat/function/spread.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Creates a new function that spreads elements of an array argument into individual arguments
+ * for the original function. The array argument is positioned based on the `argsIndex` parameter.
+ *
+ * @template F - A function type with any number of parameters and any return type.
+ * @param {F} func - The function to be transformed. It can be any function with any number of arguments.
+ * @param {number} [argsIndex=0] - The index where the array argument is positioned among the other arguments.
+ *   If `argsIndex` is negative or `NaN`, it defaults to `0`. If it's a fractional number, it is rounded to the nearest integer.
+ * @returns {(...args: any[]) => ReturnType<F>} - A new function that takes multiple arguments, including an array of arguments at the specified `argsIndex`,
+ *   and returns the result of calling the original function with those arguments.
+ *
+ * @example
+ * function add(a, b) {
+ *   return a + b;
+ * }
+ *
+ * const spreadAdd = spread(add);
+ * console.log(spreadAdd([1, 2])); // Output: 3
+ *
+ * @example
+ * // Example function to spread arguments over
+ * function add(a, b) {
+ *   return a + b;
+ * }
+ *
+ * // Create a new function that uses `spread` to combine arguments
+ * const spreadAdd = spread(add, 1);
+ *
+ * // Calling `spreadAdd` with an array as the second argument
+ * console.log(spreadAdd(1, [2])); // Output: 3
+ *
+ * @example
+ * // Function with default arguments
+ * function greet(name, greeting = 'Hello') {
+ *   return `${greeting}, ${name}!`;
+ * }
+ *
+ * // Create a new function that uses `spread` to position the argument array at index 0
+ * const spreadGreet = spread(greet, 0);
+ *
+ * // Calling `spreadGreet` with an array of arguments
+ * console.log(spreadGreet(['Alice'])); // Output: Hello, Alice!
+ * console.log(spreadGreet(['Bob', 'Hi'])); // Output: Hi, Bob!
+ */
+declare function spread<F extends (...args: any[]) => any>(func: F, argsIndex?: number): (...args: any[]) => ReturnType<F>;
+
+export { spread };

package/dist/compat/function/spread.mjs

@@ -0,0 +1,16 @@
+function spread(func, argsIndex = 0) {
+    argsIndex = Number.parseInt(argsIndex, 10);
+    if (Number.isNaN(argsIndex) || argsIndex < 0) {
+        argsIndex = 0;
+    }
+    return function (...args) {
+        const array = args[argsIndex];
+        const params = args.slice(0, argsIndex);
+        if (array) {
+            params.push(...array);
+        }
+        return func.apply(this, params);
+    };
+}
+
+export { spread };

package/dist/compat/index.d.mts

@@ -8,24 +8,30 @@ 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 { flatMapDeep } from '../array/flatMapDeep.mjs';
 export { forEachRight } from '../array/forEachRight.mjs';
 export { groupBy } from '../array/groupBy.mjs';
+export { head as first, head } from '../array/head.mjs';
+export { initial } from '../array/initial.mjs';
 export { intersection } from '../array/intersection.mjs';
 export { intersectionBy } from '../array/intersectionBy.mjs';
 export { intersectionWith } from '../array/intersectionWith.mjs';
+export { isSubset } from '../array/isSubset.mjs';
 export { keyBy } from '../array/keyBy.mjs';
+export { last } from '../array/last.mjs';
 export { maxBy } from '../array/maxBy.mjs';
 export { minBy } from '../array/minBy.mjs';
 export { partition } from '../array/partition.mjs';
 export { pullAt } from '../array/pullAt.mjs';
-export { sortBy } from '../array/sortBy.mjs';
 export { sample } from '../array/sample.mjs';
 export { sampleSize } from '../array/sampleSize.mjs';
 export { shuffle } from '../array/shuffle.mjs';
+export { tail } from '../array/tail.mjs';
 export { take } from '../array/take.mjs';
 export { takeRight } from '../array/takeRight.mjs';
 export { takeRightWhile } from '../array/takeRightWhile.mjs';
 export { takeWhile } from '../array/takeWhile.mjs';
+export { toFilled } from '../array/toFilled.mjs';
 export { union } from '../array/union.mjs';
 export { unionBy } from '../array/unionBy.mjs';
 export { unionWith } from '../array/unionWith.mjs';
@@ -34,19 +40,13 @@ export { uniqBy } from '../array/uniqBy.mjs';
 export { uniqWith } from '../array/uniqWith.mjs';
 export { unzip } from '../array/unzip.mjs';
 export { unzipWith } from '../array/unzipWith.mjs';
+export { without } from '../array/without.mjs';
 export { xor } from '../array/xor.mjs';
 export { xorBy } from '../array/xorBy.mjs';
 export { xorWith } from '../array/xorWith.mjs';
 export { zip } from '../array/zip.mjs';
 export { zipObject } from '../array/zipObject.mjs';
 export { zipWith } from '../array/zipWith.mjs';
-export { without } from '../array/without.mjs';
-export { head as first, head } from '../array/head.mjs';
-export { isSubset } from '../array/isSubset.mjs';
-export { tail } from '../array/tail.mjs';
-export { toFilled } from '../array/toFilled.mjs';
-export { last } from '../array/last.mjs';
-export { initial } from '../array/initial.mjs';
 export { AbortError } from '../error/AbortError.mjs';
 export { TimeoutError } from '../error/TimeoutError.mjs';
 export { before } from '../function/before.mjs';
@@ -90,7 +90,6 @@ export { isPrimitive } from '../predicate/isPrimitive.mjs';
 export { delay } from '../promise/delay.mjs';
 export { withTimeout } from '../promise/withTimeout.mjs';
 export { timeout } from '../promise/timeout.mjs';
-export { camelCase } from '../string/camelCase.mjs';
 export { snakeCase } from '../string/snakeCase.mjs';
 export { kebabCase } from '../string/kebabCase.mjs';
 export { lowerCase } from '../string/lowerCase.mjs';
@@ -100,22 +99,35 @@ export { pascalCase } from '../string/pascalCase.mjs';
 export { upperFirst } from '../string/upperFirst.mjs';
 export { lowerFirst } from '../string/lowerFirst.mjs';
 export { deburr } from '../string/deburr.mjs';
+export { escape } from '../string/escape.mjs';
+export { escapeRegExp } from '../string/escapeRegExp.mjs';
+export { unescape } from '../string/unescape.mjs';
+export { pad } from '../string/pad.mjs';
+export { castArray } from './array/castArray.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 { find } from './array/find.mjs';
 export { findIndex } from './array/findIndex.mjs';
+export { findLastIndex } from './array/findLastIndex.mjs';
 export { flatten } from './array/flatten.mjs';
 export { flattenDeep } from './array/flattenDeep.mjs';
 export { flattenDepth } from './array/flattenDepth.mjs';
+export { indexOf } from './array/indexOf.mjs';
+export { join } from './array/join.mjs';
 export { orderBy } from './array/orderBy.mjs';
+export { sortBy } from './array/sortBy.mjs';
 export { size } from './array/size.mjs';
+export { some } from './array/some.mjs';
 export { zipObjectDeep } from './array/zipObjectDeep.mjs';
-export { indexOf } from './array/indexOf.mjs';
 export { ary } from './function/ary.mjs';
 export { bind } from './function/bind.mjs';
+export { bindKey } from './function/bindKey.mjs';
 export { rest } from './function/rest.mjs';
+export { spread } from './function/spread.mjs';
+export { attempt } from './function/attempt.mjs';
+export { rearg } from './function/rearg.mjs';
 export { get } from './object/get.mjs';
 export { set } from './object/set.mjs';
 export { has } from './object/has.mjs';
@@ -124,11 +136,13 @@ export { mapKeys } from './object/mapKeys.mjs';
 export { mapValues } from './object/mapValues.mjs';
 export { merge } from './object/merge.mjs';
 export { mergeWith } from './object/mergeWith.mjs';
+export { fromPairs } from './object/fromPairs.mjs';
 export { isPlainObject } from './predicate/isPlainObject.mjs';
 export { isArray } from './predicate/isArray.mjs';
 export { isArguments } from './predicate/isArguments.mjs';
 export { isArrayLike } from './predicate/isArrayLike.mjs';
 export { isSymbol } from './predicate/isSymbol.mjs';
+export { isObject } from './predicate/isObject.mjs';
 export { isObjectLike } from './predicate/isObjectLike.mjs';
 export { isBoolean } from './predicate/isBoolean.mjs';
 export { isTypedArray } from './predicate/isTypedArray.mjs';
@@ -137,9 +151,16 @@ export { isRegExp } from './predicate/isRegExp.mjs';
 export { isString } from './predicate/isString.mjs';
 export { matches } from './predicate/matches.mjs';
 export { matchesProperty } from './predicate/matchesProperty.mjs';
+export { isWeakMap } from './predicate/isWeakMap.mjs';
+export { isWeakSet } from './predicate/isWeakSet.mjs';
+export { conforms } from './predicate/conforms.mjs';
+export { conformsTo } from './predicate/conformsTo.mjs';
+export { camelCase } from './string/camelCase.mjs';
 export { startsWith } from './string/startsWith.mjs';
 export { endsWith } from './string/endsWith.mjs';
 export { padStart } from './string/padStart.mjs';
 export { padEnd } from './string/padEnd.mjs';
+export { repeat } from './string/repeat.mjs';
 export { max } from './math/max.mjs';
 export { min } from './math/min.mjs';
+export { parseInt } from './math/parseInt.mjs';

package/dist/compat/index.d.ts

@@ -8,24 +8,30 @@ 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 { flatMapDeep } from '../array/flatMapDeep.js';
 export { forEachRight } from '../array/forEachRight.js';
 export { groupBy } from '../array/groupBy.js';
+export { head as first, head } from '../array/head.js';
+export { initial } from '../array/initial.js';
 export { intersection } from '../array/intersection.js';
 export { intersectionBy } from '../array/intersectionBy.js';
 export { intersectionWith } from '../array/intersectionWith.js';
+export { isSubset } from '../array/isSubset.js';
 export { keyBy } from '../array/keyBy.js';
+export { last } from '../array/last.js';
 export { maxBy } from '../array/maxBy.js';
 export { minBy } from '../array/minBy.js';
 export { partition } from '../array/partition.js';
 export { pullAt } from '../array/pullAt.js';
-export { sortBy } from '../array/sortBy.js';
 export { sample } from '../array/sample.js';
 export { sampleSize } from '../array/sampleSize.js';
 export { shuffle } from '../array/shuffle.js';
+export { tail } from '../array/tail.js';
 export { take } from '../array/take.js';
 export { takeRight } from '../array/takeRight.js';
 export { takeRightWhile } from '../array/takeRightWhile.js';
 export { takeWhile } from '../array/takeWhile.js';
+export { toFilled } from '../array/toFilled.js';
 export { union } from '../array/union.js';
 export { unionBy } from '../array/unionBy.js';
 export { unionWith } from '../array/unionWith.js';
@@ -34,19 +40,13 @@ export { uniqBy } from '../array/uniqBy.js';
 export { uniqWith } from '../array/uniqWith.js';
 export { unzip } from '../array/unzip.js';
 export { unzipWith } from '../array/unzipWith.js';
+export { without } from '../array/without.js';
 export { xor } from '../array/xor.js';
 export { xorBy } from '../array/xorBy.js';
 export { xorWith } from '../array/xorWith.js';
 export { zip } from '../array/zip.js';
 export { zipObject } from '../array/zipObject.js';
 export { zipWith } from '../array/zipWith.js';
-export { without } from '../array/without.js';
-export { head as first, head } from '../array/head.js';
-export { isSubset } from '../array/isSubset.js';
-export { tail } from '../array/tail.js';
-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 { before } from '../function/before.js';
@@ -90,7 +90,6 @@ export { isPrimitive } from '../predicate/isPrimitive.js';
 export { delay } from '../promise/delay.js';
 export { withTimeout } from '../promise/withTimeout.js';
 export { timeout } from '../promise/timeout.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';
@@ -100,22 +99,35 @@ export { pascalCase } from '../string/pascalCase.js';
 export { upperFirst } from '../string/upperFirst.js';
 export { lowerFirst } from '../string/lowerFirst.js';
 export { deburr } from '../string/deburr.js';
+export { escape } from '../string/escape.js';
+export { escapeRegExp } from '../string/escapeRegExp.js';
+export { unescape } from '../string/unescape.js';
+export { pad } from '../string/pad.js';
+export { castArray } from './array/castArray.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 { find } from './array/find.js';
 export { findIndex } from './array/findIndex.js';
+export { findLastIndex } from './array/findLastIndex.js';
 export { flatten } from './array/flatten.js';
 export { flattenDeep } from './array/flattenDeep.js';
 export { flattenDepth } from './array/flattenDepth.js';
+export { indexOf } from './array/indexOf.js';
+export { join } from './array/join.js';
 export { orderBy } from './array/orderBy.js';
+export { sortBy } from './array/sortBy.js';
 export { size } from './array/size.js';
+export { some } from './array/some.js';
 export { zipObjectDeep } from './array/zipObjectDeep.js';
-export { indexOf } from './array/indexOf.js';
 export { ary } from './function/ary.js';
 export { bind } from './function/bind.js';
+export { bindKey } from './function/bindKey.js';
 export { rest } from './function/rest.js';
+export { spread } from './function/spread.js';
+export { attempt } from './function/attempt.js';
+export { rearg } from './function/rearg.js';
 export { get } from './object/get.js';
 export { set } from './object/set.js';
 export { has } from './object/has.js';
@@ -124,11 +136,13 @@ export { mapKeys } from './object/mapKeys.js';
 export { mapValues } from './object/mapValues.js';
 export { merge } from './object/merge.js';
 export { mergeWith } from './object/mergeWith.js';
+export { fromPairs } from './object/fromPairs.js';
 export { isPlainObject } from './predicate/isPlainObject.js';
 export { isArray } from './predicate/isArray.js';
 export { isArguments } from './predicate/isArguments.js';
 export { isArrayLike } from './predicate/isArrayLike.js';
 export { isSymbol } from './predicate/isSymbol.js';
+export { isObject } from './predicate/isObject.js';
 export { isObjectLike } from './predicate/isObjectLike.js';
 export { isBoolean } from './predicate/isBoolean.js';
 export { isTypedArray } from './predicate/isTypedArray.js';
@@ -137,9 +151,16 @@ export { isRegExp } from './predicate/isRegExp.js';
 export { isString } from './predicate/isString.js';
 export { matches } from './predicate/matches.js';
 export { matchesProperty } from './predicate/matchesProperty.js';
+export { isWeakMap } from './predicate/isWeakMap.js';
+export { isWeakSet } from './predicate/isWeakSet.js';
+export { conforms } from './predicate/conforms.js';
+export { conformsTo } from './predicate/conformsTo.js';
+export { camelCase } from './string/camelCase.js';
 export { startsWith } from './string/startsWith.js';
 export { endsWith } from './string/endsWith.js';
 export { padStart } from './string/padStart.js';
 export { padEnd } from './string/padEnd.js';
+export { repeat } from './string/repeat.js';
 export { max } from './math/max.js';
 export { min } from './math/min.js';
+export { parseInt } from './math/parseInt.js';