vuex-dispatch-infer
v0.8.4
Published
vuex 字面量类型推导。 支持推导vuex的所有用到字面量类型的地方及RootState。 纯类型实现,无侵入性,易回退,无需单独写类型。适用于vue2和vue3 ## Install `yarn add vuex-dispatch-infer --dev` ## Vue3 Example [Click here](./example) ### 一个简单的dispatch及store类型推导例子 ```typescript import { createStore } from 'vuex' impor
Downloads
19
Readme
vuex-dispatch-infer
vuex 字面量类型推导。 支持推导vuex的所有用到字面量类型的地方及RootState。 纯类型实现,无侵入性,易回退,无需单独写类型。适用于vue2和vue3
Install
yarn add vuex-dispatch-infer --dev
Vue3 Example
一个简单的dispatch及store类型推导例子
import { createStore } from 'vuex'
import cart from './modules/cart'
import products from './modules/products'
import { GetRootState, GetDispatchOverload, GetCommitOverload, GetOverloadDict } from 'vuex-dispatch-infer'
import { Store } from 'vuex'
const storeParams = {
modules: {
cart,
products
},
state: {
hello : 'world'
},
mutations: {
setHello (s: any, foo: string) {
}
}
}
type StoreParams = typeof storeParams
const store = createStore(storeParams) as Store<GetRootState<StoreParams>>
export const dispatch = store.dispatch as GetDispatchOverload<StoreParams> // 单独导出相对hook能检查的更严格
export const commit = store.commit as GetCommitOverload<StoreParams>
dispatch('cart/addProductToCart', {
id: 2,
title: '22',
price: 1,
inventory: 1
})
dispatch('products/getAllProducts').then(all => {
console.log(all.map(prod => prod.title).join())
})
dispatch('products/getone', 1)
commit('setHello', 'bar')
/**
* 可选的给hook函数增加重载
*/
declare module 'vuex' {
type MutationDict = GetOverloadDict<StoreParams, 'mutations'>
type ActionDict = GetOverloadDict<StoreParams, 'actions'>
export interface Dispatch {
<T extends keyof ActionDict> (type: T, ...args: Parameters<ActionDict[T]>): ReturnType<ActionDict[T]>
}
export function useStore<S = GetRootState<StoreParams>>(): Store<S>
export interface Commit {
<T extends keyof MutationDict> (type: T, ...args: Parameters<MutationDict[T]>) : void
}
}
export default store
实用类型
可以为其他库提供一些类型上的支持
使用keyof DispatchOverloadDict<Modules, 'mutations'>
可以获取到所有mutations字面量的联合
keyof DispatchOverloadDict<Modules, 'actions'>
则是可以获取所有actions字面量的联合