Class Permissions

Hierarchy

Permissions

Index

Constructors

constructor

Properties

value

Accessors

Methods

Constructors

constructor

new Permissions(...perms: string[]): Permissions

- Defined in src/structures/Permissions.ts:157
Parameters
- Rest ...perms: string[]
  
  The data to resolve permissions from.
Returns Permissions

Properties

value

value: string[]

The string permission value.

Accessors

Static ADMIN

get ADMIN(): readonly Flags[]

- Defined in src/structures/Permissions.ts:143
Returns readonly Flags[]
The admin permissions.

Static ALLOCATIONS

get ALLOCATIONS(): readonly Flags[]

- Defined in src/structures/Permissions.ts:102
Returns readonly Flags[]
All the server allocation permissions.

Static BACKUPS

get BACKUPS(): readonly Flags[]

- Defined in src/structures/Permissions.ts:92
Returns readonly Flags[]
All the server backup permissions.

Static CONTROL

get CONTROL(): readonly Flags[]

- Defined in src/structures/Permissions.ts:59
Returns readonly Flags[]
All the server control permissions.

Static DATABASES

get DATABASES(): readonly Flags[]

- Defined in src/structures/Permissions.ts:117
Returns readonly Flags[]
All the server database permissions.

Static FILES

get FILES(): readonly Flags[]

- Defined in src/structures/Permissions.ts:79
Returns readonly Flags[]
All of the server file permissions.

Static SCHEDULES

get SCHEDULES(): readonly Flags[]

- Defined in src/structures/Permissions.ts:128
Returns readonly Flags[]
All the server schedule permissions.

Static SETTINGS

get SETTINGS(): readonly Flags[]

- Defined in src/structures/Permissions.ts:138
Returns readonly Flags[]
All the server settings permissions.

Static STARTUPS

get STARTUPS(): readonly Flags[]

- Defined in src/structures/Permissions.ts:112
Returns readonly Flags[]
All the server startup permissions.

Static USERS

get USERS(): readonly Flags[]

- Defined in src/structures/Permissions.ts:69
Returns readonly Flags[]
All of the user/subuser permissions.

Methods

add

add(...perms: string[]): Permissions

- Defined in src/structures/Permissions.ts:218
Adds the specified permissions to the current value.

Parameters
- Rest ...perms: string[]
  
  The permissions to add.
Returns Permissions
The updated permissions instance.

hasAll

hasAll(...perms: string[]): boolean

- Defined in src/structures/Permissions.ts:195
Parameters
- Rest ...perms: string[]
  
  The permissions to check for.
Returns boolean
True if the current value has all of the specified permissions.

hasAny

hasAny(...perms: string[]): boolean

- Defined in src/structures/Permissions.ts:186
Parameters
- Rest ...perms: string[]
  
  The permissions to check for.
Returns boolean
True if the current value has any of the specified permissions.

isAdmin

isAdmin(): boolean

- Defined in src/structures/Permissions.ts:203
Returns boolean
True if the current value includes administrative permissions.

remove

remove(...perms: string[]): Permissions

- Defined in src/structures/Permissions.ts:228
Removes the specified permissions from the current value.

Parameters
- Rest ...perms: string[]
  
  The permissions to remove.
Returns Permissions
The updated permissions instance.

serialize

serialize(): Record<string, boolean>

- Defined in src/structures/Permissions.ts:238
Returns Record<string, boolean>
An object with all the permissions having true or false values if they are currently present.

Static resolve

resolve(...perms: string[]): string[]

- Defined in src/structures/Permissions.ts:166
Resolves a permissions object from a specified source.

Parameters
- Rest ...perms: string[]
  
  The permissions to resolve.
Returns string[]
The resolved permissions.

Generated using TypeDoc