@budsbox/lib-es 2.2.0 → 2.3.0

package/dist/function.d.ts

@@ -0,0 +1,44 @@
+import type { UnknownArray } from 'type-fest';
+import type { AnyFunction } from '@budsbox/lib-types';
+/**
+ * A function that does nothing.
+ */
+export declare const noop: () => void;
+/**
+ * A function that returns its argument.
+ *
+ * @param value - The value to return.
+ * @returns The input value.
+ */
+export declare const pass: <T>(value: T) => T;
+type CacheableFn<TFn extends AnyFunction> = Parameters<TFn> extends [unknown, ...UnknownArray] ? TFn : never;
+type DefaultCacheKey<TFn extends AnyFunction> = Parameters<TFn> extends [infer TArg0, ...UnknownArray] ? TArg0 : never;
+type CachedFn<TFn extends AnyFunction, TKey = DefaultCacheKey<TFn>> = TFn extends (...args: infer TArgs) => infer TReturn ? (cacheMap: Map<TKey, TReturn>, ...args: TArgs) => TReturn : never;
+/**
+ * Creates a cached version of a given function.
+ * The returned function stores the results of previous calls in a provided cache map
+ * and returns the cached result when called with the same arguments,
+ * reducing redundant calculations or operations.
+ *
+ * @remarks A provided function has to accept at least one argument, or it fails typechecking.
+ * @param fn - The function to be cached. It must conform to the `CacheableFn` type.
+ * @returns A new function that accepts the cache map as the first argument and the original function's arguments as the rest.
+ */
+export declare function createCachedFn<TFn extends AnyFunction>(fn: CacheableFn<TFn>): CachedFn<TFn>;
+/**
+ * Creates a cached version of a given function.
+ * The returned function stores the results of previous calls in a provided cache map
+ * and returns the cached result when called with the same arguments,
+ * reducing redundant calculations or operations. The caching behavior is
+ * determined by a key generation function (`keyFn`) which computes a unique
+ * key for each set of arguments. If the same key is generated for later
+ * calls, the cached result is returned instead of invoking the original function.
+ *
+ * @remarks A provided function has to accept at least one argument, or it fails typechecking.
+ * @param fn - The function to be cached. It must conform to the `CacheableFn` type.
+ * @param keyFn - A function that generates a unique key based on the arguments passed to `fn`.
+ * @returns A new function that accepts the cache map as the first argument and the original function's arguments as the rest.
+ */
+export declare function createCachedFn<TFn extends AnyFunction, TKey>(fn: CacheableFn<TFn>, keyFn: (...args: Parameters<TFn>) => TKey): CachedFn<TFn, TKey>;
+export {};
+//# sourceMappingURL=function.d.ts.map

package/dist/function.js

@@ -0,0 +1,22 @@
+/**
+ * A function that does nothing.
+ */
+export const noop = () => { };
+/**
+ * A function that returns its argument.
+ *
+ * @param value - The value to return.
+ * @returns The input value.
+ */
+export const pass = (value) => value;
+export function createCachedFn(fn, keyFn = pass) {
+    return (map, ...args) => {
+        const key = keyFn(...args);
+        if (map.has(key))
+            return map.get(key);
+        const result = fn(...args);
+        map.set(key, result);
+        return result;
+    };
+}
+//# sourceMappingURL=function.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@budsbox/lib-es",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "homepage": "https://gitlab.com/budsbox/fe/seed",
   "bugs": {
     "url": "https://gitlab.com/budsbox/fe/seed/-/issues"
@@ -60,6 +60,16 @@
         "default": "./dist/logical.js",
         "types": "./dist/logical.d.ts"
       }
+    },
+    "#function": {
+      "import": {
+        "default": "./dist/function.js",
+        "types": "./dist/function.d.ts"
+      },
+      "require": {
+        "default": "./dist/function.js",
+        "types": "./dist/function.d.ts"
+      }
     }
   },
   "exports": {
@@ -113,6 +123,16 @@
         "types": "./dist/logical.d.ts"
       }
     },
+    "./function": {
+      "import": {
+        "default": "./dist/function.js",
+        "types": "./dist/function.d.ts"
+      },
+      "require": {
+        "default": "./dist/function.js",
+        "types": "./dist/function.d.ts"
+      }
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -124,16 +144,16 @@
     "prepack": "yarn p:ts:prepack"
   },
   "dependencies": {
-    "@budsbox/lib-types": "^1.1.0",
+    "@budsbox/lib-types": "^1.2.0",
     "@types/node": "^22.15.2",
     "tslib": "^2.8.1",
     "type-fest": "^4.32.0"
   },
   "devDependencies": {
     "@budsbox/eslint": "^1.2.0",
-    "@budsbox/eslint_presets-lib": "^1.0.3",
-    "@budsbox/eslint_presets-tools": "^1.0.3",
-    "@budsbox/tsconfigs": "^4.3.0",
+    "@budsbox/eslint_presets-lib": "^1.0.4",
+    "@budsbox/eslint_presets-tools": "^1.0.4",
+    "@budsbox/tsconfigs": "^4.3.1",
     "@eslint/js": "^9.26.0",
     "@types/eslint": "^9.6.1",
     "@typescript-eslint/parser": "^8.32.1",