Class UserPermissions

Represents a set of user permissions and provides methods to manage them.

Index

Constructors

Properties

Methods

allow deny equals has toObject

Constructors

constructor

new UserPermissions(data?: UserPermissionFlags): UserPermissions
Constructs a new instance of UserPermissions with optional initial data.
Parameters
- Optionaldata: UserPermissionFlags
  An object containing the initial permissions.
Returns UserPermissions

Properties

`Static`Flags

Flags: Record<UserPermissionString, number>

A mapping of user permission strings to their numeric equivalents.

Methods

allow

allow(permissions: UserPermissionResolvable): UserPermissions
Grants the specified permissions.
Parameters
- permissions: UserPermissionResolvable
  The permissions to grant.
Returns UserPermissions
The updated UserPermissions instance.

deny

deny(permissions: UserPermissionResolvable): UserPermissions
Denies the specified permissions.
Parameters
- permissions: UserPermissionResolvable
  The permissions to deny.
Returns UserPermissions
The updated UserPermissions instance.

equals

equals(other: UserPermissions): boolean
Checks if this instance is equal to another UserPermissions instance.
Parameters
- other: UserPermissions
  The other instance to compare.
Returns boolean
true if both instances are equal, otherwise false.

has

has(permission: UserPermissionString): boolean
Checks if the specified permission is granted.
Parameters
- permission: UserPermissionString
  The permission to check.
Returns boolean
true if the permission is granted, otherwise false.

toObject

toObject(): UserPermissionFlags
Converts the permissions to a plain object representation.

Returns UserPermissionFlags
An object with permissions and their status.