v3.5.1

Bug Fixes

• types: add missing logger.d.ts file to the package (#1789) (a477334)
• warn when unregistering non existing module (#1786) (7cec79d)

v3.5.0

Features

• include logger plugin to the core export (#1783) (04e2bd8)

4.0.0-beta.2

Bug Fixes

• types: add useStore function (#1736) #1739
• build: fix iife build containing process.env.

v3.4.0

Features

• Allow action subscribers to catch rejections. (#1740) (6ebbe64), closes #1489 #1558 #1625

v4.0.0-beta.1

Features

• Added TypeScript support.

Breaking Changes

Bundles are now aligned with Vue 3

The bundles are generated as below to align with Vue 3 bundles.

• vuex.global(.prod).js
  • For direct use via <script src="..."> in the browser. Exposes the Vuex global.
  • Note that global builds are not UMD builds. They are built as IIFEs and is only meant for direct use via <script src="...">.
  • Contains hard-coded prod/dev branches, and the prod build is pre-minified. Use the .prod.js files for production.
• vuex.esm-browser(.prod).js
  • For usage via native ES modules imports (in browser via <script type="module">.
• vuex.esm-bundler.js
  • For use with bundlers like webpack, rollup and parcel.
  • Leaves prod/dev branches with process.env.NODE_ENV guards (must be replaced by bundler).
  • Does not ship minified builds (to be done together with the rest of the code after bundling).
• vuex.cjs.js
  • For use in Node.js server-side rendering via require().

Typings for ComponentCustomProperties

Vuex 4 removes its global typings for this.$store within Vue Component due to solving issue #994. When using TypeScript, you must provide your own augment declaration.

Please place the following code in your project to have this.$store working.

// vuex-shim.d.ts

declare module "@vue/runtime-core" {
  // Declare your own store states.
  interface State {
    count: number
  }

  interface ComponentCustomProperties {
    $store: Store<State>;
  }
}

v3.3.0

Bug Fixes

• Prepend devtool handler (#1358) (a39d076), closes vuejs/vue-devtools#678
• types: Add devtools to store options type (#1478) (38c11dc)

Features

• Add prepend option for subscribe and subscribeAction (#1358) (a39d076)
• logger: createLogger can optionally log actions (#987) (18be128)

v3.2.0

Features

• add Store#hasModule(path) API (#834) (d65d142)

v4.0.0-alpha.1

This is the Vue 3 compatible version of Vuex. The focus is compatibility, and it provides the exact same API as Vuex 3, so users can reuse their existing Vuex code for Vue 3.

Status: Alpha

All Vuex 3 feature works. There are a few breaking changes described in a later section, so please check them out. You can find basic usage with both option and composition API at example folder.

Please note that it's still unstable, and there might be bugs. Please provide us feedback if you find anything. You may use vue-next-webpack-preview to test out Vue 3 with Vuex 4.

Breaking changes

Installation process has changed

To align with the new Vue 3 initialization process, the installation process of Vuex has changed as well.

You should use a new createStore function to create a new store instance.

import { createStore } from 'vuex'

const store = createStore({
  state () {
    return {
      count: 1
    }
  }
})

This is technically not a breaking change because you could still use new Store(...) syntax. However, to align with Vue 3 and also with Vue Router Next, we recommend users to use createStore function instead.

Then to install Vuex to Vue app instance, pass the store instance instead of Vuex.

import { createApp } from 'vue'
import store from './store'
import App from './APP.vue'

const app = createApp(Counter)

app.use(store)

app.mount('#app')

Kown issues

• The code is kept as close to Vuex 3 code base as possible, and there're plenty of places where we should refactor. However, we are waiting for all of the test cases to pass before doing so (some tests require Vue 3 update).
• TypeScript support is not ready yet. Please use JS environment to test this for now.

v3.1.3

Bug Fixes

• Prevent invalidating subscription iterator (#1438) (@cngu)

Improvements

• Add vue as a peer dependency (#1692) (@kiaking)

v3.1.2

Bug Fixes

• types: avoid broadening vue instance type when using map helpers (#1639) (9a96720) (@ktsn)

Improvements

• warn when the different namespaced modules has the same namespace (#1554) (91f3e69) (@liyangworld)
• warn when mapXXX helpers receives an invalid parameter #1093 (#1297) (e5ca2d5) (@EdyHartono)
• warn when registered module conflicts with existing parent module state (#1365) (538ee58) (@simplesmiler)

Performance Improvements

• cache getters object in an action context of a namespaced module (#1546) (4003382) (@frankcs)