vuex-composition-helpers - npm Package Compare versions

Comparing version 1.0.23 to 1.0.24

dist/global.js

@@ -6,2 +6,5 @@ import { computed } from '@vue/composition-api';
 }
+export function useStore() {
+    return getStoreFromInstance();
+}
 export function useState(storeOrMap, map) {
@@ -8,0 +11,0 @@ let store = storeOrMap;

dist/types/global.d.ts

 import { Store } from 'vuex/types';
 import { ExtractGetterTypes, ExtractTypes, KnownKeys, RefTypes } from './util';
+export declare function useStore<TState = any>(): Store<TState>;
 export declare function useState<TState = any>(storeOrMap: Store<TState> | KnownKeys<TState>[], map?: KnownKeys<TState>[]): RefTypes<TState>;
@@ -4,0 +5,0 @@ export declare function useGetters<TGetters = any>(storeOrMap: Store<any> | KnownKeys<TGetters>[], map?: KnownKeys<TGetters>[]): ExtractGetterTypes<TGetters>;

package.json

 {
  "name": "vuex-composition-helpers",
- "version": "1.0.23",
+ "version": "1.0.24",
  "description": "Helpers to use Vuex store form Vue Composition API",
@@ -5,0 +5,0 @@ "author": "David Meir-Levy <[e-mail]>",

README.md

@@ -128,2 +128,32 @@ # vuex-composition-helpers
 
+#### Typescript Namespaced Usage Example
+
+```ts
+import { useState, useActions } from 'vuex-composition-helpers';
+import { ModuleState, ModuleGetters, ModuleActions, ModuleMutations } from "../store/subModule"
+
+export default {
+	props: {
+		articleId: String
+	},
+	setup(props) {
+		const { useState, useActions } = createNamespacedHelpers<
+			ModuleState,
+			ModuleGetters,
+			ModuleActions,
+			ModuleMutations
+		>('articles'); // specific module name and generics
+		const { fetch } = useActions(['fetch']); // no generics needed any more
+		const { article, comments } = useGetters(['article', 'comments']); // no generics needed any more
+		fetch(props.articleId); // dispatch the "fetch" action
+
+		return {
+			// both are computed compositions for to the store
+			article,
+			comments
+		}
+	}
+}
+```
+
 ### Advanced Usage Example
@@ -130,0 +160,0 @@

src/global.ts

@@ -9,2 +9,6 @@ import {Store} from 'vuex/types';
 
+export function useStore<TState = any>() {
+	return getStoreFromInstance() as Store<TState>
+}
+
 export function useState<TState = any>(storeOrMap: Store<TState> | KnownKeys<TState>[], map?: KnownKeys<TState>[]): RefTypes<TState> {
@@ -11,0 +15,0 @@ let store = storeOrMap;

No alert changes

Improved metrics

Total package byte prevSize

36454

increased by3.06%

Lines of code

508

increased by1.4%

Number of lines in readme file

266

increased by12.71%

No dependency changes