es-toolkit 1.19.0-dev.615 → 1.19.0-dev.617

package/dist/function/throttle.d.mts

@@ -1,3 +1,17 @@
+interface ThrottleOptions {
+    /**
+     * An optional AbortSignal to cancel the debounced function.
+     */
+    signal?: AbortSignal;
+    /**
+     * An optional array specifying whether the function should be invoked on the leading edge, trailing edge, or both.
+     * If `edges` includes "leading", the function will be invoked at the start of the delay period.
+     * If `edges` includes "trailing", the function will be invoked at the end of the delay period.
+     * If both "leading" and "trailing" are included, the function will be invoked at both the start and end of the delay period.
+     * @default ["leading", "trailing"]
+     */
+    edges?: Array<'leading' | 'trailing'>;
+}
 /**
  * Creates a throttled function that only invokes the provided function at most once
  * per every `throttleMs` milliseconds. Subsequent calls to the throttled function
@@ -24,6 +38,9 @@
  *   throttledFunction(); // Will log 'Function executed'
  * }, 1000);
  */
-declare function throttle<F extends (...args: any[]) => void>(func: F, throttleMs: number): (...args: Parameters<F>) => void;
+declare function throttle<F extends (...args: any[]) => void>(func: F, throttleMs: number, { signal, edges }?: ThrottleOptions): ((...args: Parameters<F>) => void) & {
+    cancel: () => void;
+    flush: () => void;
+};
 
 export { throttle };

package/dist/function/throttle.d.ts

@@ -1,3 +1,17 @@
+interface ThrottleOptions {
+    /**
+     * An optional AbortSignal to cancel the debounced function.
+     */
+    signal?: AbortSignal;
+    /**
+     * An optional array specifying whether the function should be invoked on the leading edge, trailing edge, or both.
+     * If `edges` includes "leading", the function will be invoked at the start of the delay period.
+     * If `edges` includes "trailing", the function will be invoked at the end of the delay period.
+     * If both "leading" and "trailing" are included, the function will be invoked at both the start and end of the delay period.
+     * @default ["leading", "trailing"]
+     */
+    edges?: Array<'leading' | 'trailing'>;
+}
 /**
  * Creates a throttled function that only invokes the provided function at most once
  * per every `throttleMs` milliseconds. Subsequent calls to the throttled function
@@ -24,6 +38,9 @@
  *   throttledFunction(); // Will log 'Function executed'
  * }, 1000);
  */
-declare function throttle<F extends (...args: any[]) => void>(func: F, throttleMs: number): (...args: Parameters<F>) => void;
+declare function throttle<F extends (...args: any[]) => void>(func: F, throttleMs: number, { signal, edges }?: ThrottleOptions): ((...args: Parameters<F>) => void) & {
+    cancel: () => void;
+    flush: () => void;
+};
 
 export { throttle };

package/dist/function/throttle.mjs

