@ztimson/utils 0.24.6 → 0.24.9

package/dist/cache.d.ts

@@ -5,6 +5,11 @@ export type CacheOptions = {
     storage?: Storage;
     /** Key cache will be stored under */
     storageKey?: string;
+    /** Keep or delete cached items once expired, defaults to delete */
+    expiryPolicy?: 'delete' | 'keep';
+};
+export type CachedValue<T> = T | {
+    _expired?: boolean;
 };
 /**
  * Map of data which tracks whether it is a complete collection & offers optional expiry of cached values
@@ -14,7 +19,7 @@ export declare class Cache<K extends string | number | symbol, T> {
     readonly options: CacheOptions;
     private store;
     /** Support index lookups */
-    [key: string | number | symbol]: T | any;
+    [key: string | number | symbol]: CachedValue<T> | any;
     /** Whether cache is complete */
     complete: boolean;
     /**
@@ -24,11 +29,12 @@ export declare class Cache<K extends string | number | symbol, T> {
      */
     constructor(key?: keyof T | undefined, options?: CacheOptions);
     private getKey;
+    private save;
     /**
      * Get all cached items
      * @return {T[]} Array of items
      */
-    all(): 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
@@ -56,23 +62,28 @@ export declare class Cache<K extends string | number | symbol, T> {
      * Return cache as an array of key-value pairs
      * @return {[K, T][]} Key-value pairs array
      */
-    entries(): [K, T][];
+    entries(expired?: boolean): [K, CachedValue<T>][];
+    /**
+     * Manually expire a cached item
+     * @param {K} key Key to expire
+     */
+    expire(key: K): void;
     /**
      * Get item from the cache
      * @param {K} key Key to lookup
      * @return {T} Cached item
      */
-    get(key: K): T;
+    get(key: K, expired?: boolean): T | null;
     /**
      * Get a list of cached keys
      * @return {K[]} Array of keys
      */
-    keys(): K[];
+    keys(expired?: boolean): K[];
     /**
      * Get map of cached items
      * @return {Record<K, T>}
      */
-    map(): Record<K, T>;
+    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
@@ -85,5 +96,5 @@ export declare class Cache<K extends string | number | symbol, T> {
      * Get all cached items
      * @return {T[]} Array of items
      */
-    values: T[];
+    values: CachedValue<T>[];
 }

package/dist/index.cjs

@@ -426,7 +426,7 @@ ${opts.message || this.desc}`;
       return new Proxy(this, {
         get: (target, prop) => {
           if (prop in target) return target[prop];
-          return deepCopy(target.store[prop]);
+          return this.get(prop, true);
         },
         set: (target, prop, value) => {
           if (prop in target) target[prop] = value;
@@ -439,12 +439,16 @@ ${opts.message || this.desc}`;
       if (!this.key) throw new Error("No key defined");
       return value[this.key];
     }
+    save() {
+      if (this.options.storageKey && this.options.storage)
+        this.options.storage.setItem(this.options.storageKey, JSON.stringify(this.store));
+    }
     /**
      * Get all cached items
      * @return {T[]} Array of items
      */
-    all() {
-      return deepCopy(Object.values(this.store));
+    all(expired) {
+      return deepCopy(Object.values(this.store).filter((v) => expired || !v._expired));
     }
     /**
      * Add a new item to the cache. Like set, but finds key automatically
@@ -473,6 +477,7 @@ ${opts.message || this.desc}`;
      * Remove all keys from cache
      */
     clear() {
+      this.complete = false;
       this.store = {};
     }
     /**
@@ -481,37 +486,51 @@ ${opts.message || this.desc}`;
      */
     delete(key) {
       delete this.store[key];
-      if (this.options.storageKey && this.options.storage)
-        this.options.storage.setItem(this.options.storageKey, JSON.stringify(this.store));
+      this.save();
     }
     /**
      * Return cache as an array of key-value pairs
      * @return {[K, T][]} Key-value pairs array
      */
-    entries() {
-      return Object.entries(this.store);
+    entries(expired) {
+      return deepCopy(Object.entries(this.store).filter((v) => expired || !v._expired));
+    }
+    /**
+     * Manually expire a cached item
+     * @param {K} key Key to expire
+     */
+    expire(key) {
+      this.complete = false;
+      if (this.options.expiryPolicy == "keep") this.store[key]._expired = true;
+      else this.delete(key);
     }
     /**
      * Get item from the cache
      * @param {K} key Key to lookup
      * @return {T} Cached item
      */
-    get(key) {
-      return deepCopy(this.store[key]);
+    get(key, expired) {
+      const cached = deepCopy(this.store[key] ?? null);
+      if (expired || !cached._expired) return cached;
+      return null;
     }
     /**
      * Get a list of cached keys
      * @return {K[]} Array of keys
      */
-    keys() {
-      return Object.keys(this.store);
+    keys(expired) {
+      return Object.keys(this.store).filter((k) => expired || !this.store[k]._expired);
     }
     /**
      * Get map of cached items
      * @return {Record<K, T>}
      */
-    map() {
-      return deepCopy(this.store);
+    map(expired) {
+      const copy = deepCopy(this.store);
+      if (!expired) Object.keys(copy).forEach((k) => {
+        if (copy[k]._expired) delete copy[k];
+      });
+      return copy;
     }
     /**
      * Add an item to the cache manually specifying the key
@@ -521,12 +540,12 @@ ${opts.message || this.desc}`;
      * @return {this}
      */
     set(key, value, ttl = this.options.ttl) {
+      if (this.options.expiryPolicy == "keep") delete this.store[key]._expired;
       this.store[key] = value;
-      if (this.options.storageKey && this.options.storage)
-        this.options.storage.setItem(this.options.storageKey, JSON.stringify(this.store));
+      this.save();
       if (ttl) setTimeout(() => {
-        this.complete = false;
-        this.delete(key);
+        this.expire(key);
+        this.save();
       }, ttl * 1e3);
       return this;
     }
@@ -1638,7 +1657,7 @@ ${opts.message || this.desc}`;
       return PathEvent.filter(target, this);
     }
     /**
-     * Create  event string from its components
+     * Create event string from its components
      *
      * @return {string} String representation of Event
      */
@@ -1647,18 +1666,22 @@ ${opts.message || this.desc}`;
     }
   }
   class PathEventEmitter {
-    constructor() {
+    constructor(prefix = "") {
       __publicField(this, "listeners", []);
+      this.prefix = prefix;
     }
     emit(event, ...args) {
-      const parsed = new PathEvent(event);
+      const parsed = new PathEvent(`${this.prefix}/${typeof event == "string" ? event : event.toString()}`);
       this.listeners.filter((l) => PathEvent.has(l[0], event)).forEach(async (l) => l[1](parsed, ...args));
     }
     off(listener) {
       this.listeners = this.listeners.filter((l) => l[1] != listener);
     }
     on(event, listener) {
-      makeArray(event).forEach((e) => this.listeners.push([new PathEvent(e), listener]));
+      makeArray(event).forEach((e) => this.listeners.push([
+        new PathEvent(`${this.prefix}/${typeof e == "string" ? event : event.toString()}`),
+        listener
+      ]));
       return () => this.off(listener);
     }
     once(event, listener) {