es-toolkit 1.17.0 → 1.18.0-dev.573

package/dist/compat/predicate/isTypedArray.d.ts

@@ -13,6 +13,16 @@
  *   | BigInt64Array
  *   | Float32Array
  *   | Float64Array} Returns true if `x` is a TypedArray, false otherwise.
+ *
+ * @example
+ * const arr = new Uint8Array([1, 2, 3]);
+ * isTypedArray(arr); // true
+ *
+ * const regularArray = [1, 2, 3];
+ * isTypedArray(regularArray); // false
+ *
+ * const buffer = new ArrayBuffer(16);
+ * isTypedArray(buffer); // false
  */
 declare function isTypedArray(x?: unknown): x is Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | BigUint64Array | Int8Array | Int16Array | Int32Array | BigInt64Array | Float32Array | Float64Array;
 

package/dist/compat/predicate/isWeakMap.d.mts

@@ -0,0 +1,23 @@
+/**
+ * Checks if the given value is a `WeakMap`.
+ *
+ * This function tests whether the provided value is an instance of `WeakMap`.
+ * It returns `true` if the value is a `WeakMap`, and `false` otherwise.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `WeakMap`.
+ *
+ * @param {unknown} value - The value to test if it is a `WeakMap`.
+ * @returns {value is WeakMap<WeakKey, any>} true if the value is a `WeakMap`, false otherwise.
+ *
+ * @example
+ * const value1 = new WeakMap();
+ * const value2 = new Map();
+ * const value3 = new Set();
+ *
+ * console.log(isWeakMap(value1)); // true
+ * console.log(isWeakMap(value2)); // false
+ * console.log(isWeakMap(value3)); // false
+ */
+declare function isWeakMap(value?: unknown): value is WeakMap<WeakKey, any>;
+
+export { isWeakMap };

package/dist/compat/predicate/isWeakMap.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Checks if the given value is a `WeakMap`.
+ *
+ * This function tests whether the provided value is an instance of `WeakMap`.
+ * It returns `true` if the value is a `WeakMap`, and `false` otherwise.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `WeakMap`.
+ *
+ * @param {unknown} value - The value to test if it is a `WeakMap`.
+ * @returns {value is WeakMap<WeakKey, any>} true if the value is a `WeakMap`, false otherwise.
+ *
+ * @example
+ * const value1 = new WeakMap();
+ * const value2 = new Map();
+ * const value3 = new Set();
+ *
+ * console.log(isWeakMap(value1)); // true
+ * console.log(isWeakMap(value2)); // false
+ * console.log(isWeakMap(value3)); // false
+ */
+declare function isWeakMap(value?: unknown): value is WeakMap<WeakKey, any>;
+
+export { isWeakMap };

package/dist/compat/predicate/isWeakMap.mjs

@@ -0,0 +1,7 @@
+import { isWeakMap as isWeakMap$1 } from '../../predicate/isWeakMap.mjs';
+
+function isWeakMap(value) {
+    return isWeakMap$1(value);
+}
+
+export { isWeakMap };

package/dist/compat/predicate/isWeakSet.d.mts

@@ -0,0 +1,23 @@
+/**
+ * Checks if the given value is a `WeakSet`.
+ *
+ * This function tests whether the provided value is an instance of `WeakSet`.
+ * It returns `true` if the value is a `WeakSet`, and `false` otherwise.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `WeakSet`.
+ *
+ * @param {unknown} value - The value to test if it is a `WeakSet`.
+ * @returns {value is WeakSet<WeakKey>} true if the value is a `WeakSet`, false otherwise.
+ *
+ * @example
+ * const value1 = new WeakSet();
+ * const value2 = new Map();
+ * const value3 = new Set();
+ *
+ * console.log(isWeakSet(value1)); // true
+ * console.log(isWeakSet(value2)); // false
+ * console.log(isWeakSet(value3)); // false
+ */
+declare function isWeakSet(value?: unknown): value is WeakSet<WeakKey>;
+
+export { isWeakSet };

