requireAuth

Overview

Require the user to be authenticated.

Signature

requireAuth(redirectTo, to, router, pinia)

Parameters

Name	Type	Required	Description
redirectTo	string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric	yes	Where to redirect if not authenticated.
to	RouteLocationNormalizedGeneric	yes	The target route.
router	Router	yes	The router instance.
pinia	Pinia	yes	The Pinia instance.

Returns

Promise

The redirect route if needed. Rejects with the request error when the current-user request fails, which rejects the navigation.

Examples

import { requireAuth } from "@vueda/router/guards";
import { createRouter, createWebHistory } from "vue-router";

const router = createRouter({
  history: createWebHistory(import.meta.env.BASE_URL),
  routes: [
    {
      path: '/auth-required/',
      name: 'auth-required',
      component: () => import('@/views/ViewAuthRequired.vue'),
      beforeEnter: (to, from) => requireAuth({ name: "log-in" }, to, router),
    },
    // other routes
  ],
});

export default router;

Source

client/lib/router/guards.js:125