Skip to content

Function: rbacMiddleware() ​

ts
function rbacMiddleware<E, T, G>(options): MiddlewareHandler<E & RbacEnv<T, ScopedGuardName<T, G>>>;

Defined in: packages/hono/src/middleware.ts:78

Resolves the current subject and sets c.var.rbac (a SubjectRbac, or null for guests).

ts
app.use(rbacMiddleware({ rbac, getSubject: (c) => (c.var.user ? { type: 'user', id: c.var.user.id } : null) }))

With a typed engine (createRbac<AppRbac>()), the returned middleware sets a typed c.var.rbac. When you pass your env explicitly, pass the engine's names too: rbacMiddleware<AppEnv, AppRbac>(...). With per-guard names, the guard option picks the names of c.var.rbac (rbacMiddleware<AppEnv, AppRbac, 'api'> when explicit).

Type Parameters ​

Type ParameterDefault type
E extends EnvEnv
T extends RbacTypeConfigDefaultRbacTypes
G extends stringDefaultGuardName<T>

Parameters ​

ParameterType
optionsRbacMiddlewareOptions<E, T, G> & (T extends object ? GuardOptions<CheckGuard<T, G>> : unknown)

Returns ​

MiddlewareHandler<E & RbacEnv<T, ScopedGuardName<T, G>>>

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