package/dist/compat/predicate/isWeakSet.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Checks if the given value is a `WeakSet`.
+ *
+ * This function tests whether the provided value is an instance of `WeakSet`.
+ * It returns `true` if the value is a `WeakSet`, and `false` otherwise.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `WeakSet`.
+ *
+ * @param {unknown} value - The value to test if it is a `WeakSet`.
+ * @returns {value is WeakSet<WeakKey>} true if the value is a `WeakSet`, false otherwise.
+ *
+ * @example
+ * const value1 = new WeakSet();
+ * const value2 = new Map();
+ * const value3 = new Set();
+ *
+ * console.log(isWeakSet(value1)); // true
+ * console.log(isWeakSet(value2)); // false
+ * console.log(isWeakSet(value3)); // false
+ */
+declare function isWeakSet(value?: unknown): value is WeakSet<WeakKey>;
+
+export { isWeakSet };

package/dist/compat/predicate/isWeakSet.mjs

@@ -0,0 +1,7 @@
+import { isWeakSet as isWeakSet$1 } from '../../predicate/isWeakSet.mjs';
+
+function isWeakSet(value) {
+    return isWeakSet$1(value);
+}
+
+export { isWeakSet };

package/dist/compat/string/camelCase.d.mts

@@ -0,0 +1,18 @@
+/**
+ * Converts a string to camel case.
+ *
+ * Camel case is the naming convention in which the first word is written in lowercase and
+ * each subsequent word begins with a capital letter, concatenated without any separator characters.
+ *
+ * @param {string | object} str - The string that is to be changed to camel case.
+ * @returns {string} - The converted string to camel case.
+ *
+ * @example
+ * const convertedStr1 = camelCase('camelCase') // returns 'camelCase'
+ * const convertedStr2 = camelCase('some whitespace') // returns 'someWhitespace'
+ * const convertedStr3 = camelCase('hyphen-text') // returns 'hyphenText'
+ * const convertedStr4 = camelCase('HTTPRequest') // returns 'httpRequest'
+ */
+declare function camelCase(str: string | object): string;
+
+export { camelCase };

package/dist/compat/string/camelCase.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Converts a string to camel case.
+ *
+ * Camel case is the naming convention in which the first word is written in lowercase and
+ * each subsequent word begins with a capital letter, concatenated without any separator characters.
+ *
+ * @param {string | object} str - The string that is to be changed to camel case.
+ * @returns {string} - The converted string to camel case.
+ *
+ * @example
+ * const convertedStr1 = camelCase('camelCase') // returns 'camelCase'
+ * const convertedStr2 = camelCase('some whitespace') // returns 'someWhitespace'
+ * const convertedStr3 = camelCase('hyphen-text') // returns 'hyphenText'
+ * const convertedStr4 = camelCase('HTTPRequest') // returns 'httpRequest'
+ */
+declare function camelCase(str: string | object): string;
+
+export { camelCase };

package/dist/compat/string/camelCase.mjs

@@ -0,0 +1,8 @@
+import { camelCase as camelCase$1 } from '../../string/camelCase.mjs';
+import { normalizeForCase } from '../_internal/normalizeForCase.mjs';
+
+function camelCase(str) {
+    return camelCase$1(normalizeForCase(str));
+}
+
+export { camelCase };

package/dist/compat/string/endsWith.d.mts

@@ -15,6 +15,6 @@
  * const isPrefix = endsWith('fooBar', 'foo', 3) // returns true
  * const isPrefix = endsWith('fooBar', 'abc', 5) // returns false
  */
-declare const endsWith: (str: string, target: string, position?: number) => boolean;
+declare function endsWith(str: string, target: string, position?: number): boolean;
 
 export { endsWith };

package/dist/compat/string/endsWith.d.ts

@@ -15,6 +15,6 @@
  * const isPrefix = endsWith('fooBar', 'foo', 3) // returns true
  * const isPrefix = endsWith('fooBar', 'abc', 5) // returns false
  */
-declare const endsWith: (str: string, target: string, position?: number) => boolean;
+declare function endsWith(str: string, target: string, position?: number): boolean;
 
 export { endsWith };

package/dist/compat/string/endsWith.mjs

@@ -1,5 +1,5 @@
-const endsWith = (str, target, position = str.length) => {
+function endsWith(str, target, position = str.length) {
     return str.endsWith(target, position);
-};
+}
 
 export { endsWith };

package/dist/compat/string/repeat.d.mts

