es-toolkit 1.19.0-dev.618 → 1.19.0-dev.620

package/dist/compat/array/findLastIndex.mjs

@@ -2,30 +2,30 @@ import { property } from '../object/property.mjs';
 import { matches } from '../predicate/matches.mjs';
 import { matchesProperty } from '../predicate/matchesProperty.mjs';
 
-function findLastIndex(source, doesMatch, fromIndex = source.length - 1) {
+function findLastIndex(arr, doesMatch, fromIndex = arr.length - 1) {
     if (fromIndex < 0) {
-        fromIndex = Math.max(source.length + fromIndex, 0);
+        fromIndex = Math.max(arr.length + fromIndex, 0);
     }
     else {
-        fromIndex = Math.min(fromIndex, source.length - 1);
+        fromIndex = Math.min(fromIndex, arr.length - 1);
     }
-    source = source.slice(0, fromIndex + 1);
+    arr = arr.slice(0, fromIndex + 1);
     switch (typeof doesMatch) {
         case 'function': {
-            return source.findLastIndex(doesMatch);
+            return arr.findLastIndex(doesMatch);
         }
         case 'object': {
             if (Array.isArray(doesMatch) && doesMatch.length === 2) {
                 const key = doesMatch[0];
                 const value = doesMatch[1];
-                return source.findLastIndex(matchesProperty(key, value));
+                return arr.findLastIndex(matchesProperty(key, value));
             }
             else {
-                return source.findLastIndex(matches(doesMatch));
+                return arr.findLastIndex(matches(doesMatch));
             }
         }
         case 'string': {
-            return source.findLastIndex(property(doesMatch));
+            return arr.findLastIndex(property(doesMatch));
         }
     }
 }

package/dist/compat/array/some.d.mts

@@ -65,7 +65,6 @@ declare function some<T>(arr: readonly T[], doesMatch: Partial<T>): boolean;
  * @param {T[]} arr The array to iterate over.
  * @param {((item: T, index: number, arr: any) => unknown) | Partial<T> | [keyof T, unknown] | string} [predicate=identity] The function invoked per iteration.
  * If a property name or an object is provided it will be used to create a predicate function.
- * @param guard
  * @returns {boolean} Returns `true` if any element passes the predicate check, else `false`.
  *
  * @example

package/dist/compat/array/some.d.ts

@@ -65,7 +65,6 @@ declare function some<T>(arr: readonly T[], doesMatch: Partial<T>): boolean;
  * @param {T[]} arr The array to iterate over.
  * @param {((item: T, index: number, arr: any) => unknown) | Partial<T> | [keyof T, unknown] | string} [predicate=identity] The function invoked per iteration.
  * If a property name or an object is provided it will be used to create a predicate function.
- * @param guard
  * @returns {boolean} Returns `true` if any element passes the predicate check, else `false`.
  *
  * @example

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

@@ -14,6 +14,36 @@ interface ThrottleOptions {
      */
     trailing?: boolean;
 }
+/**
+ * Creates a throttled function that only invokes the provided function at most once
+ * per every `throttleMs` milliseconds. Subsequent calls to the throttled function
+ * within the wait time will not trigger the execution of the original function.
+ *
+ * @template F - The type of function.
+ * @param {F} func - The function to throttle.
+ * @param {number} throttleMs - The number of milliseconds to throttle executions to.
+ * @param {ThrottleOptions} options - The options object
+ * @param {AbortSignal} options.signal - An optional AbortSignal to cancel the throttled function.
+ * @param {boolean} options.leading - If `true`, the function will be invoked on the leading edge of the timeout.
+ * @param {boolean} options.trailing - If `true`, the function will be invoked on the trailing edge of the timeout.
+ * @returns {(...args: Parameters<F>) => void} A new throttled function that accepts the same parameters as the original function.
+ *
+ * @example
+ * const throttledFunction = throttle(() => {
+ *   console.log('Function executed');
+ * }, 1000);
+ *
+ * // Will log 'Function executed' immediately
+ * throttledFunction();
+ *
+ * // Will not log anything as it is within the throttle time
+ * throttledFunction();
+ *
+ * // After 1 second
+ * setTimeout(() => {
+ *   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;

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

@@ -14,6 +14,36 @@ interface ThrottleOptions {
      */
     trailing?: boolean;
 }
