feat: add mapStores

vuejs · Apr 9, 2021 · d3d9327 · d3d9327
1 parent 2efb77c
commit d3d9327
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 3 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -15,5 +15,6 @@ export {
   DefineStoreOptions,
 } from './types'
 
+export { mapStores } from './mapHelpers'
 // TODO: remove in beta
 export { createStore } from './deprecated'
diff --git a/src/store.ts b/src/store.ts
@@ -12,6 +12,7 @@ import {
   Method,
   PiniaCustomProperties,
   DefineStoreOptions,
+  StoreDefinition,
 } from './types'
 import {
   getActivePinia,
@@ -258,10 +259,10 @@ export function defineStore<
   S extends StateTree,
   G /* extends Record<string, StoreGetterThis> */,
   A /* extends Record<string, StoreAction> */
->(options: DefineStoreOptions<Id, S, G, A>) {
+>(options: DefineStoreOptions<Id, S, G, A>): StoreDefinition<Id, S, G, A> {
   const { id, state, getters, actions } = options
 
-  return function useStore(pinia?: Pinia | null): Store<Id, S, G, A> {
+  function useStore(pinia?: Pinia | null): Store<Id, S, G, A> {
     // avoid injecting if `useStore` when not possible
     pinia = pinia || (getCurrentInstance() && inject(piniaSymbol))
     if (pinia) setActivePinia(pinia)
@@ -318,4 +319,9 @@ export function defineStore<
       actions as Record<string, Method> | undefined
     )
   }
+
+  // used by devtools
+  useStore.$id = id
+
+  return useStore
 }
diff --git a/src/types.ts b/src/types.ts
@@ -152,7 +152,20 @@ export type Store<
   PiniaCustomProperties<Id, S, G, A>
 
 /**
- * Generic store type
+ * Return type of `defineStore()`. Function that allows instantiating a store.
+ */
+export interface StoreDefinition<
+  Id extends string,
+  S extends StateTree,
+  G /* extends Record<string, StoreGetterThis> */,
+  A /* extends Record<string, StoreAction> */
+> {
+  (pinia?: Pinia | null | undefined): Store<Id, S, G, A>
+  $id: Id
+}
+
+/**
+ * Generic version of Store
  */
 export type GenericStore = Store<
   string,
@@ -161,6 +174,19 @@ export type GenericStore = Store<
   Record<string, Method>
 >
 
+/**
+ * Generic version of `StoreDefinition`
+ */
+export interface GenericStoreDefinition {
+  (pinia?: Pinia | null | undefined): Store<
+    string,
+    StateTree,
+    Record<string, Method>,
+    Record<string, Method>
+  >
+  $id: string
+}
+
 /**
  * Properties that are added to every store by `pinia.use()`
  */