es-toolkit 1.17.0-dev.533 → 1.17.0-dev.536

package/dist/compat/object/mergeWith.mjs

@@ -16,7 +16,7 @@ function mergeWith(object, ...otherArgs) {
     return result;
 }
 function mergeWithDeep(target, source, merge, stack) {
-    if (source == null || typeof source !== 'object') {
+    if (source == null || typeof source !== "object") {
         return target;
     }
     if (stack.has(source)) {
@@ -40,11 +40,13 @@ function mergeWithDeep(target, source, merge, stack) {
         if (isArguments(targetValue)) {
             targetValue = { ...targetValue };
         }
-        if (typeof Buffer !== 'undefined' && Buffer.isBuffer(sourceValue)) {
+        if (typeof Buffer !== "undefined" && Buffer.isBuffer(sourceValue)) {
             sourceValue = cloneDeep(sourceValue);
         }
         if (Array.isArray(sourceValue)) {
-            targetValue = typeof targetValue === 'object' ? Array.from(targetValue ?? []) : [];
+            targetValue = typeof targetValue === "object"
+                ? Array.from(targetValue ?? [])
+                : [];
         }
         const merged = merge(targetValue, sourceValue, key, target, source, stack);
         if (merged != null) {

package/dist/compat/object/set.mjs

@@ -2,7 +2,11 @@ import { isIndex } from '../_internal/isIndex.mjs';
 import { toPath } from '../_internal/toPath.mjs';
 
 function set(obj, path, value) {
-    const resolvedPath = Array.isArray(path) ? path : typeof path === 'string' ? toPath(path) : [path];
+    const resolvedPath = Array.isArray(path)
+        ? path
+        : typeof path === "string"
+            ? toPath(path)
+            : [path];
     let current = obj;
     for (let i = 0; i < resolvedPath.length - 1; i++) {
         const key = resolvedPath[i];

package/dist/compat/predicate/isMatch.mjs

@@ -8,7 +8,7 @@ function isMatch(target, source) {
         return true;
     }
     switch (typeof source) {
-        case 'object': {
+        case "object": {
             if (source == null) {
                 return true;
             }
@@ -42,7 +42,7 @@ function isMatch(target, source) {
             }
             return true;
         }
-        case 'function': {
+        case "function": {
             if (Object.keys(source).length > 0) {
                 return isMatch(target, { ...source });
             }

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

@@ -5,7 +5,7 @@
  * the original string is returned unchanged.
  *
  * @param {string} str - The string to repeat.
- * @param n {number} - The number of times to repeat the string.
+ * @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.
  */
 declare function repeat(str: string, n: number): string;

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

@@ -5,7 +5,7 @@
  * the original string is returned unchanged.
  *
  * @param {string} str - The string to repeat.
- * @param n {number} - The number of times to repeat the string.
+ * @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.
  */
 declare function repeat(str: string, n: number): string;

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

package/dist/function/debounce.d.mts

@@ -11,7 +11,7 @@ interface DebounceOptions {
  * @param {number} debounceMs - The number of milliseconds to delay.
  * @param {DebounceOptions} options - The options object
  * @param {AbortSignal} options.signal - An optional AbortSignal to cancel the debounced function.
- * @returns {((...args: Parameters<F>) => void) & { cancel: () => void }} A new debounced function with a `cancel` method.
+ * @returns A new debounced function with a `cancel` method.
  *
  * @example
  * const debouncedFunction = debounce(() => {

package/dist/function/debounce.d.ts

@@ -11,7 +11,7 @@ interface DebounceOptions {
  * @param {number} debounceMs - The number of milliseconds to delay.
  * @param {DebounceOptions} options - The options object
  * @param {AbortSignal} options.signal - An optional AbortSignal to cancel the debounced function.
- * @returns {((...args: Parameters<F>) => void) & { cancel: () => void }} A new debounced function with a `cancel` method.
+ * @returns A new debounced function with a `cancel` method.
  *
  * @example
  * const debouncedFunction = debounce(() => {

package/dist/function/debounce.mjs

@@ -21,7 +21,7 @@ function debounce(func, debounceMs, { signal } = {}) {
             timeoutId = null;
         }
     };
-    signal?.addEventListener('abort', onAbort, { once: true });
+    signal?.addEventListener("abort", onAbort, { once: true });
     return debounced;
 }
 

package/dist/function/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const rest = require('../_chunk/rest-Bzm2XK.js');
+const rest = require('../_chunk/rest-CXB7TJ.js');
 
 function spread(func) {
     return function (argsArr) {

package/dist/function/memoize.d.mts

@@ -16,7 +16,7 @@
  * @param {MemoizeCache<any, V>} [options.cache] - The cache object used to store results. Defaults to a new `Map`.
  * @param {(args: A) => unknown} [options.getCacheKey] - An optional function to generate a unique cache key for each argument.
  *
- * @returns {F & { cache: MemoizeCache<any, ReturnType<F>> }} - The memoized function with an additional `cache` property that exposes the internal cache.
+ * @returns The memoized function with an additional `cache` property that exposes the internal cache.
  *
  * @example
  * // Example using the default cache
@@ -76,12 +76,48 @@ declare function memoize<F extends (...args: any) => any>(fn: F, options?: {
 }): F & {
     cache: MemoizeCache<any, ReturnType<F>>;
 };
+/**
+ * Represents a cache for memoization, allowing storage and retrieval of computed values.
+ *
+ * @template K - The type of keys used to store values in the cache.
+ * @template V - The type of values stored in the cache.
+ */
 interface MemoizeCache<K, V> {
+    /**
+     * Stores a value in the cache with the specified key.
+     *
+     * @param key - The key to associate with the value.
+     * @param value - The value to store in the cache.
+     */
     set(key: K, value: V): void;
+    /**
+     * Retrieves a value from the cache by its key.
+     *
+     * @param key - The key of the value to retrieve.
+     * @returns The value associated with the key, or undefined if the key does not exist.
+     */
     get(key: K): V | undefined;
+    /**
+     * Checks if a value exists in the cache for the specified key.
+     *
+     * @param key - The key to check for existence in the cache.
+     * @returns True if the cache contains the key, false otherwise.
+     */
     has(key: K): boolean;
+    /**
+     * Deletes a value from the cache by its key.
+     *
+     * @param key - The key of the value to delete.
+     * @returns True if the value was successfully deleted, false otherwise.
+     */
     delete(key: K): boolean | void;
+    /**
+     * Clears all values from the cache.
+     */
     clear(): void;
+    /**
+     * The number of entries in the cache.
+     */
     size: number;
 }
 

package/dist/function/memoize.d.ts

@@ -16,7 +16,7 @@
  * @param {MemoizeCache<any, V>} [options.cache] - The cache object used to store results. Defaults to a new `Map`.
  * @param {(args: A) => unknown} [options.getCacheKey] - An optional function to generate a unique cache key for each argument.
  *
- * @returns {F & { cache: MemoizeCache<any, ReturnType<F>> }} - The memoized function with an additional `cache` property that exposes the internal cache.
+ * @returns The memoized function with an additional `cache` property that exposes the internal cache.
  *
  * @example
  * // Example using the default cache
@@ -76,12 +76,48 @@ declare function memoize<F extends (...args: any) => any>(fn: F, options?: {
 }): F & {
     cache: MemoizeCache<any, ReturnType<F>>;
 };
+/**
+ * Represents a cache for memoization, allowing storage and retrieval of computed values.
+ *
+ * @template K - The type of keys used to store values in the cache.
+ * @template V - The type of values stored in the cache.
+ */
 interface MemoizeCache<K, V> {
+    /**
+     * Stores a value in the cache with the specified key.
+     *
+     * @param key - The key to associate with the value.
+     * @param value - The value to store in the cache.
+     */
     set(key: K, value: V): void;
+    /**
+     * Retrieves a value from the cache by its key.
+     *
+     * @param key - The key of the value to retrieve.
+     * @returns The value associated with the key, or undefined if the key does not exist.
+     */
     get(key: K): V | undefined;
+    /**
+     * Checks if a value exists in the cache for the specified key.
+     *
+     * @param key - The key to check for existence in the cache.
+     * @returns True if the cache contains the key, false otherwise.
+     */
     has(key: K): boolean;
+    /**
+     * Deletes a value from the cache by its key.
+     *
+     * @param key - The key of the value to delete.
+     * @returns True if the value was successfully deleted, false otherwise.
+     */
     delete(key: K): boolean | void;
+    /**
+     * Clears all values from the cache.
+     */
     clear(): void;
+    /**
+     * The number of entries in the cache.
+     */
     size: number;
 }
 

package/dist/index.js

@@ -2,13 +2,13 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const initial = require('./_chunk/initial-crEecP.js');
+const initial = require('./_chunk/initial-CMlK06.js');
 const array_index = require('./array/index.js');
 const promise_index = require('./_chunk/index-BGZDR9.js');
-const rest = require('./_chunk/rest-Bzm2XK.js');
+const rest = require('./_chunk/rest-CXB7TJ.js');
 const function_index = require('./function/index.js');
 const math_index = require('./math/index.js');
-const randomInt = require('./_chunk/randomInt-CF7bZK.js');
+const randomInt = require('./_chunk/randomInt-DJFj2K.js');
 const toMerged = require('./_chunk/toMerged-DN1PPP.js');
 const object_index = require('./object/index.js');
 const isWeakSet = require('./_chunk/isWeakSet-CogETi.js');

package/dist/math/clamp.d.mts

@@ -1,8 +1,21 @@
+/**
+ * Clamps a number within the inclusive upper bound.
+ *
+ * This function takes a number and a maximum bound, and returns the number clamped within the specified upper bound.
+ * If only one bound is provided, it returns the minimum of the value and the bound.
+ *
+ * @param {number} value - The number to clamp.
+ * @param {number} maximum - The maximum bound to clamp the number.
+ * @returns {number} The clamped number within the specified upper bound.
+ *
+ * @example
+ * const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5
+ */
+declare function clamp(value: number, maximum: number): number;
 /**
  * Clamps a number within the inclusive lower and upper bounds.
  *
  * This function takes a number and two bounds, and returns the number clamped within the specified bounds.
- * If only one bound is provided, it returns the minimum of the value and the bound.
  *
  * @param {number} value - The number to clamp.
  * @param {number} minimum - The minimum bound to clamp the number.
@@ -10,12 +23,10 @@
  * @returns {number} The clamped number within the specified bounds.
  *
  * @example
- * const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5
  * const result2 = clamp(10, 5, 15); // result2 will be 10, as it is within the bounds 5 and 15
  * const result3 = clamp(2, 5, 15); // result3 will be 5, as 2 is clamped to the lower bound 5
  * const result4 = clamp(20, 5, 15); // result4 will be 15, as 20 is clamped to the upper bound 15
  */
-declare function clamp(value: number, maximum: number): number;
 declare function clamp(value: number, minimum: number, maximum: number): number;
 
 export { clamp };

package/dist/math/clamp.d.ts

@@ -1,8 +1,21 @@
+/**
+ * Clamps a number within the inclusive upper bound.
+ *
+ * This function takes a number and a maximum bound, and returns the number clamped within the specified upper bound.
+ * If only one bound is provided, it returns the minimum of the value and the bound.
+ *
+ * @param {number} value - The number to clamp.
+ * @param {number} maximum - The maximum bound to clamp the number.
+ * @returns {number} The clamped number within the specified upper bound.
+ *
+ * @example
+ * const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5
+ */
+declare function clamp(value: number, maximum: number): number;
 /**
  * Clamps a number within the inclusive lower and upper bounds.
  *
  * This function takes a number and two bounds, and returns the number clamped within the specified bounds.
- * If only one bound is provided, it returns the minimum of the value and the bound.
  *
  * @param {number} value - The number to clamp.
  * @param {number} minimum - The minimum bound to clamp the number.
@@ -10,12 +23,10 @@
  * @returns {number} The clamped number within the specified bounds.
  *
  * @example
- * const result1 = clamp(10, 5); // result1 will be 5, as 10 is clamped to the bound 5
  * const result2 = clamp(10, 5, 15); // result2 will be 10, as it is within the bounds 5 and 15
  * const result3 = clamp(2, 5, 15); // result3 will be 5, as 2 is clamped to the lower bound 5
  * const result4 = clamp(20, 5, 15); // result4 will be 15, as 20 is clamped to the upper bound 15
  */
-declare function clamp(value: number, maximum: number): number;
 declare function clamp(value: number, minimum: number, maximum: number): number;
 
 export { clamp };

package/dist/math/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const randomInt = require('../_chunk/randomInt-CF7bZK.js');
+const randomInt = require('../_chunk/randomInt-DJFj2K.js');
 
 function clamp(value, bound1, bound2) {
     if (bound2 == null) {

package/dist/math/random.d.mts

@@ -3,6 +3,18 @@
  *
  * If only one argument is provided, a number between `0` and the given number is returned.
  *
+ * @param {number} maximum - The upper bound (exclusive).
+ * @returns {number} A random number between 0 (inclusive) and maximum (exclusive). The number can be an integer or a decimal.
+ * @throws {Error} Throws an error if `maximum` is not greater than `0`.
+ *
+ * @example
+ * const result1 = random(5); // Returns a random number between 0 and 5.
+ * const result2 = random(0); // Returns a random number between 0 and 0 (which is 0).
+ */
+declare function random(maximum: number): number;
+/**
+ * Generate a random number within the given range.
+ *
  * @param {number} minimum - The lower bound (inclusive).
  * @param {number} maximum - The upper bound (exclusive).
  * @returns {number} A random number between minimum (inclusive) and maximum (exclusive). The number can be an integer or a decimal.
@@ -10,10 +22,9 @@
  *
  * @example
  * const result1 = random(0, 5); // Returns a random number between 0 and 5.
- * const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown
+ * const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown.
  * const result3 = random(5, 5); // If the minimum is equal to the maximum, an error is thrown.
  */
-declare function random(maximum: number): number;
 declare function random(minimum: number, maximum: number): number;
 
 export { random };

package/dist/math/random.d.ts

@@ -3,6 +3,18 @@
  *
  * If only one argument is provided, a number between `0` and the given number is returned.
  *
+ * @param {number} maximum - The upper bound (exclusive).
+ * @returns {number} A random number between 0 (inclusive) and maximum (exclusive). The number can be an integer or a decimal.
+ * @throws {Error} Throws an error if `maximum` is not greater than `0`.
+ *
+ * @example
+ * const result1 = random(5); // Returns a random number between 0 and 5.
+ * const result2 = random(0); // Returns a random number between 0 and 0 (which is 0).
+ */
+declare function random(maximum: number): number;
+/**
+ * Generate a random number within the given range.
+ *
  * @param {number} minimum - The lower bound (inclusive).
  * @param {number} maximum - The upper bound (exclusive).
  * @returns {number} A random number between minimum (inclusive) and maximum (exclusive). The number can be an integer or a decimal.
@@ -10,10 +22,9 @@
  *
  * @example
  * const result1 = random(0, 5); // Returns a random number between 0 and 5.
- * const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown
+ * const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown.
  * const result3 = random(5, 5); // If the minimum is equal to the maximum, an error is thrown.
  */
-declare function random(maximum: number): number;
 declare function random(minimum: number, maximum: number): number;
 
 export { random };

package/dist/math/random.mjs

@@ -4,7 +4,7 @@ function random(minimum, maximum) {
         minimum = 0;
     }
     if (minimum >= maximum) {
-        throw new Error('Invalid input: The maximum value must be greater than the minimum value.');
+        throw new Error("Invalid input: The maximum value must be greater than the minimum value.");
     }
     return Math.random() * (maximum - minimum) + minimum;
 }

package/dist/math/randomInt.d.mts

@@ -1,7 +1,16 @@
 /**
- * Generates a random integer between minimum (inclusive) and maximum (exclusive).
+ * Generates a random integer between 0 (inclusive) and the given maximum (exclusive).
  *
- * If only one argument is provided, a number between `0` and the given number is returned.
+ * @param {number} maximum - The upper bound (exclusive).
+ * @returns {number} A random integer between 0 (inclusive) and maximum (exclusive).
+ * @throws {Error} Throws an error if `maximum` is not greater than `0`.
+ *
+ * @example
+ * const result = randomInt(5); // result will be a random integer between 0 (inclusive) and 5 (exclusive)
+ */
+declare function randomInt(maximum: number): number;
+/**
+ * Generates a random integer between minimum (inclusive) and maximum (exclusive).
  *
  * @param {number} minimum - The lower bound (inclusive).
  * @param {number} maximum - The upper bound (exclusive).
@@ -12,7 +21,6 @@
  * const result = randomInt(0, 5); // result will be a random integer between 0 (inclusive) and 5 (exclusive)
  * const result2 = randomInt(5, 0); // This will throw an error
  */
-declare function randomInt(maximum: number): number;
 declare function randomInt(minimum: number, maximum: number): number;
 
 export { randomInt };

package/dist/math/randomInt.d.ts

@@ -1,7 +1,16 @@
 /**
- * Generates a random integer between minimum (inclusive) and maximum (exclusive).
+ * Generates a random integer between 0 (inclusive) and the given maximum (exclusive).
  *
- * If only one argument is provided, a number between `0` and the given number is returned.
+ * @param {number} maximum - The upper bound (exclusive).
+ * @returns {number} A random integer between 0 (inclusive) and maximum (exclusive).
+ * @throws {Error} Throws an error if `maximum` is not greater than `0`.
+ *
+ * @example
+ * const result = randomInt(5); // result will be a random integer between 0 (inclusive) and 5 (exclusive)
+ */
+declare function randomInt(maximum: number): number;
+/**
+ * Generates a random integer between minimum (inclusive) and maximum (exclusive).
  *
  * @param {number} minimum - The lower bound (inclusive).
  * @param {number} maximum - The upper bound (exclusive).
@@ -12,7 +21,6 @@
  * const result = randomInt(0, 5); // result will be a random integer between 0 (inclusive) and 5 (exclusive)
  * const result2 = randomInt(5, 0); // This will throw an error
  */
-declare function randomInt(maximum: number): number;
 declare function randomInt(minimum: number, maximum: number): number;
 
 export { randomInt };

package/dist/math/range.d.mts

@@ -25,7 +25,32 @@
  * range(1, 4, 0);
  */
 declare function range(end: number): number[];
+/**
+ * Returns an array of numbers from `start` to `end`, incrementing by `step`.
+ *
+ * If `step` is not provided, it defaults to `1`.
+ *
+ * @param {number} start - The starting number of the range (inclusive).
+ * @param {number} end - The end number of the range (exclusive).
+ * @returns {number[]} An array of numbers from `start` to `end` with the specified `step`.
+ *
+ * @example
+ * // Returns [1, 2, 3]
+ * range(1, 4);
+ */
 declare function range(start: number, end: number): number[];
+/**
+ * Returns an array of numbers from `start` to `end`, incrementing by `step`.
+ *
+ * @param {number} start - The starting number of the range (inclusive).
+ * @param {number} end - The end number of the range (exclusive).
+ * @param {number} step - The step value for the range.
+ * @returns {number[]} An array of numbers from `start` to `end` with the specified `step`.
+ *
+ * @example
+ * // Returns [0, 5, 10, 15]
+ * range(0, 20, 5);
+ */
 declare function range(start: number, end: number, step: number): number[];
 
 export { range };

package/dist/math/range.d.ts

@@ -25,7 +25,32 @@
  * range(1, 4, 0);
  */
 declare function range(end: number): number[];
+/**
+ * Returns an array of numbers from `start` to `end`, incrementing by `step`.
+ *
+ * If `step` is not provided, it defaults to `1`.
+ *
+ * @param {number} start - The starting number of the range (inclusive).
+ * @param {number} end - The end number of the range (exclusive).
+ * @returns {number[]} An array of numbers from `start` to `end` with the specified `step`.
+ *
+ * @example
+ * // Returns [1, 2, 3]
+ * range(1, 4);
+ */
 declare function range(start: number, end: number): number[];
+/**
+ * Returns an array of numbers from `start` to `end`, incrementing by `step`.
+ *
+ * @param {number} start - The starting number of the range (inclusive).
+ * @param {number} end - The end number of the range (exclusive).
+ * @param {number} step - The step value for the range.
+ * @returns {number[]} An array of numbers from `start` to `end` with the specified `step`.
+ *
+ * @example
+ * // Returns [0, 5, 10, 15]
+ * range(0, 20, 5);
+ */
 declare function range(start: number, end: number, step: number): number[];
 
 export { range };