npmpackage.info

Gathering detailed insights and metrics for vuex-router-sync

Other packages similar to vuex-router-sync

nuxt-vuex-router-sync

0.0.3

vuex-router-sync integration for Nuxt

vuex-router-sync-previous

4.0.2

Effortlessly keep vue-router and vuex store in sync.

vuex-enhanced-router-sync

1.0.0

This package replaces vuex-router-sync and adds some useful features.

vuex-router-sync-fullpath

5.0.1

Effortlessly keep vue-router's current fullPath and vuex store in sync.

Gathering detailed insights and metrics for vuex-router-sync

vuex-router-sync - 5.0.0 | npmpackage.info

vuex-router-sync

Effortlessly keep vue-router and vuex store in sync.

5.0.0

2,510

MIT

JavaScript

464.00 B

27,213,501 2.6

Installations

npm install vuex-router-sync

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

8.4.0

NPM Version

5.4.1 Score

81.3

Supply Chain

79.7

Quality

78.1

Maintenance

Vulnerability

99.6

License

Pull Requests

Open

3

Total

34

Closed

11

Merged

20

Issues

Open

8

Total

73

Closed

65

Releases

v6.0.0-rc.1

Updated on Feb 05, 2021

v5.0.0

Updated on Oct 12, 2017

v4.1.0

Updated on Jan 02, 2017

v4.0.0

Updated on Dec 14, 2016

v2.0.0

Updated on Jun 30, 2016

View All 5 releases

Languages

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

Bundlephobia

Maintainers

View All 87 Contributors

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

Last Day

68.9%

10,913

Compared to previous day

Last Week

9.3%

59,177

Compared to previous week

Last Month

-4.8%

258,332

Compared to previous month

Last Year

-12.2%

3,377,806

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

vue-router vuex

Dev Dependencies

buble jest typescript vue vue-router vuex

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 route module 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.route is 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

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

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