mariusvolkhart/vuex-type-safety

Typescript builder for strongly-typed access to Vuex Store modules

Vuex-Type-Safety

A TypeScript pattern for strongly-typed access to Vuex Store modules

I really like using vuex-typex by @mrcrowl which is based on vuex-typescript by @istrib

However, vuex-typex has not been maintained for a while. So I've decided to take a branch to get my projects working.

Feel free to use this if you find it useful.

Original Description from Vuex-Typex

I just wanted to take the ideas bit further.

My main changes are:

• Avoid passing $store/context to the accessor methods: we can encapsulate these within the accessors by providing the store later: i.e. basket.commitAppendItem(newItem) should be sufficient.
• No need to distinguish between payload / payload-less versions of commit + dispatch. Typescript overloads solve this problem.
• Promises returned from dispatch should be strongly-typed.
• Assumes namespaced modules

I also took the point of view that we don't need to start with a vuex-store options object. If we treat the accessor-creator as a builder, then the store can be generated:

import { getStoreBuilder } from "vuex-type-safety"
import Vuex, { Store, BareActionContext } from "vuex"
import Vue from "vue"
const delay = (duration: number) => new Promise((c, e) => setTimeout(c, duration))

Vue.use(Vuex)

export interface RootState { basket: BasketState }
export interface BasketState { items: Item[] }
export interface Item { id: string, name: string }

const storeBuilder = getStoreBuilder<RootState>()
const moduleBuilder = storeBuilder.module<BasketState>("basket", { items: [] })

namespace basket
{
    const appendItemMutation = (state: BasketState, payload: { item: Item }) => state.items.push(payload.item)
    const delayedAppendAction = async (context: BareActionContext<BasketState, RootState>) =>
    {
        await delay(1000)
        basket.commitAppendItem({ item: { id: "abc123", name: "ABC Item" } })
    }

    export const commitAppendItem = moduleBuilder.commit(appendItemMutation)
    export const dispatchDelayedAppend = moduleBuilder.dispatch(delayedAppendAction)
}
export default basket

/// in the main app file
const storeBuilder = getStoreBuilder<RootState>()
new Vue({
    el: '#app',
    template: "....",
    store: storeBuilder.vuexStore()
})

• A more complete example as a gist