Interface: RbacChecker
Defined in: packages/react/src/checker.ts:14
Synchronous checks against a RbacSnapshot.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
isSuperAdmin | readonly | boolean | true if the subject has one of the configured superAdminRoles. | packages/react/src/checker.ts:18 |
loading | readonly | boolean | true while the snapshot is still being fetched (the loading option). Every check, cannot included, returns false meanwhile. | packages/react/src/checker.ts:20 |
permissions | readonly | readonly string[] | - | packages/react/src/checker.ts:16 |
roles | readonly | readonly string[] | - | packages/react/src/checker.ts:15 |
Methods
can()
ts
can(permission): boolean;Defined in: packages/react/src/checker.ts:21
Parameters
| Parameter | Type |
|---|---|
permission | string |
Returns
boolean
canAll()
ts
canAll(...permissions): boolean;Defined in: packages/react/src/checker.ts:26
true if ALL of the permissions are granted. false for an empty list (deny by default, like the Vue package).
Parameters
| Parameter | Type |
|---|---|
...permissions | Many<string>[] |
Returns
boolean
canAny()
ts
canAny(...permissions): boolean;Defined in: packages/react/src/checker.ts:24
true if ANY of the permissions is granted. false for an empty list.
Parameters
| Parameter | Type |
|---|---|
...permissions | Many<string>[] |
Returns
boolean
cannot()
ts
cannot(permission): boolean;Defined in: packages/react/src/checker.ts:22
Parameters
| Parameter | Type |
|---|---|
permission | string |
Returns
boolean
hasAllRoles()
ts
hasAllRoles(...roles): boolean;Defined in: packages/react/src/checker.ts:30
Parameters
| Parameter | Type |
|---|---|
...roles | Many<string>[] |
Returns
boolean
hasAnyRole()
ts
hasAnyRole(...roles): boolean;Defined in: packages/react/src/checker.ts:29
Parameters
| Parameter | Type |
|---|---|
...roles | Many<string>[] |
Returns
boolean
hasRole()
ts
hasRole(roles): boolean;Defined in: packages/react/src/checker.ts:28
true if the subject has the role — or ANY of the roles when given an array.
Parameters
| Parameter | Type |
|---|---|
roles | Many<string> |
Returns
boolean
