@ztimson/utils 0.27.8 → 0.27.10

package/dist/cache.d.ts

@@ -38,6 +38,7 @@ export declare class Cache<K extends string | number | symbol, T> {
      */
     constructor(key?: keyof T | undefined, options?: CacheOptions);
     private getKey;
+    /** Save item to storage */
     private save;
     private clearTimer;
     private touchLRU;
@@ -48,72 +49,30 @@ export declare class Cache<K extends string | number | symbol, T> {
     all(expired?: boolean): CachedValue<T>[];
     /**
      * Add a new item to the cache. Like set, but finds key automatically
-     * @param {T} value Item to add to cache
-     * @param {number | undefined} ttl Override default expiry
-     * @return {this}
      */
     add(value: T, ttl?: any): this;
     /**
      * Add several rows to the cache
-     * @param {T[]} rows Several items that will be cached using the default key
-     * @param complete Mark cache as complete & reliable, defaults to true
-     * @return {this}
      */
     addAll(rows: T[], complete?: boolean): this;
-    /**
-     * Remove all keys from cache
-     */
+    /** Remove all keys */
     clear(): this;
-    /**
-     * Delete an item from the cache
-     * @param {K} key Item's primary key
-     */
+    /** Delete a cached item */
     delete(key: K): this;
-    /**
-     * Return cache as an array of key-value pairs
-     * @return {[K, T][]} Key-value pairs array
-     */
+    /** Return entries as array */
     entries(expired?: boolean): [K, CachedValue<T>][];
-    /**
-     * Manually expire a cached item
-     * @param {K} key Key to expire
-     */
+    /** Manually expire a cached item */
     expire(key: K): this;
-    /**
-     * Find the first cached item to match a filter
-     * @param {Partial<T>} filter Partial item to match
-     * @param {Boolean} expired Include expired items, defaults to false
-     * @returns {T | undefined} Cached item or undefined if nothing matched
-     */
+    /** Find first matching item */
     find(filter: Partial<T>, expired?: boolean): T | undefined;
-    /**
-     * Get item from the cache
-     * @param {K} key Key to lookup
-     * @param expired Include expired items
-     * @return {T} Cached item
-     */
+    /** Get cached item by key */
     get(key: K, expired?: boolean): CachedValue<T> | null;
-    /**
-     * Get a list of cached keys
-     * @return {K[]} Array of keys
-     */
+    /** Return list of keys */
     keys(expired?: boolean): K[];
-    /**
-     * Get map of cached items
-     * @return {Record<K, T>}
-     */
+    /** Return map of key → item */
     map(expired?: boolean): Record<K, CachedValue<T>>;
-    /**
-     * Add an item to the cache manually specifying the key
-     * @param {K} key Key item will be cached under
-     * @param {T} value Item to cache
-     * @param {number | undefined} ttl Override default expiry in seconds
-     * @return {this}
-     */
+    /** Add item manually specifying the key */
     set(key: K, value: T, ttl?: number | undefined): this;
-    /**
-     * Get all cached items
-     * @return {T[]} Array of items
-     */
+    /** Get all cached items */
     values: (expired?: boolean) => CachedValue<T>[];
 }

package/dist/index.cjs

@@ -121,6 +121,27 @@ ${opts.message || this.desc}`;
 `;
     }
   }
