Gathering detailed insights and metrics for vuex-router-sync
Gathering detailed insights and metrics for vuex-router-sync
Effortlessly keep vue-router and vuex store in sync.
Installations
npm install vuex-router-syncDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
8.4.0
NPM Version
5.4.1
Releases
5
Languages
2
JavaScript
TypeScript
JavaScript (57.43%)
TypeScript (42.57%)
Developer
vuejs
Download Statistics
Total Downloads
27,213,501
Last Day
10,913
Last Week
59,177
Last Month
258,332
Last Year
3,377,806
GitHub Statistics
MIT License
2,510 Stars
79 Commits
126 Forks
47 Watchers
4 Branches
87 Contributors
Updated on Apr 11, 2025
Bundle Size
783.00 B
Minified
464.00 B
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
5.0.0
Package Id
vuex-router-sync@5.0.0
Size
2.73 kB
NPM Version
5.4.1
Node Version
8.4.0
Published on
Oct 12, 2017
Total Downloads
Cumulative downloads
Total Downloads
27,213,501
Peer Dependencies
2
Dev Dependencies
6
vuex-router-sync 
Sync vue-router's current $route as part of vuex store's state.
Usage
1# the latest version works only with vue-router >= 2.0 2npm install vuex-router-sync 3 4# for usage with vue-router < 2.0: 5npm install vuex-router-sync@2
1import { sync } from 'vuex-router-sync' 2import store from './vuex/store' // vuex store instance 3import router from './router' // vue-router instance 4 5const unsync = sync(store, router) // done. Returns an unsync callback fn 6 7// bootstrap your app... 8 9// During app/Vue teardown (e.g., you only use Vue.js in a portion of your app and you 10// navigate away from that portion and want to release/destroy Vue components/resources) 11unsync() // Unsyncs store from router
You can optionally set a custom vuex module name:
1sync(store, router, { moduleName: 'RouteModule' } )
How does it work?
-
It adds a
routemodule into the store, which contains the state representing the current route:1store.state.route.path // current path (string) 2store.state.route.params // current params (object) 3store.state.route.query // current query (object) -
When the router navigates to a new route, the store's state is updated.
-
store.state.routeis immutable, because it is derived state from the URL, which is the source of truth. You should not attempt to trigger navigations by mutating the route object. Instead, just call$router.push()or$router.go(). Note that you can do$router.push({ query: {...}})to update the query string on the current path.
License
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 3/29 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/vuejs/vuex-router-sync/test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/vuejs/vuex-router-sync/test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/vuejs/vuex-router-sync/test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/vuejs/vuex-router-sync/test.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/vuejs/vuex-router-sync/test.yml/master?enable=pin
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 5 are checked with a SAST tool
Reason
37 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
- Warn: Project is vulnerable to: GHSA-5j4c-8p2g-v4jx
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Score
2.6
/10
Last Scanned on 2025-04-28
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More