@ls-stack/utils 2.14.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,7 +126,7 @@ 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);
     }
@@ -137,10 +137,10 @@ function createCache({
       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?.rejectWhen?.(value)) {
+        if (options?.skipCachingWhen?.(value)) {
           return value;
         }
         const unwrappedValue = unwrapValue(value, now);
@@ -166,14 +166,14 @@ 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?.rejectWhen?.(result)) {
+        if (options?.skipCachingWhen?.(result)) {
           const cacheValue = cache.get(cacheKey);
           if (cacheValue?.value === promise) {
             cache.delete(cacheKey);
@@ -223,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);
@@ -253,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.
@@ -49,11 +49,11 @@ type GetOptions<T> = {
      * @param value The value to check
      * @returns true if the value should be rejected, false otherwise
      */
-    rejectWhen?: (value: T) => boolean;
+    skipCachingWhen?: (value: T) => boolean;
 };
 type Cache<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>;
+    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;
@@ -69,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.
@@ -49,11 +49,11 @@ type GetOptions<T> = {
      * @param value The value to check
      * @returns true if the value should be rejected, false otherwise
      */
-    rejectWhen?: (value: T) => boolean;
+    skipCachingWhen?: (value: T) => boolean;
 };
 type Cache<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>;
+    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;
@@ -69,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,7 +82,7 @@ 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);
     }
@@ -93,10 +93,10 @@ function createCache({
       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?.rejectWhen?.(value)) {
+        if (options?.skipCachingWhen?.(value)) {
           return value;
         }
         const unwrappedValue = unwrapValue(value, now);
@@ -122,14 +122,14 @@ 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?.rejectWhen?.(result)) {
+        if (options?.skipCachingWhen?.(result)) {
           const cacheValue = cache.get(cacheKey);
           if (cacheValue?.value === promise) {
             cache.delete(cacheKey);
@@ -179,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);
@@ -208,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.14.0",
+  "version": "2.14.1",
   "license": "MIT",
   "files": [
     "dist"