Class PermissionsGuard

Hierarchy (View Summary)

Implements

  • CanActivate

Constructors

constructor

Methods

canActivate getRequest getRequestDetails getUserFromContext

Constructors

constructor

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')

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

getRequestDetails

  • getRequestDetails(context: ExecutionContext): Record<string, unknown>

    Extracts request details from execution context

    Parameters

    • context: ExecutionContext

      execution context

    Returns Record<string, unknown>

    request details

getUserFromContext

  • getUserFromContext(context: ExecutionContext): null | BaseUser

    Extracts current user from request object

    Parameters

    • context: ExecutionContext

      execution context

    Returns null | BaseUser

    current user if exists

Settings

Member Visibility

On This Page

Constructors
Methods