Skip to content

Class: RoleRbac<T, G> ​

Defined in: packages/core/src/rbac.ts:856

Permissions of a single role. Obtain with rbac.role('writer').

Type Parameters ​

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

Constructors ​

Constructor ​

ts
new RoleRbac<T, G>(
   rbac, 
   input, 
   guardName, 
   teamId, 
   actor?
): RoleRbac<T, G>;

Defined in: packages/core/src/rbac.ts:860

Parameters ​

ParameterType
rbacRbac<T>
inputRoleInput
guardNamestring
teamIdTeamId
actor?RbacActor

Returns ​

RoleRbac<T, G>

Properties ​

PropertyModifierTypeDefined in
guardNamereadonlystringpackages/core/src/rbac.ts:863
teamIdreadonlyTeamIdpackages/core/src/rbac.ts:864

Methods ​

get() ​

ts
get(): Promise<Role>;

Defined in: packages/core/src/rbac.ts:872

Returns the role, throwing RoleDoesNotExist if it can't be found.

Returns ​

Promise<Role>


getPermissionNames() ​

ts
getPermissionNames(): Promise<string[]>;

Defined in: packages/core/src/rbac.ts:952

Returns ​

Promise<string[]>


getPermissions() ​

ts
getPermissions(): Promise<Permission[]>;

Defined in: packages/core/src/rbac.ts:945

Returns ​

Promise<Permission[]>


givePermissionTo() ​

ts
givePermissionTo(...permissions): Promise<RoleRbac<T, G>>;

Defined in: packages/core/src/rbac.ts:877

Parameters ​

ParameterType
...permissionsMany<PermissionInput<PermissionsOf<GuardTypes<T, G>>>>[]

Returns ​

Promise<RoleRbac<T, G>>


hasPermissionTo() ​

ts
hasPermissionTo(permission): Promise<boolean>;

Defined in: packages/core/src/rbac.ts:956

Parameters ​

ParameterType
permissionPermissionInput<PermissionName<T, G>>

Returns ​

Promise<boolean>


revokePermissionTo() ​

ts
revokePermissionTo(...permissions): Promise<RoleRbac<T, G>>;

Defined in: packages/core/src/rbac.ts:888

Parameters ​

ParameterType
...permissionsMany<PermissionInput<PermissionsOf<GuardTypes<T, G>>>>[]

Returns ​

Promise<RoleRbac<T, G>>


syncPermissions() ​

ts
syncPermissions(...permissions): Promise<RoleRbac<T, G>>;

Defined in: packages/core/src/rbac.ts:900

Replaces all permissions of the role with the given ones.

Parameters ​

ParameterType
...permissionsMany<PermissionInput<PermissionsOf<GuardTypes<T, G>>>>[]

Returns ​

Promise<RoleRbac<T, G>>


syncSubjects() ​

ts
syncSubjects(subjectType, ids): Promise<RoleRbac<T, G>>;

Defined in: packages/core/src/rbac.ts:922

Makes the given subjects of subjectType the only ones holding this role in the current scope (spatie v7.4: Role::syncModels()). Other subject types are untouched.

Parameters ​

ParameterType
subjectTypestring
idsreadonly Id[]

Returns ​

Promise<RoleRbac<T, G>>

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