+/**
+ * Creates a throttled function that only invokes the provided function at most once
+ * per every `throttleMs` milliseconds. Subsequent calls to the throttled function
+ * within the wait time will not trigger the execution of the original function.
+ *
+ * @template F - The type of function.
+ * @param {F} func - The function to throttle.
+ * @param {number} throttleMs - The number of milliseconds to throttle executions to.
+ * @param {ThrottleOptions} options - The options object
+ * @param {AbortSignal} options.signal - An optional AbortSignal to cancel the throttled function.
+ * @param {boolean} options.leading - If `true`, the function will be invoked on the leading edge of the timeout.
+ * @param {boolean} options.trailing - If `true`, the function will be invoked on the trailing edge of the timeout.
+ * @returns {(...args: Parameters<F>) => void} A new throttled function that accepts the same parameters as the original function.
+ *
+ * @example
+ * const throttledFunction = throttle(() => {
+ *   console.log('Function executed');
+ * }, 1000);
+ *
+ * // Will log 'Function executed' immediately
+ * throttledFunction();
+ *
+ * // Will not log anything as it is within the throttle time
+ * throttledFunction();
+ *
+ * // After 1 second
+ * setTimeout(() => {
+ *   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;

package/dist/compat/index.d.mts

@@ -75,7 +75,6 @@ export { cloneDeep } from '../object/cloneDeep.mjs';
 export { toMerged } from '../object/toMerged.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';
@@ -157,6 +156,8 @@ export { conforms } from './predicate/conforms.mjs';
 export { conformsTo } from './predicate/conformsTo.mjs';
 export { isInteger } from './predicate/isInteger.mjs';
 export { isSafeInteger } from './predicate/isSafeInteger.mjs';
+export { isNumber } from './predicate/isNumber.mjs';
+export { isNaN } from './predicate/isNaN.mjs';
 export { camelCase } from './string/camelCase.mjs';
 export { kebabCase } from './string/kebabCase.mjs';
 export { snakeCase } from './string/snakeCase.mjs';

package/dist/compat/index.d.ts

@@ -75,7 +75,6 @@ export { cloneDeep } from '../object/cloneDeep.js';
 export { toMerged } from '../object/toMerged.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';
@@ -157,6 +156,8 @@ export { conforms } from './predicate/conforms.js';
 export { conformsTo } from './predicate/conformsTo.js';
 export { isInteger } from './predicate/isInteger.js';
 export { isSafeInteger } from './predicate/isSafeInteger.js';
+export { isNumber } from './predicate/isNumber.js';
+export { isNaN } from './predicate/isNaN.js';
 export { camelCase } from './string/camelCase.js';
 export { kebabCase } from './string/kebabCase.js';
 export { snakeCase } from './string/snakeCase.js';

package/dist/compat/index.js

@@ -8,7 +8,7 @@ const rest$1 = require('../_chunk/rest-pUyjvl.js');
 const range = require('../_chunk/range-BXlMmn.js');
 const randomInt = require('../_chunk/randomInt-CF7bZK.js');
 const toMerged = require('../_chunk/toMerged-Bzkqyz.js');
-const isWeakSet$1 = require('../_chunk/isWeakSet-vsS9b6.js');
+const isWeakSet$1 = require('../_chunk/isWeakSet-E_VMwB.js');
 const isPlainObject$1 = require('../_chunk/isPlainObject-BIekvL.js');
 const string_index = require('../string/index.js');
 
@@ -438,30 +438,30 @@ function findIndex(source, doesMatch) {
     }
 }
 
-function findLastIndex(source, doesMatch, fromIndex = source.length - 1) {
+function findLastIndex(arr, doesMatch, fromIndex = arr.length - 1) {
     if (fromIndex < 0) {
-        fromIndex = Math.max(source.length + fromIndex, 0);
+        fromIndex = Math.max(arr.length + fromIndex, 0);
     }
     else {
-        fromIndex = Math.min(fromIndex, source.length - 1);
+        fromIndex = Math.min(fromIndex, arr.length - 1);
     }
-    source = source.slice(0, fromIndex + 1);
+    arr = arr.slice(0, fromIndex + 1);
     switch (typeof doesMatch) {
         case 'function': {
-            return source.findLastIndex(doesMatch);
+            return arr.findLastIndex(doesMatch);
         }
         case 'object': {
             if (Array.isArray(doesMatch) && doesMatch.length === 2) {
                 const key = doesMatch[0];
                 const value = doesMatch[1];
-                return source.findLastIndex(matchesProperty(key, value));
+                return arr.findLastIndex(matchesProperty(key, value));
             }
             else {
-                return source.findLastIndex(matches(doesMatch));
+                return arr.findLastIndex(matches(doesMatch));
             }
         }
         case 'string': {
-            return source.findLastIndex(property(doesMatch));
+            return arr.findLastIndex(property(doesMatch));
         }
     }
 }
@@ -1300,6 +1300,17 @@ function isSafeInteger(value) {
     return Number.isSafeInteger(value);
 }
 
+function isNumber(value) {
+    if (typeof value === 'object' && value != null && isWeakSet$1.getTag(value) === '[object Number]') {
+        return true;
+    }
+    return typeof value === 'number';
+}
+
+function isNaN(value) {
+    return Number.isNaN(value);
+}
+
 function toString(value) {
     if (value == null) {
         return '';
@@ -1572,7 +1583,6 @@ exports.isDate = isWeakSet$1.isDate;
 exports.isEqual = isWeakSet$1.isEqual;
 exports.isFunction = isWeakSet$1.isFunction;
 exports.isLength = isWeakSet$1.isLength;
-exports.isNaN = isWeakSet$1.isNaN;
 exports.isNil = isWeakSet$1.isNil;
 exports.isNotNil = isWeakSet$1.isNotNil;
 exports.isNull = isWeakSet$1.isNull;
@@ -1622,6 +1632,8 @@ exports.isArrayLike = isArrayLike;
 exports.isBoolean = isBoolean;
 exports.isInteger = isInteger;
 exports.isMatch = isMatch;
+exports.isNaN = isNaN;
+exports.isNumber = isNumber;
 exports.isObject = isObject;
 exports.isPlainObject = isPlainObject;
 exports.isRegExp = isRegExp;

package/dist/compat/index.mjs

@@ -76,7 +76,6 @@ export { isObjectLike } from './predicate/isObjectLike.mjs';
 export { toMerged } from '../object/toMerged.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';
@@ -157,6 +156,8 @@ export { conforms } from './predicate/conforms.mjs';
 export { conformsTo } from './predicate/conformsTo.mjs';
 export { isInteger } from './predicate/isInteger.mjs';
 export { isSafeInteger } from './predicate/isSafeInteger.mjs';
+export { isNumber } from './predicate/isNumber.mjs';
+export { isNaN } from './predicate/isNaN.mjs';
 export { camelCase } from './string/camelCase.mjs';
 export { kebabCase } from './string/kebabCase.mjs';
 export { snakeCase } from './string/snakeCase.mjs';

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

@@ -0,0 +1,20 @@
+/**
+ * Checks if a given value is a number.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `number`.
+ *
+ * @param {unknown} value The value to check if it is a number.
+ * @returns {value is number} Returns `true` if `value` is a number, else `false`.
+ *
+ * @example
+ * const value1 = 123;
+ * const value2 = 'abc';
+ * const value3 = true;
+ *
+ * console.log(isNumber(value1)); // true
+ * console.log(isNumber(value2)); // false
+ * console.log(isNumber(value3)); // false
+ */
+declare function isNumber(value?: unknown): value is number;
+
+export { isNumber };

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

