Skip to content

refactor: define types, router 4 support #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
reslear wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

refactor: define types, router 4 support #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 56 additions & 13 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,61 @@
import { Route, NavigationGuardNext } from 'vue-router'
import { store } from '@/store'
import {
NavigationGuard,
NavigationGuardNext,
RouteLocationNormalized,
} from 'vue-router'

export default (datas?: any) => async (to: Route, from: Route, next: NavigationGuardNext) => {
// TODO: refactor
declare interface RouterMiddlewareContext {
Copy link
Owner

@grafikri grafikri Jun 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this approach is not true. Because this line restricts the developer from being sent custom data to the middleware.

Copy link
Author

@reslear reslear Jun 17, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

of course, need like declare module 'name'
for example vue router meta

declare module 'vue-router' {
  interface RouteMeta {
    // is optional
    isAdmin?: boolean
    // must be declared by every route
    requiresAuth: boolean
  }
}

but i don't understand how it works, need investigate, maybe you help?

store: typeof store
}

if (to.meta?.middleware?.length) {
const arr = to.meta.middleware
for (let index = 0; index < arr.length; index++) {
const method: Function = arr[index];
const result = method({...datas, to, from, next})
if (result === false) {
break
type RouterGuardCb = {
to: RouteLocationNormalized
from: RouteLocationNormalized
next: NavigationGuardNext
}

type DefineRouterMiddleware = (
ctx: Partial<RouterMiddlewareContext> & RouterGuardCb
) => ReturnType<NavigationGuard> | false


/**
* function helper for define types
* @example
* defineRouterMiddleware(({ from, to, store }) => {
* // code
* })
**/
export const defineRouterMiddleware = (
m: DefineRouterMiddleware
): DefineRouterMiddleware => m

declare module 'vue-router' {
interface RouteMeta {
middleware?: DefineRouterMiddleware[]
}
}

export const routerMiddleware =
(ctx: Partial<RouterMiddlewareContext> = {}) =>
async (
to: RouteLocationNormalized,
from: RouteLocationNormalized,
next: NavigationGuardNext
) => {
if (to.meta?.middleware?.length) {
const arr = to.meta.middleware
for (let index = 0; index < arr.length; index++) {
const method = arr[index]
const result = method({ ...ctx, to, from, next })
if (result === false) {
break
}
}
return
}
return
}

return next()
}
return next()
}