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 Parameter | Default type |
|---|---|
T extends RbacTypeConfig | DefaultRbacTypes |
G extends string | DefaultGuardName<T> |
Constructors
Constructor
new RoleRbac<T, G>(
rbac,
input,
guardName,
teamId,
actor?
): RoleRbac<T, G>;Defined in: packages/core/src/rbac.ts:860
Parameters
| Parameter | Type |
|---|---|
rbac | Rbac<T> |
input | RoleInput |
guardName | string |
teamId | TeamId |
actor? | RbacActor |
Returns
RoleRbac<T, G>
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
guardName | readonly | string | packages/core/src/rbac.ts:863 |
teamId | readonly | TeamId | packages/core/src/rbac.ts:864 |
Methods
get()
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()
getPermissionNames(): Promise<string[]>;Defined in: packages/core/src/rbac.ts:952
Returns
Promise<string[]>
getPermissions()
getPermissions(): Promise<Permission[]>;Defined in: packages/core/src/rbac.ts:945
Returns
Promise<Permission[]>
givePermissionTo()
givePermissionTo(...permissions): Promise<RoleRbac<T, G>>;Defined in: packages/core/src/rbac.ts:877
Parameters
| Parameter | Type |
|---|---|
...permissions | Many<PermissionInput<PermissionsOf<GuardTypes<T, G>>>>[] |
Returns
Promise<RoleRbac<T, G>>
hasPermissionTo()
hasPermissionTo(permission): Promise<boolean>;Defined in: packages/core/src/rbac.ts:956
Parameters
| Parameter | Type |
|---|---|
permission | PermissionInput<PermissionName<T, G>> |
Returns
Promise<boolean>
revokePermissionTo()
revokePermissionTo(...permissions): Promise<RoleRbac<T, G>>;Defined in: packages/core/src/rbac.ts:888
Parameters
| Parameter | Type |
|---|---|
...permissions | Many<PermissionInput<PermissionsOf<GuardTypes<T, G>>>>[] |
Returns
Promise<RoleRbac<T, G>>
syncPermissions()
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
| Parameter | Type |
|---|---|
...permissions | Many<PermissionInput<PermissionsOf<GuardTypes<T, G>>>>[] |
Returns
Promise<RoleRbac<T, G>>
syncSubjects()
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
| Parameter | Type |
|---|---|
subjectType | string |
ids | readonly Id[] |
Returns
Promise<RoleRbac<T, G>>
