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 Parameter | Default type |
|---|---|
E extends RbacEvent | RbacEvent |
T extends RbacTypeConfig | DefaultRbacTypes |
G extends string | DefaultGuardName<T> |
Methods
canAll()
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
| Parameter | Type |
|---|---|
event | E |
...args | A & GuardRequirementArgs<A, T, "permission", G, RequireGuardOptions> |
Returns
Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>
canAny()
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
| Parameter | Type |
|---|---|
event | E |
...args | A & GuardRequirementArgs<A, T, "permission", G, RequireGuardOptions> |
Returns
Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>
requirePermission()
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
| Parameter | Type |
|---|---|
event | E |
...args | A & GuardRequirementArgs<A, T, "permission", G, RequirePermissionOptions> |
Returns
Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>
requireRole()
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
| Parameter | Type |
|---|---|
event | E |
...args | A & GuardRequirementArgs<A, T, "role", G, RequireRoleOptions> |
Returns
Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>
requireRoleOrPermission()
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
| Parameter | Type |
|---|---|
event | E |
...args | A & GuardRequirementArgs<A, T, "role_or_permission", G, RequireGuardOptions> |
Returns
Promise<SubjectRbac<T, ScopedGuardName<T, RequirementGuard<A, G>>>>
resolve()
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
| Parameter | Type |
|---|---|
event | E |
Returns
Promise<SubjectRbac<T, G> | null>
snapshot()
snapshot(event): Promise<RbacSnapshot | null>;Defined in: packages/nuxt/src/server.ts:185
The current subject's { roles, permissions }, or null for guests.
Parameters
| Parameter | Type |
|---|---|
event | E |
Returns
Promise<RbacSnapshot | null>