@@ -0,0 +1,17 @@
+/**
+ * Repeats the given string n times.
+ *
+ * If n is less than 1, an empty string is returned, or if the string is an empty string,
+ * the original string is returned unchanged.
+ *
+ * @param {string} str - The string to repeat.
+ * @param {number} n - The number of times to repeat the string.
+ * @returns {string} - The repeated string, or an empty string if n is less than 1.
+ *
+ * @example
+ * repeat('abc', 0); // ''
+ * repeat('abc', 2); // 'abcabc'
+ */
+declare function repeat(str: string, n: number): string;
+
+export { repeat };

package/dist/compat/string/repeat.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Repeats the given string n times.
+ *
+ * If n is less than 1, an empty string is returned, or if the string is an empty string,
+ * the original string is returned unchanged.
+ *
+ * @param {string} str - The string to repeat.
+ * @param {number} n - The number of times to repeat the string.
+ * @returns {string} - The repeated string, or an empty string if n is less than 1.
+ *
+ * @example
+ * repeat('abc', 0); // ''
+ * repeat('abc', 2); // 'abcabc'
+ */
+declare function repeat(str: string, n: number): string;
+
+export { repeat };

package/dist/compat/string/repeat.mjs

@@ -0,0 +1,5 @@
+function repeat(str, n) {
+    return str.repeat(n);
+}
+
+export { repeat };

package/dist/compat/string/startsWith.d.mts

@@ -15,6 +15,6 @@
  * const isPrefix = startsWith('fooBar', 'Bar', 2) // returns true
  * const isPrefix = startsWith('fooBar', 'Bar', 5) // returns false
  */
-declare const startsWith: (str: string, target: string, position?: number) => boolean;
+declare function startsWith(str: string, target: string, position?: number): boolean;
 
 export { startsWith };

package/dist/compat/string/startsWith.d.ts

@@ -15,6 +15,6 @@
  * const isPrefix = startsWith('fooBar', 'Bar', 2) // returns true
  * const isPrefix = startsWith('fooBar', 'Bar', 5) // returns false
  */
-declare const startsWith: (str: string, target: string, position?: number) => boolean;
+declare function startsWith(str: string, target: string, position?: number): boolean;
 
 export { startsWith };

package/dist/compat/string/startsWith.mjs

@@ -1,5 +1,5 @@
-const startsWith = (str, target, position = 0) => {
+function startsWith(str, target, position = 0) {
     return str.startsWith(target, position);
-};
+}
 
 export { startsWith };

package/dist/function/after.d.mts

@@ -26,6 +26,6 @@
  * // Will log 'called'.
  * afterFn()
  */
-declare const after: <F extends (...args: any[]) => any>(n: number, func: F) => F;
+declare function after<F extends (...args: any[]) => any>(n: number, func: F): F;
 
 export { after };

package/dist/function/after.d.ts

@@ -26,6 +26,6 @@
  * // Will log 'called'.
  * afterFn()
  */
-declare const after: <F extends (...args: any[]) => any>(n: number, func: F) => F;
+declare function after<F extends (...args: any[]) => any>(n: number, func: F): F;
 
 export { after };

package/dist/function/after.mjs

@@ -1,4 +1,4 @@
-const after = (n, func) => {
+function after(n, func) {
     if (!Number.isInteger(n) || n < 0) {
         throw new Error(`n must be a non-negative integer.`);
     }
@@ -9,6 +9,6 @@ const after = (n, func) => {
         }
         return undefined;
     });
-};
+}
 
 export { after };

package/dist/function/before.d.mts

@@ -26,6 +26,6 @@
  * // Will not log anything.
  * beforeFn();
  */
-declare const before: <F extends (...args: any[]) => any>(n: number, func: F) => F;
+declare function before<F extends (...args: any[]) => any>(n: number, func: F): F;
 
 export { before };

package/dist/function/before.d.ts

@@ -26,6 +26,6 @@
  * // Will not log anything.
  * beforeFn();
  */
-declare const before: <F extends (...args: any[]) => any>(n: number, func: F) => F;
+declare function before<F extends (...args: any[]) => any>(n: number, func: F): F;
 
 export { before };

package/dist/function/before.mjs

@@ -1,4 +1,4 @@
-const before = (n, func) => {
+function before(n, func) {
     if (!Number.isInteger(n) || n < 0) {
         throw new Error('n must be a non-negative integer.');
     }
@@ -9,6 +9,6 @@ const before = (n, func) => {
         }
         return undefined;
     });
-};
+}
 
 export { before };

package/dist/function/debounce.d.mts

