types: add useStore function (#1736)

fix #1736
vuejs · Apr 30, 2020 · 2cc24bf · 2cc24bf
1 parent f18d5d4
commit 2cc24bf
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -43,6 +43,8 @@ export declare class Store<S> {
 
 export function createStore<S>(options: StoreOptions<S>): Store<S>;
 
+export function useStore<S = any>(): Store<S>;
+
 export interface Dispatch {
   (type: string, payload?: any, options?: DispatchOptions): Promise<any>;
   <P extends Payload>(payloadWithType: P, options?: DispatchOptions): Promise<any>;

diff --git a/types/test/index.ts b/types/test/index.ts
@@ -78,6 +78,18 @@ namespace StoreInstance {
   store.replaceState({ value: 10 });
 }
 
+namespace UseStoreFunction {
+  interface State {
+    a: string
+  }
+
+  const storeWithState = Vuex.useStore<State>()
+  storeWithState.state.a
+
+  const storeAsAny = Vuex.useStore()
+  storeAsAny.state.a
+}
+
 namespace RootModule {
   const store = new Vuex.Store({
     state: {