Class UserPermissions

constructor

• new UserPermissions(data?): UserPermissions

• Constructs a new instance of UserPermissions with optional initial data.

  Parameters

  • Optionaldata: UserPermissionFlags

    An object containing the initial permissions.

  Returns UserPermissions

StaticFlags

allow

• allow(permissions): UserPermissions

• Grants the specified permissions.

  Parameters

  • permissions: UserPermissionResolvable

    The permissions to grant.

  Returns UserPermissions

  The updated UserPermissions instance.

deny

• deny(permissions): UserPermissions

• Denies the specified permissions.

  Parameters

  • permissions: UserPermissionResolvable

    The permissions to deny.

  Returns UserPermissions

  The updated UserPermissions instance.

equals

• equals(other): 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): 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.

StaticisValid

• isValid(permission): boolean

• Checks if the provided permission is valid.

  Parameters

  • permission: string

    The permission to validate.

  Returns boolean

  true if the permission is valid, otherwise false.