es-toolkit 1.47.0-dev.1840 → 1.47.0-dev.1842

package/dist/function/memoize.d.mts

@@ -12,10 +12,10 @@
  * `getCacheKey` function to generate a unique cache key for proper caching.
  *
  * @template F - The type of the function to be memoized.
- * @param {F} fn - The function to be memoized. It should accept a single argument and return a value.
- * @param {MemoizeOptions<Parameters<F>[0], ReturnType<F>>} [options={}] - Optional configuration for the memoization.
- * @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.
+ * @param fn - The function to be memoized. It should accept a single argument and return a value.
+ * @param [options={}] - Optional configuration for the memoization.
+ * @param [options.cache] - The cache object used to store results. Defaults to a new `Map`.
+ * @param [options.getCacheKey] - An optional function to generate a unique cache key for each argument.
  *
  * @returns The memoized function with an additional `cache` property that exposes the internal cache.
  *

package/dist/function/memoize.d.ts

@@ -12,10 +12,10 @@
  * `getCacheKey` function to generate a unique cache key for proper caching.
  *
  * @template F - The type of the function to be memoized.
- * @param {F} fn - The function to be memoized. It should accept a single argument and return a value.
- * @param {MemoizeOptions<Parameters<F>[0], ReturnType<F>>} [options={}] - Optional configuration for the memoization.
- * @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.
+ * @param fn - The function to be memoized. It should accept a single argument and return a value.
+ * @param [options={}] - Optional configuration for the memoization.
+ * @param [options.cache] - The cache object used to store results. Defaults to a new `Map`.
+ * @param [options.getCacheKey] - An optional function to generate a unique cache key for each argument.
  *
  * @returns The memoized function with an additional `cache` property that exposes the internal cache.
  *

package/dist/function/memoize.js

@@ -12,10 +12,10 @@
 * `getCacheKey` function to generate a unique cache key for proper caching.
 *
 * @template F - The type of the function to be memoized.
-* @param {F} fn - The function to be memoized. It should accept a single argument and return a value.
-* @param {MemoizeOptions<Parameters<F>[0], ReturnType<F>>} [options={}] - Optional configuration for the memoization.
-* @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.
+* @param fn - The function to be memoized. It should accept a single argument and return a value.
+* @param [options={}] - Optional configuration for the memoization.
+* @param [options.cache] - The cache object used to store results. Defaults to a new `Map`.
+* @param [options.getCacheKey] - An optional function to generate a unique cache key for each argument.
 *
 * @returns The memoized function with an additional `cache` property that exposes the internal cache.
 *

package/dist/function/memoize.mjs

@@ -12,10 +12,10 @@
 * `getCacheKey` function to generate a unique cache key for proper caching.
 *
 * @template F - The type of the function to be memoized.
-* @param {F} fn - The function to be memoized. It should accept a single argument and return a value.
-* @param {MemoizeOptions<Parameters<F>[0], ReturnType<F>>} [options={}] - Optional configuration for the memoization.
-* @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.
+* @param fn - The function to be memoized. It should accept a single argument and return a value.
+* @param [options={}] - Optional configuration for the memoization.
+* @param [options.cache] - The cache object used to store results. Defaults to a new `Map`.
+* @param [options.getCacheKey] - An optional function to generate a unique cache key for each argument.
 *
 * @returns The memoized function with an additional `cache` property that exposes the internal cache.
 *

package/dist/function/negate.d.mts

@@ -3,8 +3,8 @@
  * Creates a function that negates the result of the predicate function.
  *
  * @template F - The type of the function to negate.
- * @param {F} func - The function to negate.
- * @returns {F} The new negated function, which negates the boolean result of `func`.
+ * @param func - The function to negate.
+ * @returns The new negated function, which negates the boolean result of `func`.
  *
  * @example
  * const array = [1, 2, 3, 4, 5, 6];

package/dist/function/negate.d.ts

@@ -3,8 +3,8 @@
  * Creates a function that negates the result of the predicate function.
  *
  * @template F - The type of the function to negate.
