Skip to content

Interface: ScopedRbacServer<E, T, G> ​

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

The helpers of createRbacServer() when the engine has per-guard names (RbacTypeConfig['guards']): like RbacServer, but the names are those of the guard each call checks in, its { guard } option or else G (the guard of createRbacServer()), and the subject it returns is typed for that guard. requirePermission(event, 'orders.read', { guard: 'api' }) takes the api names.

Type Parameters ​

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

Methods ​

canAll() ​

ts
canAll<A>(event, ...args): Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>;

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

spatie v8.5 canAll(): requires EVERY listed entry; a 'a|b' entry still means "a or b".

Type Parameters ​

Type Parameter
A extends readonly ( | RequireGuardOptions | RequirementNames)[]

Parameters ​

ParameterType
eventE
...argsA & GuardRequirementArgs<A, T, "permission", G, RequireGuardOptions>

Returns ​

Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>


canAny() ​

ts
canAny<A>(event, ...args): Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>;

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

spatie v8.5 canAny(): requires ANY of the listed permissions.

Type Parameters ​

Type Parameter
A extends readonly ( | RequireGuardOptions | RequirementNames)[]

Parameters ​

ParameterType
eventE
...argsA & GuardRequirementArgs<A, T, "permission", G, RequireGuardOptions>

Returns ​

Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>


requirePermission() ​

ts
requirePermission<A>(event, ...args): Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>;

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

Like Express requirePermission: arguments are all required, pipes mean any, { any: true }. With { guard: 'api' } the check (and the returned subject) is in that guard.

Type Parameters ​

Type Parameter
A extends readonly ( | RequirePermissionOptions | RequirementNames)[]

Parameters ​

ParameterType
eventE
...argsA & GuardRequirementArgs<A, T, "permission", G, RequirePermissionOptions>

Returns ​

Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>


requireRole() ​

ts
requireRole<A>(event, ...args): Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>;

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

Like Express requireRole: any of the roles, { all: true } for all, { guard: 'api' } (spatie's role:admin,api).

Type Parameters ​

Type Parameter
A extends readonly ( | RequireRoleOptions | RequirementNames)[]

Parameters ​

ParameterType
eventE
...argsA & GuardRequirementArgs<A, T, "role", G, RequireRoleOptions>

Returns ​

Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>


requireRoleOrPermission() ​

ts
requireRoleOrPermission<A>(event, ...args): Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>;

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

Like Express requireRoleOrPermission: any of the names as a role OR a permission.

Type Parameters ​

Type Parameter
A extends readonly ( | RequireGuardOptions | RequirementNames)[]

Parameters ​

ParameterType
eventE
...argsA & GuardRequirementArgs<A, T, "role_or_permission", G, RequireGuardOptions>

Returns ​

Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>


resolve() ​

ts
resolve(event): Promise<SubjectRbac<T, G> | null>;

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

Resolves the subject once per request (cached per helper instance) and stores it on event.context.rbac (a SubjectRbac, or null for guests) unless another instance did first. The Nuxt plugin reads it to hydrate the client.

Parameters ​

ParameterType
eventE

Returns ​

Promise<SubjectRbac<T, G> | null>


snapshot() ​

ts
snapshot(event): Promise<RbacSnapshot | null>;

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

The current subject's { roles, permissions }, or null for guests.

Parameters ​

ParameterType
eventE

Returns ​

Promise<RbacSnapshot | null>

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