⚠️ This project is currently undergoing refactoring and is NOT production ready ⚠️
Write Vuex stores and modules with type-safety and code completion
- Basic example
- Conventions for type-safety
- Example usage and code structure
While working with decorators in TypeScript, it helps to have a basic understanding of what they are (and aren't) doing. With these decorators we'll write classes which are transformed into Vuex module/store definitions. It's important to note that we will never use
extend with the decoratated classes.
class allows for a straightforward and ergonomic syntax while also providing usable typings down the line. When we combine that benefit with the added convenience of a normalized scope for our actions, mutations and getters (provided by the decorators) we end up with less boilerplate, strict-typing and clearer code across the board.
The following snippet shows a standard Vuex declaration followed by an example using decorators.
Typing your stores and modules
It's important to note that by themselves, these decorators do not provide full type-safety. Instead they allow us to write our stores and modules in a way that allows us to achieve type-safety via normal TypeScript conventions.
Declaring actions, getters and mutations
Leveraging TypeScript's “declaration merging” we can easily specify our store's api to achieve type-safety and code-completion throughout our application.
In order to define our api, we first import a few constants and declare our module/store's api:
Example usage and code structure
For futher answers and information, please check out the companion vuex-ts-example project. You'll be able to see the decorators in action as well as some guidance on how you can structure your code for the best results.