feat: disposePinia

Close vuejs/pinia#2453
CrescentSine · Dec 5, 2023 · a1510cd · a1510cd
1 parent ae1c2f5
commit a1510cd
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/packages/pinia/src/createPinia.ts b/packages/pinia/src/createPinia.ts
@@ -30,3 +30,18 @@ export function createPinia(): Pinia {
 
   return pinia
 }
+
+/**
+ * Dispose a Pinia instance by stopping its effectScope and removing the state, plugins and stores. This is mostly
+ * useful in tests, with both a testing pinia or a regular pinia and in applications that use multiple pinia instances.
+ *
+ * @param pinia - pinia instance
+ */
+export function disposePinia(pinia: Pinia) {
+  pinia._e.stop()
+  pinia._s.clear()
+  pinia._p.splice(0)
+  pinia.state.value = {}
+  // @ts-expect-error: non valid
+  pinia._a = null
+}
diff --git a/packages/pinia/src/index.ts b/packages/pinia/src/index.ts
@@ -2,7 +2,7 @@
  * @module pinia
  */
 export { setActivePinia, getActivePinia } from './rootStore'
-export { createPinia } from './createPinia'
+export { createPinia, disposePinia } from './createPinia'
 export type {
   Pinia,
   // TODO: remove in next release