This repository has been archived by the owner on Jul 8, 2022. It is now read-only.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Snyk has created this PR to upgrade vuex from 3.6.2 to 4.0.1.
ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.
Warning: This is a major version upgrade, and may be a breaking change.
Release notes
Package name: vuex
Features
This is the official Vuex 4 release.
The focus for Vuex 4 is compatibility. Vuex 4 supports Vue 3, and it provides the exact same API as Vuex 3, so users can reuse their existing Vuex code with Vue 3.
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 in the
example
directory.It's still released under
next
tag in NPM package as same as Vue 3. We're planning to removenext
tag once Vue 3 is ready to remove it.There have been a lot of contribution to make Vuex 4 stable. Thank you all for your very much appreciated help. It wouldn't have been possible without this wonderful Vue community!
Documentation
To check out docs, visit next.vuex.vuejs.org.
Breaking changes
Installation process has changed
To align with the new Vue 3 initialization process, the installation process of Vuex has changed.
To create a new store instance, users are now encouraged to use the newly introduced
createStore
function.export const store = createStore({
state() {
return {
count: 1
}
}
})
To install Vuex to a Vue instance, pass the store instance instead of Vuex.
import { store } from './store'
import App from './App.vue'
const app = createApp(App)
app.use(store)
app.mount('#app')
Bundles are now aligned with Vue 3
The following bundles are generated to align with Vue 3 bundles:
vuex.global(.prod).js
<script src="...">
in the browser. Exposes the Vuex global.<script src="...">
..prod.js
files for production.vuex.esm-browser(.prod).js
<script type="module">
.vuex.esm-bundler.js
webpack
,rollup
andparcel
.process.env.NODE_ENV
guards (must be replaced by bundler).vuex.cjs.js
require()
.Typings for
ComponentCustomProperties
Vuex 4 removes its global typings for
this.$store
within Vue Component to solve issue #994. When used with TypeScript, you must declare your own module augmentation.Place the following code in your project to allow
this.$store
to be typed correctly:import { ComponentCustomProperties } from 'vue'
import { Store } from 'vuex'
declare module '@ vue/runtime-core' {
// Declare your own store states.
interface State {
count: number
}
interface ComponentCustomProperties {
$store: Store<State>
}
}
createLogger
function is exported from the core moduleIn Vuex 3,
createLogger
function was exported fromvuex/dist/logger
but it's now included in the core package. You should import the function directly fromvuex
package.Bug Fixes Included Since 4.0.0-rc.2
storeKey
(4ab2947)Bug Fixes
hasModule
when parent does not exists (#1850) (f76d72d)Features
Bug Fixes
Features
Bug Fixes
logger.d.ts
file to the package (#1789) (a477334)Bug Fixes
process.env
flag (#1749) (0fea8c4)Features
createLogger
function in core export (afa566d)Bug Fixes
Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.
For more information:
🧐 View latest project report
🛠 Adjust upgrade PR settings
🔕 Ignore this dependency or unsubscribe from future upgrade PRs