Class PermissionGroup

Implements

IPermissionGroup<Map<string, string[]>>

Index

Constructors

Properties

identifier permissions

Methods

createPermission fromObject toObject

Constructors

constructor

new PermissionGroup(
identifier: string,
permissions?: IPermissionDefinition[],
): PermissionGroup
Create a new permission group instance.
Parameters
- identifier: string
  The identifier of the group.
- Optionalpermissions: IPermissionDefinition[]
  The permissions of the group.
Returns PermissionGroup
- Defined in packages/core/src/permissions/group.ts:19

Properties

`Readonly`identifier

identifier: string

The identifier of the permission group.

`Readonly`permissions

permissions: Map<string, string[]> = ...

The permissions within the group and their commands.

Methods

createPermission

createPermission(identifier: string, commands?: string[]): string[]
Create a new permission within the group.
Parameters
- identifier: string
  The identifier of the permission.
- commands: string[] = []
  The commands that the permission allows.
Returns string[]
The commands that the permission allows.
- Defined in packages/core/src/permissions/group.ts:40

`Static`fromObject

fromObject(group: IPermissionGroup): PermissionGroup
Parameters
- group: IPermissionGroup
Returns PermissionGroup
- Defined in packages/core/src/permissions/group.ts:70

`Static`toObject

toObject(group: PermissionGroup): IPermissionGroup
Parameters
- group: PermissionGroup
Returns IPermissionGroup
- Defined in packages/core/src/permissions/group.ts:58