@mmstack/resource 20.2.7 → 20.2.8

package/index.d.ts

@@ -40,6 +40,7 @@ type OldsetCleanupType = {
 type CacheEntry<T> = {
     value: T;
     created: number;
+    updated: number;
     stale: number;
     useCount: number;
     expiresAt: number;
@@ -62,6 +63,12 @@ declare class Cache<T> {
     protected readonly staleTime: number;
     private readonly internal;
     private readonly cleanupOpt;
+    /**
+     * Destroys the cache instance, cleaning up any resources used by the cache.
+     * This method is called automatically when the cache instance is garbage collected.
+     */
+    readonly destroy: () => void;
+    private readonly broadcast;
     /**
      * Creates a new `Cache` instance.
      *
@@ -70,8 +77,14 @@ declare class Cache<T> {
      *                    stale but can still be used while revalidation occurs in the background. Defaults to 1 hour.
      * @param cleanupOpt - Options for configuring the cache cleanup strategy.  Defaults to LRU with a
      *                     `maxSize` of 200 and a `checkInterval` of one hour.
-     */
-    constructor(ttl?: number, staleTime?: number, cleanupOpt?: Partial<CleanupType>);
+     * @param syncTabs - If provided, the cache will use the options a BroadcastChannel to send updates between tabs.
+     *                   Defaults to `undefined`, meaning no synchronization across tabs.
+     */
+    constructor(ttl?: number, staleTime?: number, cleanupOpt?: Partial<CleanupType>, syncTabs?: {
+        id: string;
+        serialize: (value: T) => string;
+        deserialize: (value: string) => T | null;
+    });
     /** @internal */
     private getInternal;
     /**
@@ -113,12 +126,14 @@ declare class Cache<T> {
      * @param ttl - (Optional) The TTL for this entry, in milliseconds. Overrides the default `ttl`.
      */
     store(key: string, value: T, staleTime?: number, ttl?: number): void;
+    private storeInternal;
     /**
      * Invalidates (removes) a cache entry.
      *
      * @param key - The key of the entry to invalidate.
      */
     invalidate(key: string): void;
+    private invalidateInternal;
     /** @internal */
     private cleanup;
 }
@@ -139,6 +154,10 @@ type CacheOptions = {
      * Options for configuring the cache cleanup strategy.
      */
     cleanup?: Partial<CleanupType>;
+    /**
+     * Whether to synchronize cache across tabs. If provided, the cache will use a BroadcastChannel to send updates between tabs.
+     */
+    syncTabsId?: string;
 };
 /**
  * Provides the instance of the QueryCache for queryResource. This should probably be called

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mmstack/resource",
-  "version": "20.2.7",
+  "version": "20.2.8",
   "keywords": [
     "angular",
     "signals",
@@ -18,7 +18,7 @@
   "homepage": "https://github.com/mihajm/mmstack/blob/master/packages/resource",
   "dependencies": {
     "uuid": "~11.1.0",
-    "@mmstack/primitives": "^20.0.2",
+    "@mmstack/primitives": "^20.0.3",
     "@mmstack/object": "^20.0.0",
     "tslib": "^2.3.0"
   },