@@ -9,9 +9,9 @@ interface DebounceOptions {
  * @template F - The type of function.
  * @param {F} func - The function to debounce.
  * @param {number} debounceMs - The number of milliseconds to delay.
- * @param {DebounceOptions} options - The options object.
+ * @param {DebounceOptions} options - The options object
  * @param {AbortSignal} options.signal - An optional AbortSignal to cancel the debounced function.
- * @returns {F & { cancel: () => void }} A new debounced function with a `cancel` method.
+ * @returns A new debounced function with a `cancel` method.
  *
  * @example
  * const debouncedFunction = debounce(() => {
@@ -36,7 +36,7 @@ interface DebounceOptions {
  * // Will cancel the debounced function call
  * controller.abort();
  */
-declare function debounce<F extends (...args: any[]) => void>(func: F, debounceMs: number, { signal }?: DebounceOptions): F & {
+declare function debounce<F extends (...args: any[]) => void>(func: F, debounceMs: number, { signal }?: DebounceOptions): ((...args: Parameters<F>) => void) & {
     cancel: () => void;
 };
 

package/dist/function/debounce.d.ts

@@ -9,9 +9,9 @@ interface DebounceOptions {
  * @template F - The type of function.
  * @param {F} func - The function to debounce.
  * @param {number} debounceMs - The number of milliseconds to delay.
- * @param {DebounceOptions} options - The options object.
+ * @param {DebounceOptions} options - The options object
  * @param {AbortSignal} options.signal - An optional AbortSignal to cancel the debounced function.
- * @returns {F & { cancel: () => void }} A new debounced function with a `cancel` method.
+ * @returns A new debounced function with a `cancel` method.
  *
  * @example
  * const debouncedFunction = debounce(() => {
@@ -36,7 +36,7 @@ interface DebounceOptions {
  * // Will cancel the debounced function call
  * controller.abort();
  */
-declare function debounce<F extends (...args: any[]) => void>(func: F, debounceMs: number, { signal }?: DebounceOptions): F & {
+declare function debounce<F extends (...args: any[]) => void>(func: F, debounceMs: number, { signal }?: DebounceOptions): ((...args: Parameters<F>) => void) & {
     cancel: () => void;
 };
 

package/dist/function/index.d.mts

@@ -11,3 +11,4 @@ export { unary } from './unary.mjs';
 export { partial } from './partial.mjs';
 export { partialRight } from './partialRight.mjs';
 export { rest } from './rest.mjs';
+export { spread } from './spread.mjs';

package/dist/function/index.d.ts

@@ -11,3 +11,4 @@ export { unary } from './unary.js';
 export { partial } from './partial.js';
 export { partialRight } from './partialRight.js';
 export { rest } from './rest.js';
+export { spread } from './spread.js';

package/dist/function/index.js

@@ -2,183 +2,25 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const before = (n, func) => {
-    if (!Number.isInteger(n) || n < 0) {
-        throw new Error('n must be a non-negative integer.');
-    }
-    let counter = 0;
-    return ((...args) => {
-        if (++counter < n) {
-            return func(...args);
-        }
-        return undefined;
-    });
-};
-
-const after = (n, func) => {
-    if (!Number.isInteger(n) || n < 0) {
-        throw new Error(`n must be a non-negative integer.`);
-    }
-    let counter = 0;
-    return ((...args) => {
-        if (++counter >= n) {
-            return func(...args);
-        }
-        return undefined;
-    });
-};
-
-function debounce(func, debounceMs, { signal } = {}) {
-    let timeoutId = null;
-    const debounced = function (...args) {
-        if (timeoutId !== null) {
-            clearTimeout(timeoutId);
-        }
-        if (signal?.aborted) {
-            return;
-        }
-        timeoutId = setTimeout(() => {
-            func(...args);
-            timeoutId = null;
-        }, debounceMs);
-    };
-    const onAbort = function () {
-        debounced.cancel();
-    };
-    debounced.cancel = function () {
-        if (timeoutId !== null) {
-            clearTimeout(timeoutId);
-            timeoutId = null;
-        }
-    };
-    signal?.addEventListener('abort', onAbort, { once: true });
-    return debounced;
-}
-
-function noop() { }
-
-function once(func) {
-    let called = false;
-    let cache;
-    return function () {
-        if (called) {
-            return cache;
-        }
-        const result = func();
-        called = true;
-        cache = result;
-        return result;
-    };
-}
-
-function throttle(func, throttleMs) {
-    let lastCallTime;
-    const throttledFunction = function (...args) {
-        const now = Date.now();
-        if (lastCallTime == null || now - lastCallTime >= throttleMs) {
-            lastCallTime = now;
-            func(...args);
-        }
-    };
-    return throttledFunction;
-}
-
-function negate(func) {
-    return ((...args) => !func(...args));
-}
-
-function memoize(fn, options = {}) {
-    const { cache = new Map(), getCacheKey } = options;
-    const memoizedFn = function (arg) {
-        const key = getCacheKey ? getCacheKey(arg) : arg;
-        if (cache.has(key)) {
-            return cache.get(key);
-        }
-        const result = fn.call(this, arg);
-        cache.set(key, result);
-        return result;
-    };
-    memoizedFn.cache = cache;
-    return memoizedFn;
-}
-
-function ary(func, n) {
-    return function (...args) {
-        return func.apply(this, args.slice(0, n));
-    };
-}
-
-function unary(func) {
-    return ary(func, 1);
-}
-
-function partial(func, ...partialArgs) {
-    return function (...providedArgs) {
-        const args = [];
-        let startIndex = 0;
-        for (let i = 0; i < partialArgs.length; i++) {
-            const arg = partialArgs[i];
-            if (arg === partial.placeholder) {
-                args.push(providedArgs[startIndex++]);
-            }
-            else {
-                args.push(arg);
-            }
-        }
-        for (let i = startIndex; i < providedArgs.length; i++) {
-            args.push(providedArgs[i]);
-        }
-        return func.apply(this, args);
-    };
-}
-const partialPlaceholder = Symbol('partial.placeholder');
-partial.placeholder = partialPlaceholder;
-
-function partialRight(func, ...partialArgs) {
-    return function (...providedArgs) {
-        const placeholderLength = partialArgs.filter(arg => arg === partialRightPlaceholder).length;
-        const rangeLength = Math.max(providedArgs.length - placeholderLength, 0);
-        const args = [];
-        let providedIndex = 0;
-        for (let i = 0; i < rangeLength; i++) {
-            args.push(providedArgs[providedIndex++]);
-        }
-        for (let i = 0; i < partialArgs.length; i++) {
-            const arg = partialArgs[i];
-            if (arg === partialRight.placeholder) {
-                args.push(providedArgs[providedIndex++]);
-            }
-            else {
-                args.push(arg);
-            }
-        }
-        return func.apply(this, args);
-    };
-}
-const partialRightPlaceholder = Symbol('partialRight.placeholder');
-partialRight.placeholder = partialRightPlaceholder;
-
-function rest(func, startIndex = func.length - 1) {
-    return function (...args) {
-        const rest = args.slice(startIndex);
-        const params = args.slice(0, startIndex);
-        while (params.length < startIndex) {
-            params.push(undefined);
-        }
-        return func.apply(this, [...params, rest]);
-    };
-}
-
-exports.after = after;
-exports.ary = ary;
-exports.before = before;
-exports.debounce = debounce;
-exports.memoize = memoize;
-exports.negate = negate;
-exports.noop = noop;
-exports.once = once;
-exports.partial = partial;
-exports.partialRight = partialRight;
-exports.rest = rest;
-exports.throttle = throttle;
-exports.unary = unary;
+const rest = require('../_chunk/rest-CXt9w3.js');
+
+function spread(func) {
+    return function (argsArr) {
+        return func.apply(this, argsArr);
+    };
+}
+
+exports.after = rest.after;
+exports.ary = rest.ary;
+exports.before = rest.before;
+exports.debounce = rest.debounce;
+exports.memoize = rest.memoize;
+exports.negate = rest.negate;
+exports.noop = rest.noop;
+exports.once = rest.once;
+exports.partial = rest.partial;
+exports.partialRight = rest.partialRight;
+exports.rest = rest.rest;
+exports.throttle = rest.throttle;
+exports.unary = rest.unary;
+exports.spread = spread;

package/dist/function/index.mjs

@@ -11,3 +11,4 @@ export { unary } from './unary.mjs';
 export { partial } from './partial.mjs';
 export { partialRight } from './partialRight.mjs';
 export { rest } from './rest.mjs';
+export { spread } from './spread.mjs';