- * @param {F} func - The function to negate.
- * @returns {F} The new negated function, which negates the boolean result of `func`.
+ * @param func - The function to negate.
+ * @returns The new negated function, which negates the boolean result of `func`.
  *
  * @example
  * const array = [1, 2, 3, 4, 5, 6];

package/dist/function/negate.js

@@ -3,8 +3,8 @@
 * Creates a function that negates the result of the predicate function.
 *
 * @template F - The type of the function to negate.
-* @param {F} func - The function to negate.
-* @returns {F} The new negated function, which negates the boolean result of `func`.
+* @param func - The function to negate.
+* @returns The new negated function, which negates the boolean result of `func`.
 *
 * @example
 * const array = [1, 2, 3, 4, 5, 6];

package/dist/function/negate.mjs

@@ -3,8 +3,8 @@
 * Creates a function that negates the result of the predicate function.
 *
 * @template F - The type of the function to negate.
-* @param {F} func - The function to negate.
-* @returns {F} The new negated function, which negates the boolean result of `func`.
+* @param func - The function to negate.
+* @returns The new negated function, which negates the boolean result of `func`.
 *
 * @example
 * const array = [1, 2, 3, 4, 5, 6];

package/dist/function/noop.d.mts

@@ -6,7 +6,7 @@
  * @example
  * noop(); // Does nothing
  *
- * @returns {void} This function does not return anything.
+ * @returns This function does not return anything.
  */
 declare function noop(): void;
 //#endregion

package/dist/function/noop.d.ts

@@ -6,7 +6,7 @@
  * @example
  * noop(); // Does nothing
  *
- * @returns {void} This function does not return anything.
+ * @returns This function does not return anything.
  */
 declare function noop(): void;
 //#endregion

package/dist/function/noop.js

@@ -6,7 +6,7 @@
 * @example
 * noop(); // Does nothing
 *
-* @returns {void} This function does not return anything.
+* @returns This function does not return anything.
 */
 function noop() {}
 //#endregion

package/dist/function/noop.mjs

@@ -6,7 +6,7 @@
 * @example
 * noop(); // Does nothing
 *
-* @returns {void} This function does not return anything.
+* @returns This function does not return anything.
 */
 function noop() {}
 //#endregion

package/dist/function/once.d.mts

@@ -3,8 +3,8 @@
  * Creates a function that is restricted to invoking func once. Repeat calls to the function return the value of the first invocation.
  *
  * @template F - The type of the function.
- * @param {F} func - The function to restrict.
- * @returns {F} Returns the new restricted function.
+ * @param func - The function to restrict.
+ * @returns Returns the new restricted function.
  *
  * @example
  * const initialize = once(createApplication);

package/dist/function/once.d.ts

@@ -3,8 +3,8 @@
  * Creates a function that is restricted to invoking func once. Repeat calls to the function return the value of the first invocation.
  *
  * @template F - The type of the function.
- * @param {F} func - The function to restrict.
- * @returns {F} Returns the new restricted function.
+ * @param func - The function to restrict.
+ * @returns Returns the new restricted function.
  *
  * @example
  * const initialize = once(createApplication);

package/dist/function/once.js

@@ -4,8 +4,8 @@
 * Repeated calls to the function will return the value from the first invocation.
 *
 * @template F - The type of function.
-* @param {F} func - The function to restrict.
-* @returns {F} A new function that invokes `func` once and caches the result.
+* @param func - The function to restrict.
+* @returns A new function that invokes `func` once and caches the result.
 *
 * @example
 * const initialize = once(() => {

package/dist/function/once.mjs

@@ -4,8 +4,8 @@
 * Repeated calls to the function will return the value from the first invocation.
 *
 * @template F - The type of function.
-* @param {F} func - The function to restrict.
-* @returns {F} A new function that invokes `func` once and caches the result.
+* @param func - The function to restrict.
+* @returns A new function that invokes `func` once and caches the result.
 *
 * @example
 * const initialize = once(() => {