Interface: RouteGuardOptions
Defined in: packages/sveltekit/src/server/guards.ts:78
The options every guard takes as its last argument: the handlers plus guard. A guard's own handlers win over the defaults of createGuards().
Extends
Extended by
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
exposeRequirements? | boolean | Include the required roles/permissions in the default 403 body (required). Default: false (like spatie's display_permission_in_exception). | GuardHandlers.exposeRequirements | packages/sveltekit/src/server/guards.ts:71 |
forbiddenRedirect? | string | Redirect users without access here (redirect(303, url)) instead of the 403 error. | GuardHandlers.forbiddenRedirect | packages/sveltekit/src/server/guards.ts:66 |
guard? | string | Check in this guard instead of the request's (subject.withScope({ guard })), like spatie's role:admin,api. Default: the guard of rbacHandle(). | - | packages/sveltekit/src/server/guards.ts:83 |
onForbidden? | GuardHandler | Called when the subject lacks access. Wins over forbiddenRedirect. Default: error(403, { error: 'FORBIDDEN', reason, message }). | GuardHandlers.onForbidden | packages/sveltekit/src/server/guards.ts:62 |
onUnauthenticated? | GuardHandler | Called when there is no subject (event.locals.rbac is null). Wins over unauthenticatedRedirect. Default: error(401, { error: 'UNAUTHENTICATED', message }). | GuardHandlers.onUnauthenticated | packages/sveltekit/src/server/guards.ts:57 |
unauthenticatedRedirect? | string | Redirect guests here (redirect(303, url)) instead of the 401 error. Handy for page loads: '/login'. | GuardHandlers.unauthenticatedRedirect | packages/sveltekit/src/server/guards.ts:64 |
