Skip to content

Interface: RbacChecker ​

Defined in: packages/sveltekit/src/checker.ts:23

Synchronous checks against a RbacSnapshot, with the same rules as the Vue package:

  • can(list) / canAll(list) need ALL of the permissions, canAny(list) ANY of them;
  • hasRole('a|b') / hasRole(['a', 'b']) / hasAnyRole need ANY of the roles, hasAllRoles ALL of them;
  • a name in the snapshot's denied (snapshot({ checkBefore })) is never allowed, super-admins included;
  • an empty list is never allowed (deny by default).

This is for UI only: the server must always enforce authorization.

Properties ​

PropertyModifierTypeDescriptionDefined in
isGuestreadonlybooleantrue when there is no subject (a null / undefined snapshot).packages/sveltekit/src/checker.ts:27
snapshotreadonlyReadonly<RbacSnapshot>The snapshot the checks run against. A guest's is empty.packages/sveltekit/src/checker.ts:25

Methods ​

can() ​

ts
can(permission): boolean;

Defined in: packages/sveltekit/src/checker.ts:29

true if the subject has the permission (or, for a list, ALL of them).

Parameters ​

ParameterType
permissionNameList

Returns ​

boolean


canAll() ​

ts
canAll(permissions): boolean;

Defined in: packages/sveltekit/src/checker.ts:35

true if the subject has ALL of the permissions.

Parameters ​

ParameterType
permissionsNameList

Returns ​

boolean


canAny() ​

ts
canAny(permissions): boolean;

Defined in: packages/sveltekit/src/checker.ts:33

true if the subject has ANY of the permissions.

Parameters ​

ParameterType
permissionsNameList

Returns ​

boolean


cannot() ​

ts
cannot(permission): boolean;

Defined in: packages/sveltekit/src/checker.ts:31

!can(permission).

Parameters ​

ParameterType
permissionNameList

Returns ​

boolean


hasAllRoles() ​

ts
hasAllRoles(roles): boolean;

Defined in: packages/sveltekit/src/checker.ts:39

Parameters ​

ParameterType
rolesNameList

Returns ​

boolean


hasAnyRole() ​

ts
hasAnyRole(roles): boolean;

Defined in: packages/sveltekit/src/checker.ts:38

Parameters ​

ParameterType
rolesNameList

Returns ​

boolean


hasRole() ​

ts
hasRole(roles): boolean;

Defined in: packages/sveltekit/src/checker.ts:37

true if the subject has the role, or ANY of the roles. Supports 'writer|editor'.

Parameters ​

ParameterType
rolesNameList

Returns ​

boolean


isSuperAdmin() ​

ts
isSuperAdmin(): boolean;

Defined in: packages/sveltekit/src/checker.ts:41

true if the subject has one of the configured superAdminRoles.

Returns ​

boolean

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