Skip to content

Function: createRbacServer() ​

ts
function createRbacServer<E, T, G>(options): RbacServerFor<E, T, ScopedGuardName<T, G>>;

Defined in: packages/nuxt/src/server.ts:260

Creates request helpers for Nitro event handlers.

ts
// server/utils/rbac.ts
export const rbacServer = createRbacServer({
  rbac,
  getSubject: async (event) => {
    const user = await getUserFromSession(event)
    return user ? { type: 'user', id: user.id } : null
  },
})

// server/api/articles.post.ts
export default defineEventHandler(async (event) => {
  await rbacServer.requirePermission(event, 'articles.create')
})

With a typed engine (createRbac<AppTypes>(...)), names are checked: requirePermission(event, 'typo') is a type error.

Type Parameters ​

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

Parameters ​

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

Returns ​

RbacServerFor<E, T, ScopedGuardName<T, G>>

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