@@ -1,13 +1,23 @@
-function throttle(func, throttleMs) {
-    let lastCallTime;
-    const throttledFunction = function (...args) {
-        const now = Date.now();
-        if (lastCallTime == null || now - lastCallTime >= throttleMs) {
-            lastCallTime = now;
-            func(...args);
+import { debounce } from './debounce.mjs';
+
+function throttle(func, throttleMs, { signal, edges = ['leading', 'trailing'] } = {}) {
+    let pendingAt = null;
+    const debounced = debounce(func, throttleMs, { signal, edges });
+    const throttled = function (...args) {
+        if (pendingAt == null) {
+            pendingAt = Date.now();
+        }
+        else {
+            if (Date.now() - pendingAt >= throttleMs) {
+                debounced.cancel();
+                debounced(...args);
+            }
         }
+        debounced(...args);
     };
-    return throttledFunction;
+    throttled.cancel = debounced.cancel;
+    throttled.flush = debounced.flush;
+    return throttled;
 }
 
 export { throttle };

package/dist/index.d.mts

@@ -96,6 +96,7 @@ export { toMerged } from './object/toMerged.mjs';
 export { mergeWith } from './object/mergeWith.mjs';
 export { isDate } from './predicate/isDate.mjs';
 export { isEqual } from './predicate/isEqual.mjs';
+export { isNaN } from './predicate/isNaN.mjs';
 export { isNil } from './predicate/isNil.mjs';
 export { isNotNil } from './predicate/isNotNil.mjs';
 export { isNull } from './predicate/isNull.mjs';

package/dist/index.d.ts

@@ -96,6 +96,7 @@ export { toMerged } from './object/toMerged.js';
 export { mergeWith } from './object/mergeWith.js';
 export { isDate } from './predicate/isDate.js';
 export { isEqual } from './predicate/isEqual.js';
+export { isNaN } from './predicate/isNaN.js';
 export { isNil } from './predicate/isNil.js';
 export { isNotNil } from './predicate/isNotNil.js';
 export { isNull } from './predicate/isNull.js';

package/dist/index.js

@@ -5,14 +5,14 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const zipWith = require('./_chunk/zipWith-CDtN9Y.js');
 const array_index = require('./array/index.js');
 const promise_index = require('./_chunk/index-BGZDR9.js');
-const rest = require('./_chunk/rest-CXt9w3.js');
+const rest = require('./_chunk/rest-pUyjvl.js');
 const function_index = require('./function/index.js');
 const range = require('./_chunk/range-BXlMmn.js');
 const randomInt = require('./_chunk/randomInt-CF7bZK.js');
 const math_index = require('./math/index.js');
 const object_index = require('./object/index.js');
 const toMerged = require('./_chunk/toMerged-Bzkqyz.js');
-const isWeakSet = require('./_chunk/isWeakSet-E_VMwB.js');
+const isWeakSet = require('./_chunk/isWeakSet-vsS9b6.js');
 const isPlainObject = require('./_chunk/isPlainObject-BIekvL.js');
 const predicate_index = require('./predicate/index.js');
 const string_index = require('./string/index.js');
@@ -91,10 +91,10 @@ 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.curry = function_index.curry;
 exports.spread = function_index.spread;
+exports.throttle = function_index.throttle;
 exports.clamp = range.clamp;
 exports.inRange = range.inRange;
 exports.mean = range.mean;
@@ -122,6 +122,7 @@ exports.isDate = isWeakSet.isDate;
 exports.isEqual = isWeakSet.isEqual;
 exports.isFunction = isWeakSet.isFunction;
 exports.isLength = isWeakSet.isLength;
+exports.isNaN = isWeakSet.isNaN;
 exports.isNil = isWeakSet.isNil;
 exports.isNotNil = isWeakSet.isNotNil;
 exports.isNull = isWeakSet.isNull;

package/dist/index.mjs

@@ -96,6 +96,7 @@ export { toMerged } from './object/toMerged.mjs';
 export { mergeWith } from './object/mergeWith.mjs';
 export { isDate } from './predicate/isDate.mjs';
 export { isEqual } from './predicate/isEqual.mjs';
+export { isNaN } from './predicate/isNaN.mjs';
 export { isNil } from './predicate/isNil.mjs';
 export { isNotNil } from './predicate/isNotNil.mjs';
 export { isNull } from './predicate/isNull.mjs';

package/dist/predicate/index.d.mts

@@ -1,5 +1,6 @@
 export { isDate } from './isDate.mjs';
 export { isEqual } from './isEqual.mjs';
+export { isNaN } from './isNaN.mjs';
 export { isNil } from './isNil.mjs';
 export { isNotNil } from './isNotNil.mjs';
 export { isNull } from './isNull.mjs';

package/dist/predicate/index.d.ts

@@ -1,5 +1,6 @@
 export { isDate } from './isDate.js';
 export { isEqual } from './isEqual.js';
+export { isNaN } from './isNaN.js';
 export { isNil } from './isNil.js';
 export { isNotNil } from './isNotNil.js';
 export { isNull } from './isNull.js';

package/dist/predicate/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const isWeakSet = require('../_chunk/isWeakSet-E_VMwB.js');
+const isWeakSet = require('../_chunk/isWeakSet-vsS9b6.js');
 const isPlainObject = require('../_chunk/isPlainObject-BIekvL.js');
 
 function isRegExp(value) {
@@ -25,6 +25,7 @@ exports.isDate = isWeakSet.isDate;
 exports.isEqual = isWeakSet.isEqual;
 exports.isFunction = isWeakSet.isFunction;
 exports.isLength = isWeakSet.isLength;
+exports.isNaN = isWeakSet.isNaN;
 exports.isNil = isWeakSet.isNil;
 exports.isNotNil = isWeakSet.isNotNil;
 exports.isNull = isWeakSet.isNull;

package/dist/predicate/index.mjs

@@ -1,5 +1,6 @@
 export { isDate } from './isDate.mjs';
 export { isEqual } from './isEqual.mjs';
+export { isNaN } from './isNaN.mjs';
 export { isNil } from './isNil.mjs';
 export { isNotNil } from './isNotNil.mjs';
 export { isNull } from './isNull.mjs';

package/dist/predicate/isNaN.d.mts

@@ -0,0 +1,15 @@
+/**
+ * Checks if the value is NaN.
+ *
+ * @param {unknown} value - The value to check.
+ * @returns {value is typeof NaN} `true` if the value is NaN, `false` otherwise.
+ *
+ * @example
+ * isNaN(NaN); // true
+ * isNaN(0); // false
+ * isNaN('NaN'); // false
+ * isNaN(undefined); // false
+ */
+declare function isNaN(value: unknown): value is typeof NaN;
+
+export { isNaN };

package/dist/predicate/isNaN.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Checks if the value is NaN.
+ *
+ * @param {unknown} value - The value to check.
+ * @returns {value is typeof NaN} `true` if the value is NaN, `false` otherwise.
+ *
+ * @example
+ * isNaN(NaN); // true
+ * isNaN(0); // false
+ * isNaN('NaN'); // false
+ * isNaN(undefined); // false
+ */
+declare function isNaN(value: unknown): value is typeof NaN;
+
+export { isNaN };

package/dist/predicate/isNaN.mjs

@@ -0,0 +1,5 @@
+function isNaN(value) {
+    return Number.isNaN(value);
+}
+
+export { isNaN };

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.19.0-dev.615+b402c8f4",
+  "version": "1.19.0-dev.617+c21874ef",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {