es-toolkit 1.27.0-dev.896 → 1.27.0-dev.898

package/dist/compat/function/debounce.d.mts

@@ -19,6 +19,11 @@ interface DebounceOptions {
      */
     maxWait?: number;
 }
+interface DebouncedFunction<F extends (...args: any[]) => any> {
+    (...args: Parameters<F>): ReturnType<F> | undefined;
+    cancel(): void;
+    flush(): void;
+}
 /**
  * Creates a debounced function that delays invoking the provided function until after `debounceMs` milliseconds
  * have elapsed since the last time the debounced function was invoked. The debounced function also has a `cancel`
@@ -65,9 +70,6 @@ interface DebounceOptions {
  * // Will cancel the debounced function call
  * controller.abort();
  */
-declare function debounce<F extends (...args: any[]) => any>(func: F, debounceMs?: number, options?: DebounceOptions): ((...args: Parameters<F>) => ReturnType<F> | undefined) & {
-    cancel: () => void;
-    flush: () => void;
-};
+declare function debounce<F extends (...args: any[]) => any>(func: F, debounceMs?: number, options?: DebounceOptions): DebouncedFunction<F>;
 
-export { debounce };
+export { type DebouncedFunction, debounce };

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

@@ -19,6 +19,11 @@ interface DebounceOptions {
      */
     maxWait?: number;
 }
+interface DebouncedFunction<F extends (...args: any[]) => any> {
+    (...args: Parameters<F>): ReturnType<F> | undefined;
+    cancel(): void;
+    flush(): void;
+}
 /**
  * Creates a debounced function that delays invoking the provided function until after `debounceMs` milliseconds
  * have elapsed since the last time the debounced function was invoked. The debounced function also has a `cancel`
@@ -65,9 +70,6 @@ interface DebounceOptions {
  * // Will cancel the debounced function call
  * controller.abort();
  */
-declare function debounce<F extends (...args: any[]) => any>(func: F, debounceMs?: number, options?: DebounceOptions): ((...args: Parameters<F>) => ReturnType<F> | undefined) & {
-    cancel: () => void;
-    flush: () => void;
-};
+declare function debounce<F extends (...args: any[]) => any>(func: F, debounceMs?: number, options?: DebounceOptions): DebouncedFunction<F>;
 
-export { debounce };
+export { type DebouncedFunction, debounce };

package/dist/compat/function/throttle.d.mts

