Skip to content

Interface: RbacServer<E, T> ​

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

The helpers returned by createRbacServer(). T comes from the rbac option: with typed names, every name (including each part of a 'a|b' list) must be one of them; untyped, any string is accepted. A call without names, or with options that are not the last argument, is a type error.

Type Parameters ​

Type ParameterDefault type
E extends RbacEventRbacEvent
T extends RbacTypeConfigDefaultRbacTypes

Methods ​

canAll() ​

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

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

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 & RequirementArgs<A, PermissionName<T>, RequireGuardOptions>

Returns ​

Promise<SubjectRbac<T, DefaultGuardName<T>>>


canAny() ​

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

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

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

Type Parameters ​

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

Parameters ​

ParameterType
eventE
...argsA & RequirementArgs<A, PermissionName<T>, RequireGuardOptions>

Returns ​

Promise<SubjectRbac<T, DefaultGuardName<T>>>


requirePermission() ​

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

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

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 & RequirementArgs<A, PermissionName<T>, RequirePermissionOptions>

Returns ​

Promise<SubjectRbac<T, DefaultGuardName<T>>>


requireRole() ​

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

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

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 & RequirementArgs<A, RoleName<T>, RequireRoleOptions>

Returns ​

Promise<SubjectRbac<T, DefaultGuardName<T>>>


requireRoleOrPermission() ​

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

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

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 & RequirementArgs<A, PermissionName<T> | RoleName<T>, RequireGuardOptions>

Returns ​

Promise<SubjectRbac<T, DefaultGuardName<T>>>


resolve() ​

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

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

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, DefaultGuardName<T>> | null>


snapshot() ​

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

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

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.