fix(types): add PiniaCustomProperties to stores

vuejs · Mar 31, 2021 · a12d96d · a12d96d
1 parent 40fcb24
commit a12d96d
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 9 deletions.
diff --git a/__tests__/storePlugins.spec.ts b/__tests__/storePlugins.spec.ts
@@ -28,6 +28,8 @@ describe('store plugins', () => {
     const store = useStore(pinia)
 
     expect(store.n).toBe(20)
+    // @ts-expect-error: n is a number
+    store.n.notExisting
   })
 
   it('can install plugins before installing pinia', () => {

diff --git a/src/index.ts b/src/index.ts
@@ -3,7 +3,6 @@ export {
   createPinia,
   Pinia,
   PiniaStorePlugin,
-  PiniaCustomProperties,
 } from './rootStore'
 export { defineStore } from './store'
 export { PiniaPlugin } from './plugin'
@@ -13,5 +12,8 @@ export {
   StoreWithGetters,
   StoreWithActions,
   StoreWithState,
+  PiniaCustomProperties,
 } from './types'
+
+// TODO: remove in beta
 export { createStore } from './deprecated'
diff --git a/src/rootStore.ts b/src/rootStore.ts
@@ -1,5 +1,10 @@
 import { InjectionKey, ref, Ref } from '@vue/composition-api'
-import { StateTree, StoreWithState, StateDescriptor } from './types'
+import {
+  StateTree,
+  StoreWithState,
+  StateDescriptor,
+  PiniaCustomProperties,
+} from './types'
 import { VueConstructor } from 'vue'
 import type Vue from 'vue'
 
@@ -14,12 +19,6 @@ export const storesMap = new WeakMap<
   Map<string, [StoreWithState<string, StateTree>, StateDescriptor<StateTree>]>
 >()
 
-/**
- * Properties that are added to every store by `pinia.use()`
- */
-// eslint-disable-next-line
-export interface PiniaCustomProperties {}
-
 export const piniaSymbol = (__DEV__
   ? Symbol('pinia')
   : /* istanbul ignore next */

diff --git a/src/types.ts b/src/types.ts
@@ -109,7 +109,11 @@ export type Store<
   S extends StateTree,
   G,
   A
-> = StoreWithState<Id, S> & S & StoreWithGetters<G> & StoreWithActions<A>
+> = StoreWithState<Id, S> &
+  S &
+  StoreWithGetters<G> &
+  StoreWithActions<A> &
+  PiniaCustomProperties
 
 export type GenericStore = Store<
   string,
@@ -138,3 +142,9 @@ declare global {
     }
   }
 }
+
+/**
+ * Properties that are added to every store by `pinia.use()`
+ */
+// eslint-disable-next-line
+export interface PiniaCustomProperties {}