readme.md

Middleware for Vue

Main features

This is a fork from vue-middleware to apply asynchronous call for middleware functions

• Injecting custom object for middlewares
• Adjusting multiple middleware rules
• Easy implementation

Installation

$ npm i vue-router-middleware-system

Usage in 3 steps

1. Register the module in the main file

You can also inject any object to a module to take it in middleware method(recommended vuex store, it will be mentioned below)

// main.js

import router from "./router"
import middleware from "vue-router-middleware-system"

router.beforeEach(middleware())

2. Specify logic

You can put your middleware methods under any folder. There is no rule for this.

// middleware/authentication.js

export default ({ to, from, next }) => {
  // Your custom if statement
  if (!userLoggedIn) {
    next("/login")
    return false
  }
  next()
}

Mentioned params to, from, and next completely same with Vue Router navigation guard params

3. Adjust middleware for any route under meta key

// router/index.js

import authentication from "../middleware/authentication"

const routes = [
  {
    path: "/user-profile",
    meta: {
      middleware: [authentication],
    },
  },
]

Injecting custom object (recommended vuex store)

You can inject any object

// main.js

import router from "./router"
import store from "./store"

import middleware from "@grafikri/vue-middleware"

router.beforeEach(middleware({ store }))

to retrive it inside of middleware method

// middleware/authentication.js

export default ({ store, next }) => {
  if (!store.state.user.loggedIn) {
    next("/login")
    return false
  }
  next()
}

There is one important rule for chaining that you must return false if you want to stop the next middleware method.

Defining multiple middlewares

You can define more than one middleware methods that will be invoked respectively.

// router/index.js

import authentication from "../middleware/authentication"
import authorization from "../middleware/authorization"

const routes = [
  {
    path: "/payments",
    meta: {
      middleware: [authentication, authorization],
    },
  },
]