Skip to content

Interface: GuardHandlers<A> ​

Defined in: packages/react-router/src/server.ts:70

Extended by ​

Type Parameters ​

Type ParameterDefault type
A extends RouteArgsRouteArgs

Properties ​

PropertyTypeDescriptionDefined in
exposeRequirements?booleanInclude the required roles/permissions in the default 403 body (required). Default: false (like spatie's display_permission_in_exception).packages/react-router/src/server.ts:86
forbiddenRedirect?string | ((args) => string)Redirect users without access here (302) instead of the 403.packages/react-router/src/server.ts:81
onForbidden?GuardHandler<A>Called when the subject lacks access. Wins over forbiddenRedirect. Default: a 403 JSON Response.packages/react-router/src/server.ts:74
onUnauthenticated?GuardHandler<A>Called when there is no subject. Wins over unauthenticatedRedirect. Default: a 401 JSON Response.packages/react-router/src/server.ts:72
unauthenticatedRedirect?string | ((args) => string)Redirect guests here (302) instead of the 401. Handy for page loaders: '/login'. A function gets the args, e.g. to keep the page: ({ request }) => /login?redirectTo=${new URL(request.url).pathname}``.packages/react-router/src/server.ts:79

Released under the MIT License. Inspired by spatie/laravel-permission.