@ls-stack/utils 2.13.0 → 2.14.1

package/dist/cache.cjs

@@ -20,7 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/cache.ts
 var cache_exports = {};
 __export(cache_exports, {
-  RejectValue: () => RejectValue,
+  SkipCaching: () => SkipCaching,
   WithExpiration: () => WithExpiration,
   cachedGetter: () => cachedGetter,
   createCache: () => createCache
@@ -61,7 +61,7 @@ function cachedGetter(getter) {
     }
   };
 }
-var RejectValue = class {
+var SkipCaching = class {
   value;
   constructor(value) {
     this.value = value;
@@ -126,20 +126,23 @@ function createCache({
     return { value, timestamp: now, expiration: void 0 };
   }
   const utils = {
-    reject: (value) => new RejectValue(value),
+    skipCaching: (value) => new SkipCaching(value),
     withExpiration: (value, expiration) => {
       return new WithExpiration(value, expiration);
     }
   };
   return {
-    getOrInsert(cacheKey, val) {
+    getOrInsert(cacheKey, val, options) {
       const now = Date.now();
       const entry = cache.get(cacheKey);
       if (!entry || isExpired(entry, now)) {
         const value = val(utils);
-        if (value instanceof RejectValue) {
+        if (value instanceof SkipCaching) {
           return value.value;
         }
+        if (options?.skipCachingWhen?.(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;
@@ -163,13 +166,20 @@ function createCache({
         return entry.value;
       }
       const promise = val(utils).then((result) => {
-        if (result instanceof RejectValue) {
+        if (result instanceof SkipCaching) {
           const cacheValue = cache.get(cacheKey);
           if (cacheValue?.value === promise) {
             cache.delete(cacheKey);
           }
           return result.value;
         }
+        if (options?.skipCachingWhen?.(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;
@@ -213,7 +223,7 @@ function createCache({
     },
     async setAsync(cacheKey, value) {
       const promise = value(utils).then((result) => {
-        if (result instanceof RejectValue) {
+        if (result instanceof SkipCaching) {
           const cacheValue = cache.get(cacheKey);
           if (cacheValue?.value === promise) {
             cache.delete(cacheKey);
@@ -243,7 +253,7 @@ function createCache({
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  RejectValue,
+  SkipCaching,
   WithExpiration,
   cachedGetter,
   createCache

package/dist/cache.d.cts

@@ -20,7 +20,7 @@ type Options = {
      */
     expirationThrottle?: number;
 };
-declare class RejectValue<T> {
+declare class SkipCaching<T> {
     value: T;
     constructor(value: T);
 }
@@ -34,7 +34,7 @@ declare class WithExpiration<T> {
     constructor(value: T, expiration: DurationObj);
 }
 type Utils<T> = {
-    reject: (value: T) => RejectValue<T>;
+    skipCaching: (value: T) => SkipCaching<T>;
     /**
      * Create a new WithExpiration object with the given value and expiration time.
      * @param value - The value to store in the cache.
@@ -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
+     */
+    skipCachingWhen?: (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 | SkipCaching<T>, options?: GetOptions<T>) => T;
+    getOrInsertAsync: (cacheKey: string, val: (utils: Utils<T>) => Promise<T | SkipCaching<T>>, options?: GetOptions<T>) => Promise<T>;
     clear: () => void;
     get: (cacheKey: string) => T | undefined;
     set: (cacheKey: string, value: T | WithExpiration<T>) => void;
@@ -60,4 +69,4 @@ type Cache<T> = {
 };
 declare function createCache<T>({ maxCacheSize, maxItemAge, expirationThrottle, }?: Options): Cache<T>;
 
-export { type Cache, RejectValue, WithExpiration, cachedGetter, createCache };
+export { type Cache, SkipCaching, WithExpiration, cachedGetter, createCache };

package/dist/cache.d.ts

@@ -20,7 +20,7 @@ type Options = {
      */
     expirationThrottle?: number;
 };
-declare class RejectValue<T> {
+declare class SkipCaching<T> {
     value: T;
     constructor(value: T);
 }
@@ -34,7 +34,7 @@ declare class WithExpiration<T> {
     constructor(value: T, expiration: DurationObj);
 }
 type Utils<T> = {
-    reject: (value: T) => RejectValue<T>;
+    skipCaching: (value: T) => SkipCaching<T>;
     /**
      * Create a new WithExpiration object with the given value and expiration time.
      * @param value - The value to store in the cache.
@@ -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
+     */
+    skipCachingWhen?: (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 | SkipCaching<T>, options?: GetOptions<T>) => T;
+    getOrInsertAsync: (cacheKey: string, val: (utils: Utils<T>) => Promise<T | SkipCaching<T>>, options?: GetOptions<T>) => Promise<T>;
     clear: () => void;
     get: (cacheKey: string) => T | undefined;
     set: (cacheKey: string, value: T | WithExpiration<T>) => void;
@@ -60,4 +69,4 @@ type Cache<T> = {
 };
 declare function createCache<T>({ maxCacheSize, maxItemAge, expirationThrottle, }?: Options): Cache<T>;
 
-export { type Cache, RejectValue, WithExpiration, cachedGetter, createCache };
+export { type Cache, SkipCaching, WithExpiration, cachedGetter, createCache };

package/dist/cache.js

@@ -17,7 +17,7 @@ function cachedGetter(getter) {
     }
   };
 }
-var RejectValue = class {
+var SkipCaching = class {
   value;
   constructor(value) {
     this.value = value;
@@ -82,20 +82,23 @@ function createCache({
     return { value, timestamp: now, expiration: void 0 };
   }
   const utils = {
-    reject: (value) => new RejectValue(value),
+    skipCaching: (value) => new SkipCaching(value),
     withExpiration: (value, expiration) => {
       return new WithExpiration(value, expiration);
     }
   };
   return {
-    getOrInsert(cacheKey, val) {
+    getOrInsert(cacheKey, val, options) {
       const now = Date.now();
       const entry = cache.get(cacheKey);
       if (!entry || isExpired(entry, now)) {
         const value = val(utils);
-        if (value instanceof RejectValue) {
+        if (value instanceof SkipCaching) {
           return value.value;
         }
+        if (options?.skipCachingWhen?.(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;
@@ -119,13 +122,20 @@ function createCache({
         return entry.value;
       }
       const promise = val(utils).then((result) => {
-        if (result instanceof RejectValue) {
+        if (result instanceof SkipCaching) {
           const cacheValue = cache.get(cacheKey);
           if (cacheValue?.value === promise) {
             cache.delete(cacheKey);
           }
           return result.value;
         }
+        if (options?.skipCachingWhen?.(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;
@@ -169,7 +179,7 @@ function createCache({
     },
     async setAsync(cacheKey, value) {
       const promise = value(utils).then((result) => {
-        if (result instanceof RejectValue) {
+        if (result instanceof SkipCaching) {
           const cacheValue = cache.get(cacheKey);
           if (cacheValue?.value === promise) {
             cache.delete(cacheKey);
@@ -198,7 +208,7 @@ function createCache({
   };
 }
 export {
-  RejectValue,
+  SkipCaching,
   WithExpiration,
   cachedGetter,
   createCache

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ls-stack/utils",
   "description": "Typescript utils",
-  "version": "2.13.0",
+  "version": "2.14.1",
   "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",