Class UserManager

Index

Constructors

Properties

Accessors

permisisons roles user version

Methods

canActivate comparePassword hasAllPermissions hasSomeRoles isAdmin signToken toJwtPayload verifyToken verifyVersion

Constructors

constructor

new UserManager(userData: User, jwt: JwtService): UserManager
Parameters
- userData: User
- jwt: JwtService
Returns UserManager
- Defined in types/user-manager.ts:9

Properties

`Protected` `Readonly`jwt

jwt: JwtService

`Protected` `Readonly`userData

userData: User

Accessors

permisisons

get permisisons(): Set<string>
Get the set of user permissions

Returns Set<string>
- Defined in types/user-manager.ts:24

roles

get roles(): Set<string>
Get the set of user roles

Returns Set<string>
- Defined in types/user-manager.ts:31

user

get user(): User
Get the user data

Returns User
- Defined in types/user-manager.ts:17

version

get version(): string
Get the user version

Returns string
- Defined in types/user-manager.ts:38

Methods

canActivate

canActivate(body: CanActivateDto): boolean | undefined
Parameters
- body: CanActivateDto
Returns boolean | undefined
- Defined in types/user-manager.ts:69

comparePassword

comparePassword(password: string): Promise<boolean>
Compare the plain password with the hashed password
Parameters
- password: string
  plain password
Returns Promise<boolean>
boolean or throw UnauthorizedException
- Defined in types/user-manager.ts:98

hasAllPermissions

hasAllPermissions(requiredPermissions: string[]): boolean
Check the user has all requiredPermissions or throw ForbiddenException
Parameters
- requiredPermissions: string[]
Returns boolean
- Defined in types/user-manager.ts:52

hasSomeRoles

hasSomeRoles(requiredRoles: string[]): boolean
Check the user has one of the requiredRoles or throw ForbiddenException
Parameters
- requiredRoles: string[]
Returns boolean
- Defined in types/user-manager.ts:62

isAdmin

isAdmin(): boolean
Check the user has the "admin" role

Returns boolean
- Defined in types/user-manager.ts:45

signToken

signToken(): Promise<string>
Sign the jwt token

Returns Promise<string>
jwt token
- Defined in types/user-manager.ts:109

toJwtPayload

toJwtPayload(): JwtPayload
Create the jwt payload object JwtPayload

Returns JwtPayload
-- JwtPayload
- Defined in types/user-manager.ts:85

verifyToken

verifyToken(token: string): Promise<JwtPayload>
Verify jwt token
Parameters
- token: string
  jwt token
Returns Promise<JwtPayload>
string or throw UnauthorizedException that indicated invalid or old versioned token
- Defined in types/user-manager.ts:119

verifyVersion

verifyVersion(version: string): boolean
Check the jwt version matches with the provided token's version or thow Invalid Jwt version error
Parameters
- version: string
Returns boolean
- Defined in types/user-manager.ts:130