From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Tue, 9 Feb 2021 10:27:20 +0000 (+0100)
Subject: docs: escapeHTML note
X-Git-Tag: v2.0.0-alpha.8~99
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=4e85f42b19d25ea2f89de1e77ddbd944e74bea00;p=thirdparty%2Fvuejs%2Fpinia.git

docs: escapeHTML note
---

diff --git a/README.md b/README.md
index 98810309..248867c5 100644
--- a/README.md
+++ b/README.md
@@ -318,8 +318,9 @@ app.use(pinia)
 // after rendering the page, the root state is build and can be read
 // serialize, escape (VERY important if the content of the state can be changed
 // by the user, which is almost always the case), and place it somewhere on
-// the page, for example, as a global variable.
-JSON.stringify(pinia.state.value)
+// the page, for example, as a global variable. Note you need to use your own
+// `escapeHTML()` function or use an existing package
+escapeHTML(JSON.stringify(pinia.state.value))
 ```
 
 On client side, you must hydrate pinia's state before calling any `useStore()` function. For example, if we serialize the state into a `<script>` tag to make it accessible globally on client side through `window.__pinia`, we can write this:
diff --git a/src/rootStore.ts b/src/rootStore.ts
index 6c63f6b9..1cc261d6 100644
--- a/src/rootStore.ts
+++ b/src/rootStore.ts
@@ -39,9 +39,8 @@ export const getActivePinia = () => {
 }
 
 /**
- * The api needs more work we must be able to use the store easily in any
- * function by calling `useStore` to get the store Instance and we also need to
- * be able to reset the store instance between applications on the server
+ * Map of stores based on a Pinia instance. Allows setting and retrieving stores
+ * for the current running application (with its pinia).
  */
 
 export const storesMap = new WeakMap<
@@ -154,7 +153,7 @@ export function createPinia(): Pinia {
 export interface PiniaCustomProperties {}
 
 /**
- * Registered stores
+ * Registered stores used for devtools. TODO: move to devtools
  */
 export const stores = /*#__PURE__*/ new Set<GenericStore>()