Class PermissionGroup

A collection of permissions.

Hierarchy (View Summary)

PermissionGroup
- Authorisation

Implements

Index

Constructors

Properties

Methods

[iterator] getAll has hasAll

Constructors

constructor

new PermissionGroup(permissions: Iterable<Permission>): PermissionGroup
Create a new permission group.
Parameters
- permissions: Iterable<Permission>
  The permissions in this group.
Returns PermissionGroup
- Defined in src/auth/PermissionGroup.ts:14

Properties

`Protected` `Readonly`permissions

permissions: Set<Permission> = ...

Methods

[iterator]

"[iterator]"(): Generator<Permission, void, unknown>
An iterator over the permissions in this group.

Returns Generator<Permission, void, unknown>
Implementation of Iterable.[iterator]
- Defined in src/auth/PermissionGroup.ts:45

getAll

getAll(): readonly Permission[]
All permissions in this group.

Returns readonly Permission[]
- Defined in src/auth/PermissionGroup.ts:52

has

has(permission: Permission): boolean
Check if the group has a specific permission.
Parameters
- permission: Permission
  The permission to check.
Returns boolean
Implementation of Permissible.has
- Defined in src/auth/PermissionGroup.ts:24

hasAll

hasAll(permissions: Iterable<Permission>): boolean
Check that the group has all the specified permissions.
Parameters
- permissions: Iterable<Permission>
  The permissions to check.
Returns boolean
- Defined in src/auth/PermissionGroup.ts:35