es-toolkit 1.27.0 → 1.28.0-dev.910

package/dist/compat/util/gt.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Checks if value is greater than other.
+ *
+ * @param {unknown} value The value to compare.
+ * @param {unknown} other The other value to compare.
+ * @returns {boolean} Returns `true` if value is greater than other, else `false`.
+ *
+ * @example
+ * gt(3, 1); // true
+ * gt(3, 3); // false
+ * gt(1, 3); // false
+ */
+declare function gt(value: unknown, other: unknown): boolean;
+
+export { gt };

package/dist/compat/util/gt.mjs

@@ -0,0 +1,10 @@
+import { toNumber } from './toNumber.mjs';
+
+function gt(value, other) {
+    if (typeof value === 'string' && typeof other === 'string') {
+        return value > other;
+    }
+    return toNumber(value) > toNumber(other);
+}
+
+export { gt };

package/dist/compat/util/gte.d.mts

@@ -0,0 +1,15 @@
+/**
+ * Checks if value is greater than or equal to other.
+ *
+ * @param {unknown} value The value to compare.
+ * @param {unknown} other The other value to compare.
+ * @returns {boolean} Returns `true` if value is greater than or equal to other, else `false`.
+ *
+ * @example
+ * gte(3, 1); // => true
+ * gte(3, 3); // => true
+ * gte(1, 3); // => false
+ */
+declare function gte(value: unknown, other: unknown): boolean;
+
+export { gte };

package/dist/compat/util/gte.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Checks if value is greater than or equal to other.
+ *
+ * @param {unknown} value The value to compare.
+ * @param {unknown} other The other value to compare.
+ * @returns {boolean} Returns `true` if value is greater than or equal to other, else `false`.
+ *
+ * @example
+ * gte(3, 1); // => true
+ * gte(3, 3); // => true
+ * gte(1, 3); // => false
+ */
+declare function gte(value: unknown, other: unknown): boolean;
+
+export { gte };

package/dist/compat/util/gte.mjs

@@ -0,0 +1,10 @@
+import { toNumber } from './toNumber.mjs';
+
+function gte(value, other) {
+    if (typeof value === 'string' && typeof other === 'string') {
+        return value >= other;
+    }
+    return toNumber(value) >= toNumber(other);
+}
+
+export { gte };

package/dist/compat/util/iteratee.d.mts

@@ -39,6 +39,6 @@ declare function iteratee<F extends (...args: any[]) => unknown>(func: F): F;
  * const func = iteratee(['a', 1]);
  * [{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
  */
-declare function iteratee(value: symbol | number | string | object): (...args: any[]) => any;
+declare function iteratee(value?: symbol | number | string | object): (...args: any[]) => any;
 
 export { iteratee };

package/dist/compat/util/iteratee.d.ts

@@ -39,6 +39,6 @@ declare function iteratee<F extends (...args: any[]) => unknown>(func: F): F;
  * const func = iteratee(['a', 1]);
  * [{ a: 1 }, { a: 2 }, { a: 3 }].find(func) // => { a: 1 }
  */
-declare function iteratee(value: symbol | number | string | object): (...args: any[]) => any;
+declare function iteratee(value?: symbol | number | string | object): (...args: any[]) => any;
 
 export { iteratee };

package/dist/compat/util/toArray.d.mts

@@ -0,0 +1,15 @@
+/**
+ * Converts a value to an array.
+ *
+ * @param {unknown} value - The value to convert.
+ * @returns {any[]} Returns the converted array.
+ *
+ * @example
+ * toArray({ 'a': 1, 'b': 2 }) // => returns [1,2]
+ * toArray('abc') // => returns ['a', 'b', 'c']
+ * toArray(1) // => returns []
+ * toArray(null) // => returns []
+ */
+declare function toArray(value?: unknown): any[];
+
+export { toArray };

package/dist/compat/util/toArray.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Converts a value to an array.
+ *
+ * @param {unknown} value - The value to convert.
+ * @returns {any[]} Returns the converted array.
+ *
+ * @example
+ * toArray({ 'a': 1, 'b': 2 }) // => returns [1,2]
+ * toArray('abc') // => returns ['a', 'b', 'c']
+ * toArray(1) // => returns []
+ * toArray(null) // => returns []
+ */
+declare function toArray(value?: unknown): any[];
+
+export { toArray };

package/dist/compat/util/toArray.mjs

@@ -0,0 +1,20 @@
+import { isArrayLike } from '../predicate/isArrayLike.mjs';
+import { isMap } from '../predicate/isMap.mjs';
+
+function toArray(value) {
+    if (value == null) {
+        return [];
+    }
+    if (isArrayLike(value) || isMap(value)) {
+        return Array.from(value);
+    }
+    if (typeof value === 'string') {
+        return value.split('');
+    }
+    if (typeof value === 'object') {
+        return Object.values(value);
+    }
+    return [];
+}
+
+export { toArray };

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';