@@ -1,3 +1,5 @@
+import { DebouncedFunction } from './debounce.mjs';
+
 interface ThrottleOptions {
     /**
      * An optional AbortSignal to cancel the function invocation on the trailing edge.
@@ -44,9 +46,6 @@ interface ThrottleOptions {
  *   throttledFunction(); // Will log 'Function executed'
  * }, 1000);
  */
-declare function throttle<F extends (...args: any[]) => any>(func: F, throttleMs?: number, options?: ThrottleOptions): ((...args: Parameters<F>) => ReturnType<F> | undefined) & {
-    cancel: () => void;
-    flush: () => void;
-};
+declare function throttle<F extends (...args: any[]) => any>(func: F, throttleMs?: number, options?: ThrottleOptions): DebouncedFunction<F>;
 
 export { throttle };

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

@@ -1,3 +1,5 @@
+import { DebouncedFunction } from './debounce.js';
+
 interface ThrottleOptions {
     /**
      * An optional AbortSignal to cancel the function invocation on the trailing edge.
@@ -44,9 +46,6 @@ interface ThrottleOptions {
  *   throttledFunction(); // Will log 'Function executed'
  * }, 1000);
  */
-declare function throttle<F extends (...args: any[]) => any>(func: F, throttleMs?: number, options?: ThrottleOptions): ((...args: Parameters<F>) => ReturnType<F> | undefined) & {
-    cancel: () => void;
-    flush: () => void;
-};
+declare function throttle<F extends (...args: any[]) => any>(func: F, throttleMs?: number, options?: ThrottleOptions): DebouncedFunction<F>;
 
 export { throttle };

package/dist/compat/function/throttle.mjs

@@ -5,7 +5,12 @@ function throttle(func, throttleMs = 0, options = {}) {
         options = {};
     }
     const { leading = true, trailing = true, signal } = options;
-    return debounce(func, throttleMs, { leading, trailing, signal, maxWait: throttleMs });
+    return debounce(func, throttleMs, {
+        leading,
+        trailing,
+        signal,
+        maxWait: throttleMs,
+    });
 }
 
 export { throttle };

package/dist/compat/index.d.mts

@@ -38,6 +38,7 @@ export { noop } from '../function/noop.mjs';
 export { once } from '../function/once.mjs';
 export { partial } from '../function/partial.mjs';
 export { partialRight } from '../function/partialRight.mjs';
+export { ThrottledFunction } from '../function/throttle.mjs';
 export { unary } from '../function/unary.mjs';
 export { mean } from '../math/mean.mjs';
 export { meanBy } from '../math/meanBy.mjs';
@@ -75,7 +76,6 @@ export { lowerFirst } from '../string/lowerFirst.mjs';
 export { pascalCase } from '../string/pascalCase.mjs';
 export { unescape } from '../string/unescape.mjs';
 export { upperFirst } from '../string/upperFirst.mjs';
-export { words } from '../string/words.mjs';
 export { invariant } from '../util/invariant.mjs';
 export { castArray } from './array/castArray.mjs';
 export { chunk } from './array/chunk.mjs';
@@ -127,7 +127,7 @@ export { bind } from './function/bind.mjs';
 export { bindKey } from './function/bindKey.mjs';
 export { curry } from './function/curry.mjs';
 export { curryRight } from './function/curryRight.mjs';
-export { debounce } from './function/debounce.mjs';
+export { DebouncedFunction as DebouncedFunc, DebouncedFunction, debounce } from './function/debounce.mjs';
 export { defer } from './function/defer.mjs';
 export { flip } from './function/flip.mjs';
 export { flow } from './function/flow.mjs';
@@ -217,6 +217,7 @@ export { trim } from './string/trim.mjs';
 export { trimEnd } from './string/trimEnd.mjs';
 export { trimStart } from './string/trimStart.mjs';
 export { upperCase } from './string/upperCase.mjs';
+export { words } from './string/words.mjs';
 export { constant } from './util/constant.mjs';
 export { defaultTo } from './util/defaultTo.mjs';
 export { eq } from './util/eq.mjs';

package/dist/compat/index.d.ts

@@ -38,6 +38,7 @@ export { noop } from '../function/noop.js';
 export { once } from '../function/once.js';
 export { partial } from '../function/partial.js';
 export { partialRight } from '../function/partialRight.js';
+export { ThrottledFunction } from '../function/throttle.js';
 export { unary } from '../function/unary.js';
 export { mean } from '../math/mean.js';
 export { meanBy } from '../math/meanBy.js';
@@ -75,7 +76,6 @@ export { lowerFirst } from '../string/lowerFirst.js';
 export { pascalCase } from '../string/pascalCase.js';
 export { unescape } from '../string/unescape.js';
 export { upperFirst } from '../string/upperFirst.js';
-export { words } from '../string/words.js';
 export { invariant } from '../util/invariant.js';
 export { castArray } from './array/castArray.js';
 export { chunk } from './array/chunk.js';
@@ -127,7 +127,7 @@ export { bind } from './function/bind.js';
 export { bindKey } from './function/bindKey.js';
 export { curry } from './function/curry.js';
 export { curryRight } from './function/curryRight.js';
-export { debounce } from './function/debounce.js';
+export { DebouncedFunction as DebouncedFunc, DebouncedFunction, debounce } from './function/debounce.js';
 export { defer } from './function/defer.js';
 export { flip } from './function/flip.js';
 export { flow } from './function/flow.js';
@@ -217,6 +217,7 @@ export { trim } from './string/trim.js';
 export { trimEnd } from './string/trimEnd.js';
 export { trimStart } from './string/trimStart.js';
 export { upperCase } from './string/upperCase.js';
+export { words } from './string/words.js';
 export { constant } from './util/constant.js';
 export { defaultTo } from './util/defaultTo.js';
 export { eq } from './util/eq.js';

package/dist/compat/index.js

@@ -11,7 +11,7 @@ const randomInt = require('../_chunk/randomInt-CF7bZK.js');
 const toMerged = require('../_chunk/toMerged-CPY8Ug.js');
 const isPlainObject$1 = require('../_chunk/isPlainObject-octpoD.js');
 const isWeakSet$1 = require('../_chunk/isWeakSet-CvIdTA.js');
-const upperFirst = require('../_chunk/upperFirst-DK_rTF.js');
+const upperFirst = require('../_chunk/upperFirst-CorAVn.js');
 const util_index = require('../util/index.js');
 
 function castArray(value) {
@@ -1630,7 +1630,12 @@ function throttle(func, throttleMs = 0, options = {}) {
         options = {};
     }
     const { leading = true, trailing = true, signal } = options;
-    return debounce(func, throttleMs, { leading, trailing, signal, maxWait: throttleMs });
+    return debounce(func, throttleMs, {
+        leading,
+        trailing,
+        signal,
+        maxWait: throttleMs,
+    });
 }
 
 function add(value, other) {
@@ -2602,6 +2607,12 @@ function upperCase(str) {
     return upperFirst.upperCase(normalizeForCase(str));
 }
 
+function words(str, pattern = upperFirst.CASE_SPLIT_PATTERN) {
+    const input = toString(str);
+    const words = Array.from(input.match(pattern) ?? []);
+    return words.filter(x => x !== '');
+}
+
 function constant(value) {
     return () => value;
 }
@@ -2719,7 +2730,6 @@ exports.lowerFirst = upperFirst.lowerFirst;
 exports.pascalCase = upperFirst.pascalCase;
 exports.unescape = upperFirst.unescape;
 exports.upperFirst = upperFirst.upperFirst;
-exports.words = upperFirst.words;
 exports.invariant = util_index.invariant;
 exports.add = add;
 exports.ary = ary;
@@ -2874,5 +2884,6 @@ exports.unset = unset;
 exports.unzip = unzip;
 exports.upperCase = upperCase;
 exports.without = without;
+exports.words = words;
 exports.zip = zip;
 exports.zipObjectDeep = zipObjectDeep;

package/dist/compat/index.mjs

@@ -70,7 +70,6 @@ export { delay } from '../promise/delay.mjs';
 export { timeout } from '../promise/timeout.mjs';
 export { withTimeout } from '../promise/withTimeout.mjs';
 export { capitalize } from '../string/capitalize.mjs';
-export { words } from '../string/words.mjs';
 export { constantCase } from '../string/constantCase.mjs';
 export { deburr } from '../string/deburr.mjs';
 export { escapeRegExp } from '../string/escapeRegExp.mjs';
@@ -218,6 +217,7 @@ export { trim } from './string/trim.mjs';
 export { trimEnd } from './string/trimEnd.mjs';
 export { trimStart } from './string/trimStart.mjs';
 export { upperCase } from './string/upperCase.mjs';
+export { words } from './string/words.mjs';
 export { constant } from './util/constant.mjs';
 export { defaultTo } from './util/defaultTo.mjs';
 export { iteratee } from './util/iteratee.mjs';

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

@@ -0,0 +1,15 @@
+/**
+ * Splits `string` into an array of its words.
+ *
+ * @param {string | object} str - The string or object that is to be split into words.
+ * @param {RegExp | string} [pattern] - The pattern to match words.
+ * @returns {string[]} - Returns the words of `string`.
+ *
+ * @example
+ * const wordsArray1 = words('fred, barney, & pebbles');
+ * // => ['fred', 'barney', 'pebbles']
+ *
+ */
+declare function words(str?: string | object, pattern?: RegExp | string): string[];
+
+export { words };

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

@@ -0,0 +1,15 @@
+/**
+ * Splits `string` into an array of its words.
+ *
+ * @param {string | object} str - The string or object that is to be split into words.
+ * @param {RegExp | string} [pattern] - The pattern to match words.
+ * @returns {string[]} - Returns the words of `string`.
+ *
+ * @example
+ * const wordsArray1 = words('fred, barney, & pebbles');
+ * // => ['fred', 'barney', 'pebbles']
+ *
+ */
+declare function words(str?: string | object, pattern?: RegExp | string): string[];
+
+export { words };

package/dist/compat/string/words.mjs

@@ -0,0 +1,10 @@
+import { CASE_SPLIT_PATTERN } from '../../string/words.mjs';
+import { toString } from '../util/toString.mjs';
+
+function words(str, pattern = CASE_SPLIT_PATTERN) {
+    const input = toString(str);
+    const words = Array.from(input.match(pattern) ?? []);
+    return words.filter(x => x !== '');
+}
+
+export { words };

package/dist/function/debounce.d.mts

@@ -12,6 +12,28 @@ interface DebounceOptions {
      */
     edges?: Array<'leading' | 'trailing'>;
 }
+interface DebouncedFunction<F extends (...args: any[]) => void> {
+    (...args: Parameters<F>): void;
+    /**
+     * Schedules the execution of the debounced function after the specified debounce delay.
+     * This method resets any existing timer, ensuring that the function is only invoked
+     * after the delay has elapsed since the last call to the debounced function.
+     * It is typically called internally whenever the debounced function is invoked.
+     *
+     * @returns {void}
+     */
+    schedule: () => void;
+    /**
+     * Cancels any pending execution of the debounced function.
+     * This method clears the active timer and resets any stored context or arguments.
+     */
+    cancel: () => void;
+    /**
+     * Immediately invokes the debounced function if there is a pending execution.
+     * This method also cancels the current timer, ensuring that the function executes right away.
+     */
+    flush: () => void;
+}
 /**
  * Creates a debounced function that delays invoking the provided function until after `debounceMs` milliseconds
  * have elapsed since the last time the debounced function was invoked. The debounced function also has a `cancel`
@@ -47,26 +69,6 @@ interface DebounceOptions {
  * // Will cancel the debounced function call
  * controller.abort();
  */
-declare function debounce<F extends (...args: any[]) => void>(func: F, debounceMs: number, { signal, edges }?: DebounceOptions): ((...args: Parameters<F>) => void) & {
-    /**
-     * Schedules the execution of the debounced function after the specified debounce delay.
-     * This method resets any existing timer, ensuring that the function is only invoked
-     * after the delay has elapsed since the last call to the debounced function.
-     * It is typically called internally whenever the debounced function is invoked.
-     *
-     * @returns {void}
-     */
-    schedule: () => void;
-    /**
-     * Cancels any pending execution of the debounced function.
-     * This method clears the active timer and resets any stored context or arguments.
-     */
-    cancel: () => void;
-    /**
-     * Immediately invokes the debounced function if there is a pending execution.
-     * This method also cancels the current timer, ensuring that the function executes right away.
-     */
-    flush: () => void;
-};
+declare function debounce<F extends (...args: any[]) => void>(func: F, debounceMs: number, { signal, edges }?: DebounceOptions): DebouncedFunction<F>;
 
-export { debounce };
+export { type DebouncedFunction, debounce };

package/dist/function/debounce.d.ts

@@ -12,6 +12,28 @@ interface DebounceOptions {
      */
     edges?: Array<'leading' | 'trailing'>;
 }
+interface DebouncedFunction<F extends (...args: any[]) => void> {
+    (...args: Parameters<F>): void;
+    /**
+     * Schedules the execution of the debounced function after the specified debounce delay.
+     * This method resets any existing timer, ensuring that the function is only invoked
+     * after the delay has elapsed since the last call to the debounced function.
+     * It is typically called internally whenever the debounced function is invoked.
+     *
+     * @returns {void}
+     */
+    schedule: () => void;
+    /**
+     * Cancels any pending execution of the debounced function.
+     * This method clears the active timer and resets any stored context or arguments.
+     */
+    cancel: () => void;
+    /**
+     * Immediately invokes the debounced function if there is a pending execution.
+     * This method also cancels the current timer, ensuring that the function executes right away.
+     */
+    flush: () => void;
+}
 /**
  * Creates a debounced function that delays invoking the provided function until after `debounceMs` milliseconds
  * have elapsed since the last time the debounced function was invoked. The debounced function also has a `cancel`
@@ -47,26 +69,6 @@ interface DebounceOptions {
  * // Will cancel the debounced function call
  * controller.abort();
  */
-declare function debounce<F extends (...args: any[]) => void>(func: F, debounceMs: number, { signal, edges }?: DebounceOptions): ((...args: Parameters<F>) => void) & {
-    /**
-     * Schedules the execution of the debounced function after the specified debounce delay.
-     * This method resets any existing timer, ensuring that the function is only invoked
-     * after the delay has elapsed since the last call to the debounced function.
-     * It is typically called internally whenever the debounced function is invoked.
-     *
-     * @returns {void}
-     */
-    schedule: () => void;
-    /**
-     * Cancels any pending execution of the debounced function.
-     * This method clears the active timer and resets any stored context or arguments.
-     */
-    cancel: () => void;
-    /**
-     * Immediately invokes the debounced function if there is a pending execution.
-     * This method also cancels the current timer, ensuring that the function executes right away.
-     */
-    flush: () => void;
-};
+declare function debounce<F extends (...args: any[]) => void>(func: F, debounceMs: number, { signal, edges }?: DebounceOptions): DebouncedFunction<F>;
 
-export { debounce };
+export { type DebouncedFunction, debounce };

package/dist/function/index.d.mts

@@ -3,7 +3,7 @@ export { ary } from './ary.mjs';
 export { before } from './before.mjs';
 export { curry } from './curry.mjs';
 export { curryRight } from './curryRight.mjs';
-export { debounce } from './debounce.mjs';
+export { DebouncedFunction, debounce } from './debounce.mjs';
 export { flow } from './flow.mjs';
 export { flowRight } from './flowRight.mjs';
 export { identity } from './identity.mjs';
@@ -15,5 +15,5 @@ export { partial } from './partial.mjs';
 export { partialRight } from './partialRight.mjs';
 export { rest } from './rest.mjs';
 export { spread } from './spread.mjs';
-export { throttle } from './throttle.mjs';
+export { ThrottledFunction, throttle } from './throttle.mjs';
 export { unary } from './unary.mjs';

package/dist/function/index.d.ts

@@ -3,7 +3,7 @@ export { ary } from './ary.js';
 export { before } from './before.js';
 export { curry } from './curry.js';
 export { curryRight } from './curryRight.js';
-export { debounce } from './debounce.js';
+export { DebouncedFunction, debounce } from './debounce.js';
 export { flow } from './flow.js';
 export { flowRight } from './flowRight.js';
 export { identity } from './identity.js';
@@ -15,5 +15,5 @@ export { partial } from './partial.js';
 export { partialRight } from './partialRight.js';
 export { rest } from './rest.js';
 export { spread } from './spread.js';
-export { throttle } from './throttle.js';
+export { ThrottledFunction, throttle } from './throttle.js';
 export { unary } from './unary.js';

package/dist/function/throttle.d.mts

@@ -12,6 +12,11 @@ interface ThrottleOptions {
      */
     edges?: Array<'leading' | 'trailing'>;
 }
+interface ThrottledFunction<F extends (...args: any[]) => void> {
+    (...args: Parameters<F>): void;
+    cancel: () => void;
+    flush: () => void;
+}
 /**
  * Creates a throttled function that only invokes the provided function at most once
  * per every `throttleMs` milliseconds. Subsequent calls to the throttled function
@@ -38,9 +43,6 @@ interface ThrottleOptions {
  *   throttledFunction(); // Will log 'Function executed'
  * }, 1000);
  */
-declare function throttle<F extends (...args: any[]) => void>(func: F, throttleMs: number, { signal, edges }?: ThrottleOptions): ((...args: Parameters<F>) => void) & {
-    cancel: () => void;
-    flush: () => void;
-};
+declare function throttle<F extends (...args: any[]) => void>(func: F, throttleMs: number, { signal, edges }?: ThrottleOptions): ThrottledFunction<F>;
 
-export { throttle };
+export { type ThrottledFunction, throttle };

package/dist/function/throttle.d.ts

@@ -12,6 +12,11 @@ interface ThrottleOptions {
      */
     edges?: Array<'leading' | 'trailing'>;
 }
+interface ThrottledFunction<F extends (...args: any[]) => void> {
+    (...args: Parameters<F>): void;
+    cancel: () => void;
+    flush: () => void;
+}
 /**
  * Creates a throttled function that only invokes the provided function at most once
  * per every `throttleMs` milliseconds. Subsequent calls to the throttled function
@@ -38,9 +43,6 @@ interface ThrottleOptions {
  *   throttledFunction(); // Will log 'Function executed'
  * }, 1000);
  */
-declare function throttle<F extends (...args: any[]) => void>(func: F, throttleMs: number, { signal, edges }?: ThrottleOptions): ((...args: Parameters<F>) => void) & {
-    cancel: () => void;
-    flush: () => void;
-};
+declare function throttle<F extends (...args: any[]) => void>(func: F, throttleMs: number, { signal, edges }?: ThrottleOptions): ThrottledFunction<F>;
 
-export { throttle };
+export { type ThrottledFunction, throttle };

package/dist/index.d.mts

@@ -62,7 +62,7 @@ export { ary } from './function/ary.mjs';
 export { before } from './function/before.mjs';
 export { curry } from './function/curry.mjs';
 export { curryRight } from './function/curryRight.mjs';
-export { debounce } from './function/debounce.mjs';
+export { DebouncedFunction, debounce } from './function/debounce.mjs';
 export { flow } from './function/flow.mjs';
 export { flowRight } from './function/flowRight.mjs';
 export { identity } from './function/identity.mjs';
@@ -74,7 +74,7 @@ export { partial } from './function/partial.mjs';
 export { partialRight } from './function/partialRight.mjs';
 export { rest } from './function/rest.mjs';
 export { spread } from './function/spread.mjs';
-export { throttle } from './function/throttle.mjs';
+export { ThrottledFunction, throttle } from './function/throttle.mjs';
 export { unary } from './function/unary.mjs';
 export { clamp } from './math/clamp.mjs';
 export { inRange } from './math/inRange.mjs';

package/dist/index.d.ts

@@ -62,7 +62,7 @@ export { ary } from './function/ary.js';
 export { before } from './function/before.js';
 export { curry } from './function/curry.js';
 export { curryRight } from './function/curryRight.js';
-export { debounce } from './function/debounce.js';
+export { DebouncedFunction, debounce } from './function/debounce.js';
 export { flow } from './function/flow.js';
 export { flowRight } from './function/flowRight.js';
 export { identity } from './function/identity.js';
@@ -74,7 +74,7 @@ export { partial } from './function/partial.js';
 export { partialRight } from './function/partialRight.js';
 export { rest } from './function/rest.js';
 export { spread } from './function/spread.js';
-export { throttle } from './function/throttle.js';
+export { ThrottledFunction, throttle } from './function/throttle.js';
 export { unary } from './function/unary.js';
 export { clamp } from './math/clamp.js';
 export { inRange } from './math/inRange.js';

package/dist/index.js

@@ -16,7 +16,7 @@ const object_index = require('./object/index.js');
 const isWeakSet = require('./_chunk/isWeakSet-CvIdTA.js');
 const predicate_index = require('./predicate/index.js');
 const isPlainObject = require('./_chunk/isPlainObject-octpoD.js');
-const upperFirst = require('./_chunk/upperFirst-DK_rTF.js');
+const upperFirst = require('./_chunk/upperFirst-CorAVn.js');
 const string_index = require('./string/index.js');
 const util_index = require('./util/index.js');
 

package/dist/string/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const upperFirst = require('../_chunk/upperFirst-DK_rTF.js');
+const upperFirst = require('../_chunk/upperFirst-CorAVn.js');
 
 function startCase(str) {
     const words = upperFirst.words(str.trim());

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.27.0-dev.896+4e096f8c",
+  "version": "1.27.0-dev.898+578c0000",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {