Skip to content

Interface: NextRbacOptions<T, G> ​

Defined in: packages/next/src/server.ts:25

G is the type of guard: any string by default; createNextRbac() infers it to type the helpers.

Type Parameters ​

Type ParameterDefault type
T extends RbacTypeConfigDefaultRbacTypes
G extends stringstring

Properties ​

PropertyTypeDescriptionDefined in
getSubject() => MaybePromise<Subject | null | undefined>Resolves the current user (e.g. from Auth.js auth()). Return null for guests.packages/next/src/server.ts:29
guard?GDefault guard for every check. Default: the rbac instance's defaultGuard. With per-guard names, it must be one of the typed guards (checked by createNextRbac()), and the helpers take its names.packages/next/src/server.ts:34
loginUrl?stringWhere require*() redirects guests. Without it, guests get notFound().packages/next/src/server.ts:38
onUnauthenticated?() => neverReplaces the default guest handling of require*() (must throw, e.g. () => redirect('/login')).packages/next/src/server.ts:40
onUnauthorized?() => neverReplaces the default notFound() of require*() (must throw, e.g. () => forbidden()).packages/next/src/server.ts:42
rbacRbac<T>Your createRbac(...) instance. Its typed names (createRbac<{ permissions: ...; roles: ... }>) flow into every helper.packages/next/src/server.ts:27
team?| TeamId | (() => MaybePromise<TeamId | undefined>)Default team for every check — a value, or a function (e.g. reading the current tenant).packages/next/src/server.ts:36

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