Browse Source

chore(nc-gui): middleware comments

pull/3801/head
braks 2 years ago
parent
commit
dc0237e3de
  1. 12
      packages/nc-gui/middleware/auth.global.ts

12
packages/nc-gui/middleware/auth.global.ts

@ -11,7 +11,9 @@ import { useApi, useGlobal, useRoles } from '#imports'
* the user is redirected to the home page. * the user is redirected to the home page.
* *
* By default, we assume that auth is required * By default, we assume that auth is required
* If not required, mark the page as * If not required, mark the page as requiresAuth: false
*
* @example
* ``` * ```
* definePageMeta({ * definePageMeta({
* requiresAuth: false * requiresAuth: false
@ -19,17 +21,11 @@ import { useApi, useGlobal, useRoles } from '#imports'
* ``` * ```
* *
* If auth should be circumvented completely mark the page as public * If auth should be circumvented completely mark the page as public
* ```
* definePageMeta({
* public: true
* })
* ```
* *
* @example * @example
* ``` * ```
* definePageMeta({ * definePageMeta({
* requiresAuth: false, * public: true
* ...
* }) * })
* ``` * ```
*/ */

Loading…
Cancel
Save