@@ -0,0 +1,20 @@
+/**
+ * Checks if a given value is a number.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `number`.
+ *
+ * @param {unknown} value The value to check if it is a number.
+ * @returns {value is number} Returns `true` if `value` is a number, else `false`.
+ *
+ * @example
+ * const value1 = 123;
+ * const value2 = 'abc';
+ * const value3 = true;
+ *
+ * console.log(isNumber(value1)); // true
+ * console.log(isNumber(value2)); // false
+ * console.log(isNumber(value3)); // false
+ */
+declare function isNumber(value?: unknown): value is number;
+
+export { isNumber };

package/dist/compat/predicate/isNumber.mjs

@@ -0,0 +1,10 @@
+import { getTag } from '../_internal/getTag.mjs';
+
+function isNumber(value) {
+    if (typeof value === 'object' && value != null && getTag(value) === '[object Number]') {
+        return true;
+    }
+    return typeof value === 'number';
+}
+
+export { isNumber };

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

@@ -3,7 +3,6 @@
  *
  * @param {string} str - The string from which leading and trailing characters will be trimmed.
  * @param {string | string[]} chars - The character(s) to remove from the end of the string. Defaults to `" "`.
- * @param guard
  * @returns {string} - The resulting string after the specified leading and trailing characters have been removed.
  *
  * @example

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

