Skip to content

Interface: Guards<T, A> ​

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

Type Parameters ​

Type ParameterDefault type
T extends RbacTypeConfigDefaultRbacTypes
A extends RouteArgsRouteArgs

Properties ​

PropertyTypeDescriptionDefined in
canAllGuard<PermissionsOf<GuardTypes<T, DefaultGuardName<T>>>, RouteGuardOptions<A>, A, SubjectRbac<T, DefaultGuardName<T>>>spatie v8.5 canAll(): requires EVERY listed entry; a 'a|b' entry still means "a or b".packages/react-router/src/server.ts:136
canAnyGuard<PermissionsOf<GuardTypes<T, DefaultGuardName<T>>>, RouteGuardOptions<A>, A, SubjectRbac<T, DefaultGuardName<T>>>spatie v8.5 canAny(): requires ANY of the listed permissions.packages/react-router/src/server.ts:134
requirePermissionGuard<PermissionsOf<GuardTypes<T, DefaultGuardName<T>>>, PermissionGuardOptions<A>, A, SubjectRbac<T, DefaultGuardName<T>>>All arguments are required, pipes mean any, { any: true } means any of them.packages/react-router/src/server.ts:128
requireRoleGuard<RolesOf<GuardTypes<T, DefaultGuardName<T>>>, RoleGuardOptions<A>, A, SubjectRbac<T, DefaultGuardName<T>>>Any of the roles, { all: true } for all of them.packages/react-router/src/server.ts:130
requireRoleOrPermissionGuard< | PermissionsOf<GuardTypes<T, DefaultGuardName<T>>> | RolesOf<GuardTypes<T, DefaultGuardName<T>>>, RoleOrPermissionGuardOptions<A>, A, SubjectRbac<T, DefaultGuardName<T>>>Any of the names, as a role OR a permission.packages/react-router/src/server.ts:132

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