+  function JSONAttemptParse(json, fallback) {
+    try {
+      return JSON.parse(json);
+    } catch {
+      return fallback ?? json;
+    }
+  }
+  function JSONSerialize(obj) {
+    if (typeof obj == "object" && obj != null) return JSONSanitize(obj);
+    return obj;
+  }
+  function JSONSanitize(obj, space) {
+    const cache = [];
+    return JSON.stringify(obj, (key, value) => {
+      if (typeof value === "object" && value !== null) {
+        if (cache.includes(value)) return "[Circular]";
+        cache.push(value);
+      }
+      return value;
+    }, space);
+  }
   function applyDeltas(base, ...deltas) {
     function applyDelta(base2, delta) {
       if (delta === null) return null;
@@ -165,6 +186,9 @@ ${opts.message || this.desc}`;
     return obj;
   }
   function deepCopy(value) {
+    if (value == null) return value;
+    const t = typeof value;
+    if (t === "string" || t === "number" || t === "boolean" || t === "function") return value;
     try {
       return structuredClone(value);
     } catch {
@@ -274,27 +298,6 @@ ${opts.message || this.desc}`;
   function objectMap(obj, fn2) {
     return Object.entries(obj).map(([key, value]) => [key, fn2(key, value)]).reduce((acc, [key, value]) => ({ ...acc, [key]: value }), {});
   }
-  function JSONAttemptParse(json) {
-    try {
-      return JSON.parse(json);
-    } catch {
-      return json;
-    }
-  }
-  function JSONSerialize(obj) {
-    if (typeof obj == "object" && obj != null) return JSONSanitize(obj);
-    return obj;
-  }
-  function JSONSanitize(obj, space) {
-    const cache = [];
-    return JSON.stringify(obj, (key, value) => {
-      if (typeof value === "object" && value !== null) {
-        if (cache.includes(value)) return "[Circular]";
-        cache.push(value);
-      }
-      return value;
-    }, space);
-  }
   class ASet extends Array {
     /** Number of elements in set */
     get size() {
@@ -467,10 +470,7 @@ ${opts.message || this.desc}`;
       __publicField(this, "complete", false);
       /** Await initial loading */
       __publicField(this, "loading", new Promise((r) => this._loading = r));
-      /**
-       * Get all cached items
-       * @return {T[]} Array of items
-       */
+      /** Get all cached items */
       __publicField(this, "values", this.all);
       var _a, _b, _c, _d;
       this.key = key;
@@ -518,6 +518,7 @@ ${opts.message || this.desc}`;
       if (value[this.key] === void 0) throw new Error(`${this.key.toString()} Doesn't exist on ${JSON.stringify(value, null, 2)}`);
       return value[this.key];
     }
+    /** Save item to storage */
     save(key) {
       var _a, _b;
       const persists = this.options.persistentStorage;
@@ -571,9 +572,6 @@ ${opts.message || this.desc}`;
     }
     /**
      * Add a new item to the cache. Like set, but finds key automatically
-     * @param {T} value Item to add to cache
-     * @param {number | undefined} ttl Override default expiry
-     * @return {this}
      */
     add(value, ttl = this.ttl) {
       const key = this.getKey(value);
@@ -582,9 +580,6 @@ ${opts.message || this.desc}`;
     }
     /**
      * Add several rows to the cache
-     * @param {T[]} rows Several items that will be cached using the default key
-     * @param complete Mark cache as complete & reliable, defaults to true
-     * @return {this}
      */
     addAll(rows, complete = true) {
       this.clear();
@@ -592,9 +587,7 @@ ${opts.message || this.desc}`;
       this.complete = complete;
       return this;
     }
-    /**
-     * Remove all keys from cache
-     */
+    /** Remove all keys */
     clear() {
       this.complete = false;
       for (const [k, t] of this.timers) clearTimeout(t);
@@ -604,10 +597,7 @@ ${opts.message || this.desc}`;
       this.save();
       return this;
     }
-    /**
-     * Delete an item from the cache
-     * @param {K} key Item's primary key
-     */
+    /** Delete a cached item */
     delete(key) {
       this.clearTimer(key);
       const idx = this.lruOrder.indexOf(key);
@@ -616,10 +606,7 @@ ${opts.message || this.desc}`;
       this.save(key);
       return this;
     }
-    /**
-     * Return cache as an array of key-value pairs
-     * @return {[K, T][]} Key-value pairs array
-     */
+    /** Return entries as array */
     entries(expired) {
       const out = [];
       for (const [k, v] of this.store.entries()) {
@@ -628,10 +615,7 @@ ${opts.message || this.desc}`;
       }
       return out;
     }
-    /**
-     * Manually expire a cached item
-     * @param {K} key Key to expire
-     */
+    /** Manually expire a cached item */
     expire(key) {
       this.complete = false;
       if (this.options.expiryPolicy == "keep") {
@@ -644,12 +628,7 @@ ${opts.message || this.desc}`;
       } else this.delete(key);
       return this;
     }
-    /**
-     * Find the first cached item to match a filter
-     * @param {Partial<T>} filter Partial item to match
-     * @param {Boolean} expired Include expired items, defaults to false
-     * @returns {T | undefined} Cached item or undefined if nothing matched
-     */
+    /** Find first matching item */
     find(filter, expired) {
       for (const v of this.store.values()) {
         const row = v;
@@ -657,24 +636,16 @@ ${opts.message || this.desc}`;
       }
       return void 0;
     }
-    /**
-     * Get item from the cache
-     * @param {K} key Key to lookup
-     * @param expired Include expired items
-     * @return {T} Cached item
-     */
+    /** Get cached item by key */
     get(key, expired) {
       const raw = this.store.get(key);
       if (raw == null) return null;
-      const cached = deepCopy(raw);
       this.touchLRU(key);
-      if (expired || !(cached == null ? void 0 : cached._expired)) return cached;
+      const isExpired = raw == null ? void 0 : raw._expired;
+      if (expired || !isExpired) return deepCopy(raw);
       return null;
     }
-    /**
-     * Get a list of cached keys
-     * @return {K[]} Array of keys
-     */
+    /** Return list of keys */
     keys(expired) {
       const out = [];
       for (const [k, v] of this.store.entries()) {
@@ -683,10 +654,7 @@ ${opts.message || this.desc}`;
       }
       return out;
     }
-    /**
-     * Get map of cached items
-     * @return {Record<K, T>}
-     */
+    /** Return map of key → item */
     map(expired) {
       const copy = {};
       for (const [k, v] of this.store.entries()) {
@@ -695,13 +663,7 @@ ${opts.message || this.desc}`;
       }
       return copy;
     }
-    /**
-     * Add an item to the cache manually specifying the key
-     * @param {K} key Key item will be cached under
-     * @param {T} value Item to cache
-     * @param {number | undefined} ttl Override default expiry in seconds
-     * @return {this}
-     */
+    /** Add item manually specifying the key */
     set(key, value, ttl = this.options.ttl) {
       if (this.options.expiryPolicy == "keep") delete value._expired;
       this.clearTimer(key);
@@ -712,7 +674,7 @@ ${opts.message || this.desc}`;
         const t = setTimeout(() => {
           this.expire(key);
           this.save(key);
-        }, (ttl || 0) * 1e3);
+        }, ttl * 1e3);
         this.timers.set(key, t);
       }
       return this;
@@ -2426,7 +2388,7 @@ ${opts.message || this.desc}`;
     }
   }
   memoryStorage.MemoryStorage = MemoryStorage;
-  (function(exports3) {
+  (function(exports$1) {
     var __createBinding = commonjsGlobal && commonjsGlobal.__createBinding || (Object.create ? function(o, m, k, k2) {
       if (k2 === void 0) k2 = k;
       var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -2440,12 +2402,12 @@ ${opts.message || this.desc}`;
       if (k2 === void 0) k2 = k;
       o[k2] = m[k];
     });
-    var __exportStar = commonjsGlobal && commonjsGlobal.__exportStar || function(m, exports4) {
-      for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports4, p)) __createBinding(exports4, m, p);
+    var __exportStar = commonjsGlobal && commonjsGlobal.__exportStar || function(m, exports$12) {
+      for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports$12, p)) __createBinding(exports$12, m, p);
     };
-    Object.defineProperty(exports3, "__esModule", { value: true });
-    __exportStar(persist$1, exports3);
-    __exportStar(memoryStorage, exports3);
+    Object.defineProperty(exports$1, "__esModule", { value: true });
+    __exportStar(persist$1, exports$1);
+    __exportStar(memoryStorage, exports$1);
   })(dist);
   exports2.ASet = ASet;
   exports2.ArgParser = ArgParser;