Interface: SvelteRbac<T, G>
Defined in: packages/sveltekit/src/context.svelte.ts:31
The reactive RBAC state of setRbacContext() / getRbacContext(). Every check reads rune state, so calling it in markup, $derived or $effect re-runs when the snapshot changes.
T (a names type like AppRbac, or typeof rbac) types the names; without it, any string. With per-guard names, G is the guard the snapshot was made in (the default guard by default).
This is for UI only: the server must always enforce authorization.
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends RbacTypeConfig | Rbac<RbacTypeConfig> | DefaultRbacTypes |
G extends string | DefaultGuardName<TypesOf<T>> |
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
isGuest | readonly | boolean | true when the snapshot is null / undefined: no subject (reactive). | packages/sveltekit/src/context.svelte.ts:38 |
snapshot | readonly | Readonly<RbacSnapshot> | The current snapshot (reactive). A guest's is empty. | packages/sveltekit/src/context.svelte.ts:36 |
Methods
can()
can(permission): boolean;Defined in: packages/sveltekit/src/context.svelte.ts:40
true if the user has the permission (or, for a list, ALL of them).
Parameters
| Parameter | Type |
|---|---|
permission | NameList<PermissionName<TypesOf<T>, G>> |
Returns
boolean
canAll()
canAll(permissions): boolean;Defined in: packages/sveltekit/src/context.svelte.ts:43
Parameters
| Parameter | Type |
|---|---|
permissions | NameList<PermissionName<TypesOf<T>, G>> |
Returns
boolean
canAny()
canAny(permissions): boolean;Defined in: packages/sveltekit/src/context.svelte.ts:42
Parameters
| Parameter | Type |
|---|---|
permissions | NameList<PermissionName<TypesOf<T>, G>> |
Returns
boolean
cannot()
cannot(permission): boolean;Defined in: packages/sveltekit/src/context.svelte.ts:41
Parameters
| Parameter | Type |
|---|---|
permission | NameList<PermissionName<TypesOf<T>, G>> |
Returns
boolean
hasAllRoles()
hasAllRoles<S>(roles): boolean;Defined in: packages/sveltekit/src/context.svelte.ts:47
Type Parameters
| Type Parameter |
|---|
S extends NameList |
Parameters
| Parameter | Type |
|---|---|
roles | S & CheckNames<S, RoleName<TypesOf<T>, G>> |
Returns
boolean
hasAnyRole()
hasAnyRole<S>(roles): boolean;Defined in: packages/sveltekit/src/context.svelte.ts:46
Type Parameters
| Type Parameter |
|---|
S extends NameList |
Parameters
| Parameter | Type |
|---|---|
roles | S & CheckNames<S, RoleName<TypesOf<T>, G>> |
Returns
boolean
hasRole()
hasRole<S>(roles): boolean;Defined in: packages/sveltekit/src/context.svelte.ts:45
true if the user has the role, or ANY of the roles. Supports 'writer|editor'.
Type Parameters
| Type Parameter |
|---|
S extends NameList |
Parameters
| Parameter | Type |
|---|---|
roles | S & CheckNames<S, RoleName<TypesOf<T>, G>> |
Returns
boolean
isSuperAdmin()
isSuperAdmin(): boolean;Defined in: packages/sveltekit/src/context.svelte.ts:49
true if the user has one of the configured superAdminRoles.
Returns
boolean
