feat(types): expose QueryCache

posva · Jan 31, 2025 · fb4c647 · fb4c647
1 parent 542e15e
commit fb4c647
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 3 deletions.
diff --git a/docs/advanced/plugins.md b/docs/advanced/plugins.md
@@ -1,4 +1,4 @@
-## Plugins
+# Plugins
 
 ::: warning
 
@@ -32,3 +32,13 @@ export function PiniaColadaDebugPlugin(
   }
 }
 ```
+
+## Cache Keys
+
+The cache keys are used to identify queries in the cache. The `key` passed to queries get serialized deterministically with the `toCacheKey()` function. You can use this function in plugins if you needed:
+
+```ts twoslash
+import { toCacheKey } from '@pinia/colada'
+
+const key = toCacheKey(['users', 1, { type: 'friends' }])
+```
diff --git a/plugins/delay/src/index.ts b/plugins/delay/src/index.ts
@@ -3,7 +3,7 @@
  */
 import type { ShallowRef } from 'vue'
 import { customRef, shallowRef } from 'vue'
-import type { PiniaColadaPlugin, AsyncStatus } from '@pinia/colada'
+import { type PiniaColadaPlugin, type AsyncStatus, toCacheKey } from '@pinia/colada'
 
 /**
  * Options for the {@link PiniaColadaDelay} plugin.

diff --git a/src/index.ts b/src/index.ts
@@ -40,6 +40,7 @@ export {
 
 export {
   hydrateQueryCache,
+  type QueryCache,
   reviveTreeMap,
   serialize,
   serializeQueryCache,

diff --git a/src/utils.ts b/src/utils.ts
@@ -118,7 +118,7 @@ export function stringifyFlatObject(obj: _ObjectFlat | _JSONPrimitive): string {
 }
 
 /**
- * Creates a {@link QueryCache['caches']} key from an entry's {@link UseQueryOptions['key']}.
+ * Creates a {@link QueryCache}'s `caches` key from an entry's {@link UseQueryOptions#key}.
  * @param key - key of the entry
  */
 export const toCacheKey = (key: EntryKey): EntryNodeKey[] => key.map(stringifyFlatObject)