docs: skipHydrate api

vuejs · May 19, 2022 · 5b0c92c · 5b0c92c
1 parent 5d44937
commit 5b0c92c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/pinia/src/store.ts b/packages/pinia/src/store.ts
@@ -84,6 +84,13 @@ const skipHydrateSymbol = __DEV__
   : /* istanbul ignore next */ Symbol()
 const skipHydrateMap = /*#__PURE__*/ new WeakMap<any, any>()
 
+/**
+ * Tells Pinia to skip the hydration process of a given object. This is useful in setup stores (only) when you return a
+ * stateful object in the store but it isn't really state. e.g. returning a router instance in a setup store.
+ *
+ * @param obj - target object
+ * @returns obj
+ */
 export function skipHydrate<T = any>(obj: T): T {
   return isVue2
     ? // in @vue/composition-api, the refs are sealed so defineProperty doesn't work...