Class Authorisation<T>

A permission group with additional data.

Type Parameters

T

Hierarchy (View Summary)

PermissionGroup
- Authorisation

Index

Constructors

Properties

data permissions

Methods

[iterator] getAll has hasAll

Constructors

constructor

new Authorisation<T>(
permissions: Iterable<Permission>,
data: T,
): Authorisation<T>
Create a new authorisation.
Type Parameters
- T
Parameters
- permissions: Iterable<Permission>
  The permissions of the authorisation.
- data: T
  Additional authentication data.
Returns Authorisation<T>
Overrides PermissionGroup.constructor
- Defined in src/auth/Authorisation.ts:18

Properties

`Readonly`data

data: T

Additional authentication data.

`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>
Inherited from PermissionGroup.[iterator]
- Defined in src/auth/PermissionGroup.ts:45

getAll

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

Returns readonly Permission[]
Inherited from PermissionGroup.getAll
- 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
Inherited from PermissionGroup.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
Inherited from PermissionGroup.hasAll
- Defined in src/auth/PermissionGroup.ts:35