Skip to content

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 ParameterDefault type
T extends RbacTypeConfig | Rbac<RbacTypeConfig>DefaultRbacTypes
G extends stringDefaultGuardName<TypesOf<T>>

Properties ​

PropertyModifierTypeDescriptionDefined in
isGuestreadonlybooleantrue when the snapshot is null / undefined: no subject (reactive).packages/sveltekit/src/context.svelte.ts:38
snapshotreadonlyReadonly<RbacSnapshot>The current snapshot (reactive). A guest's is empty.packages/sveltekit/src/context.svelte.ts:36

Methods ​

can() ​

ts
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 ​

ParameterType
permissionNameList<PermissionName<TypesOf<T>, G>>

Returns ​

boolean


canAll() ​

ts
canAll(permissions): boolean;

Defined in: packages/sveltekit/src/context.svelte.ts:43

Parameters ​

ParameterType
permissionsNameList<PermissionName<TypesOf<T>, G>>

Returns ​

boolean


canAny() ​

ts
canAny(permissions): boolean;

Defined in: packages/sveltekit/src/context.svelte.ts:42

Parameters ​

ParameterType
permissionsNameList<PermissionName<TypesOf<T>, G>>

Returns ​

boolean


cannot() ​

ts
cannot(permission): boolean;

Defined in: packages/sveltekit/src/context.svelte.ts:41

Parameters ​

ParameterType
permissionNameList<PermissionName<TypesOf<T>, G>>

Returns ​

boolean


hasAllRoles() ​

ts
hasAllRoles<S>(roles): boolean;

Defined in: packages/sveltekit/src/context.svelte.ts:47

Type Parameters ​

Type Parameter
S extends NameList

Parameters ​

ParameterType
rolesS & CheckNames<S, RoleName<TypesOf<T>, G>>

Returns ​

boolean


hasAnyRole() ​

ts
hasAnyRole<S>(roles): boolean;

Defined in: packages/sveltekit/src/context.svelte.ts:46

Type Parameters ​

Type Parameter
S extends NameList

Parameters ​

ParameterType
rolesS & CheckNames<S, RoleName<TypesOf<T>, G>>

Returns ​

boolean


hasRole() ​

ts
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 ​

ParameterType
rolesS & CheckNames<S, RoleName<TypesOf<T>, G>>

Returns ​

boolean


isSuperAdmin() ​

ts
isSuperAdmin(): boolean;

Defined in: packages/sveltekit/src/context.svelte.ts:49

true if the user has one of the configured superAdminRoles.

Returns ​

boolean

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