Class PermissionsGuard

Hierarchy (View Summary)

PermissionsGuard
- GraphQLPermissionsGuard

Implements

CanActivate

Index

Constructors

Methods

canActivate getRequest getRequestDetails getUserFromContext

Constructors

constructor

new PermissionsGuard(
    reflector: Reflector,
    appConfig: AppConfigType,
    loggerFactory: WinstonLoggerFactory,
): PermissionsGuard
Parameters
- reflector: Reflector
- appConfig: AppConfigType
- loggerFactory: WinstonLoggerFactory
Returns PermissionsGuard
- Defined in libs/core/src/guards/permission.ts:22

Methods

canActivate

canActivate(context: ExecutionContext): Promise<boolean>
Parameters
- context: ExecutionContext
  execution context
Returns Promise<boolean>
- true if user has permission to access resource
Throws
- AccessDeniedException if user has no permission to access resource
Example: - Use in resolver
```
@UseGuards(GraphQLJwtAuthGuard, GraphQLPermissionsGuard)
@UsePermissions('js:core:users:get')
```
Implementation of CanActivate.canActivate
- Defined in libs/core/src/guards/permission.ts:40

getRequest

getRequest(
context: ExecutionContext,
): Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> & {
user?: BaseUser;
}
Extracts request from execution context
Parameters
- context: ExecutionContext
  execution context
Returns Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> & {
user?: BaseUser;
}
express request
- Defined in libs/core/src/guards/permission.ts:86

getRequestDetails

getRequestDetails(context: ExecutionContext): Record<string, unknown>
Extracts request details from execution context
Parameters
- context: ExecutionContext
  execution context
Returns Record<string, unknown>
request details
- Defined in libs/core/src/guards/permission.ts:95

getUserFromContext

getUserFromContext(context: ExecutionContext): null | BaseUser
Extracts current user from request object
Parameters
- context: ExecutionContext
  execution context
Returns null | BaseUser
current user if exists
- Defined in libs/core/src/guards/permission.ts:110