@@ -3,7 +3,6 @@
  *
  * @param {string} str - The string from which leading and trailing characters will be trimmed.
  * @param {string | string[]} chars - The character(s) to remove from the end of the string. Defaults to `" "`.
- * @param guard
  * @returns {string} - The resulting string after the specified leading and trailing characters have been removed.
  *
  * @example

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

@@ -3,7 +3,6 @@
  *
  * @param {string} str - The string from which trailing characters will be trimmed.
  * @param {string | string[]} chars - The character(s) to remove from the end of the string. Defaults to `" "`.
- * @param guard
  * @returns {string} - The resulting string after the specified trailing character has been removed.
  *
  * @example

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

@@ -3,7 +3,6 @@
  *
  * @param {string} str - The string from which trailing characters will be trimmed.
  * @param {string | string[]} chars - The character(s) to remove from the end of the string. Defaults to `" "`.
- * @param guard
  * @returns {string} - The resulting string after the specified trailing character has been removed.
  *
  * @example

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

@@ -3,7 +3,6 @@
  *
  * @param {string} str - The string from which leading characters will be trimmed.
  * @param {string | string[]} chars - The character(s) to remove from the end of the string. Defaults to `" "`.
- * @param guard
  * @returns {string} - The resulting string after the specified leading character has been removed.
  *
  * @example

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

@@ -3,7 +3,6 @@
  *
  * @param {string} str - The string from which leading characters will be trimmed.
  * @param {string | string[]} chars - The character(s) to remove from the end of the string. Defaults to `" "`.
- * @param guard
  * @returns {string} - The resulting string after the specified leading character has been removed.
  *
  * @example

package/dist/index.d.mts

@@ -96,7 +96,6 @@ 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,7 +96,6 @@ 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

@@ -12,7 +12,7 @@ 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-vsS9b6.js');
+const isWeakSet = require('./_chunk/isWeakSet-E_VMwB.js');
 const isPlainObject = require('./_chunk/isPlainObject-BIekvL.js');
 const predicate_index = require('./predicate/index.js');
 const string_index = require('./string/index.js');
@@ -122,7 +122,6 @@ 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,7 +96,6 @@ 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,6 +1,5 @@
 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,6 +1,5 @@
 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-vsS9b6.js');
+const isWeakSet = require('../_chunk/isWeakSet-E_VMwB.js');
 const isPlainObject = require('../_chunk/isPlainObject-BIekvL.js');
 
 function isRegExp(value) {
@@ -25,7 +25,6 @@ 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,6 +1,5 @@
 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/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.618+f53bfd5c",
+  "version": "1.19.0-dev.620+e32bd246",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {