feat: snapshot

package.json

@@ -1,6 +1,6 @@
 {
   "name": "turbo-query",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "license": "MIT",
   "description": "Lightweight, isomorphic and framework agnostic asynchronous data management for modern UIs",
   "author": {

src/turbo-query.ts

@@ -5,22 +5,22 @@ export interface TurboCache<T = unknown> {
   /**
    * Gets an item from the cache.
    */
-  get(key: string): T
+  readonly get: (key: string) => T
 
   /**
    * Sets an item to the cache.
    */
-  set(key: string, value: T): void
+  readonly set: (key: string, value: T) => void
 
   /**
    * Removes a key-value pair from the cache.
    */
-  delete(key: string): void
+  readonly delete: (key: string) => void
 
   /**
    * Returns the current cached keys.
    */
-  keys(): IterableIterator<string>
+  readonly keys: () => IterableIterator<string>
 }
 
 /**
@@ -200,6 +200,12 @@ export interface TurboQuery {
    * If the item is not in the cache, it will return `undefined`.
    */
   readonly expiration: (key: string) => Date | undefined
+
+  /**
+   * Returns the current snapshot of the given key.
+   * If the item is not in the items cache, it will return `undefined`.
+   */
+  readonly snapshot: <T = unknown>(key: string) => T | undefined
 }
 
 /**
@@ -348,6 +354,14 @@ export function createTurboQuery(instanceOptions?: TurboQueryConfiguration): Tur
     events.dispatchEvent(new CustomEvent(`mutated:${key}`, { detail: item }))
   }
 
+  /**
+   * Returns the current snapshot of the given key.
+   * If the item is not in the items cache, it will return `undefined`.
+   */
+  function snapshot<T = unknown>(key: string): T | undefined {
+    return itemsCache.get(key)?.item as T
+  }
+
   /**
    * Determines if the given key is currently resolving.
    */
@@ -549,5 +563,5 @@ export function createTurboQuery(instanceOptions?: TurboQueryConfiguration): Tur
     return await refetch(key)
   }
 
-  return { query, subscribe, mutate, configure, abort, forget, keys, expiration, hydrate }
+  return { query, subscribe, mutate, configure, abort, forget, keys, expiration, hydrate, snapshot }
 }