@ls-stack/utils 2.13.0 → 2.14.0

package/dist/cache.cjs

@@ -132,7 +132,7 @@ function createCache({
     }
   };
   return {
-    getOrInsert(cacheKey, val) {
+    getOrInsert(cacheKey, val, options) {
       const now = Date.now();
       const entry = cache.get(cacheKey);
       if (!entry || isExpired(entry, now)) {
@@ -140,6 +140,9 @@ function createCache({
         if (value instanceof RejectValue) {
           return value.value;
         }
+        if (options?.rejectWhen?.(value)) {
+          return value;
+        }
         const unwrappedValue = unwrapValue(value, now);
         cache.set(cacheKey, unwrappedValue);
         trimToSize();
@@ -153,7 +156,7 @@ function createCache({
       }
       return entry.value;
     },
-    async getOrInsertAsync(cacheKey, val) {
+    async getOrInsertAsync(cacheKey, val, options) {
       const entry = cache.get(cacheKey);
       if (entry && isPromise(entry.value)) {
         return entry.value;
@@ -170,6 +173,13 @@ function createCache({
           }
           return result.value;
         }
+        if (options?.rejectWhen?.(result)) {
+          const cacheValue = cache.get(cacheKey);
+          if (cacheValue?.value === promise) {
+            cache.delete(cacheKey);
+          }
+          return result;
+        }
         const unwrappedValue = unwrapValue(result, Date.now());
         cache.set(cacheKey, unwrappedValue);
         return unwrappedValue.value;

package/dist/cache.d.cts

@@ -42,9 +42,18 @@ type Utils<T> = {
      */
     withExpiration: (value: T, expiration: DurationObj) => WithExpiration<T>;
 };
+type GetOptions<T> = {
+    /**
+     * A function that determines whether a value should be rejected from being cached.
+     * If the function returns true, the value will be returned but not cached.
+     * @param value The value to check
+     * @returns true if the value should be rejected, false otherwise
+     */
+    rejectWhen?: (value: T) => boolean;
+};
 type Cache<T> = {
-    getOrInsert: (cacheKey: string, val: (utils: Utils<T>) => T | RejectValue<T>) => T;
-    getOrInsertAsync: (cacheKey: string, val: (utils: Utils<T>) => Promise<T | RejectValue<T>>) => Promise<T>;
+    getOrInsert: (cacheKey: string, val: (utils: Utils<T>) => T | RejectValue<T>, options?: GetOptions<T>) => T;
+    getOrInsertAsync: (cacheKey: string, val: (utils: Utils<T>) => Promise<T | RejectValue<T>>, options?: GetOptions<T>) => Promise<T>;
     clear: () => void;
     get: (cacheKey: string) => T | undefined;
     set: (cacheKey: string, value: T | WithExpiration<T>) => void;

package/dist/cache.d.ts

@@ -42,9 +42,18 @@ type Utils<T> = {
      */
     withExpiration: (value: T, expiration: DurationObj) => WithExpiration<T>;
 };
+type GetOptions<T> = {
+    /**
+     * A function that determines whether a value should be rejected from being cached.
+     * If the function returns true, the value will be returned but not cached.
+     * @param value The value to check
+     * @returns true if the value should be rejected, false otherwise
+     */
+    rejectWhen?: (value: T) => boolean;
+};
 type Cache<T> = {
-    getOrInsert: (cacheKey: string, val: (utils: Utils<T>) => T | RejectValue<T>) => T;
-    getOrInsertAsync: (cacheKey: string, val: (utils: Utils<T>) => Promise<T | RejectValue<T>>) => Promise<T>;
+    getOrInsert: (cacheKey: string, val: (utils: Utils<T>) => T | RejectValue<T>, options?: GetOptions<T>) => T;
+    getOrInsertAsync: (cacheKey: string, val: (utils: Utils<T>) => Promise<T | RejectValue<T>>, options?: GetOptions<T>) => Promise<T>;
     clear: () => void;
     get: (cacheKey: string) => T | undefined;
     set: (cacheKey: string, value: T | WithExpiration<T>) => void;

package/dist/cache.js

@@ -88,7 +88,7 @@ function createCache({
     }
   };
   return {
-    getOrInsert(cacheKey, val) {
+    getOrInsert(cacheKey, val, options) {
       const now = Date.now();
       const entry = cache.get(cacheKey);
       if (!entry || isExpired(entry, now)) {
@@ -96,6 +96,9 @@ function createCache({
         if (value instanceof RejectValue) {
           return value.value;
         }
+        if (options?.rejectWhen?.(value)) {
+          return value;
+        }
         const unwrappedValue = unwrapValue(value, now);
         cache.set(cacheKey, unwrappedValue);
         trimToSize();
@@ -109,7 +112,7 @@ function createCache({
       }
       return entry.value;
     },
-    async getOrInsertAsync(cacheKey, val) {
+    async getOrInsertAsync(cacheKey, val, options) {
       const entry = cache.get(cacheKey);
       if (entry && isPromise(entry.value)) {
         return entry.value;
@@ -126,6 +129,13 @@ function createCache({
           }
           return result.value;
         }
+        if (options?.rejectWhen?.(result)) {
+          const cacheValue = cache.get(cacheKey);
+          if (cacheValue?.value === promise) {
+            cache.delete(cacheKey);
+          }
+          return result;
+        }
         const unwrappedValue = unwrapValue(result, Date.now());
         cache.set(cacheKey, unwrappedValue);
         return unwrappedValue.value;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ls-stack/utils",
   "description": "Typescript utils",
-  "version": "2.13.0",
+  "version": "2.14.0",
   "license": "MIT",
   "files": [
     "dist"
@@ -322,13 +322,13 @@
     }
   },
   "scripts": {
-    "test": "vitest --ui",
-    "test:run": "vitest run",
+    "test:ui": "vitest --ui",
+    "test": "vitest run",
     "lint": "pnpm tsc && pnpm eslint",
     "tsc": "tsc -p tsconfig.prod.json",
     "tsc:watch": "tsc -p tsconfig.prod.json --watch",
     "eslint": "CI=true eslint src/ scripts/ --color --max-warnings=0",
-    "build": "pnpm test:run && pnpm lint && pnpm build:no-test && pnpm build:update-exports",
+    "build": "pnpm test && pnpm lint && pnpm build:no-test && pnpm build:update-exports",
     "build:no-test": "tsup",
     "build:update-exports": "tsm --no-warnings scripts/updatePackageExports.ts",
     "build-test": "tsup --config tsup.test.config.ts",