API Reference
Rockets Core API
nestjs-access-control
classes
AccessControlGuard

Class: AccessControlGuard

Implements

  • CanActivate

Constructors

new AccessControlGuard()

new AccessControlGuard(settings, service, reflector, moduleRef): AccessControlGuard

Parameters

ParameterType
settingsAccessControlSettingsInterface
serviceAccessControlServiceInterface
reflectorReflector
moduleRefModuleRef

Returns

AccessControlGuard

Defined in

packages/nestjs-access-control/src/access-control.guard.ts:29 (opens in a new tab)

Methods

canActivate()

canActivate(context): Promise<boolean>

Parameters

ParameterTypeDescription
contextExecutionContextCurrent execution context. Provides access to details about the current request pipeline.

Returns

Promise<boolean>

Value indicating whether or not the current request is allowed to proceed.

Implementation of

CanActivate.canActivate

Defined in

packages/nestjs-access-control/src/access-control.guard.ts:38 (opens in a new tab)


checkAccessGrants()

protected checkAccessGrants(context): Promise<boolean>

Parameters

ParameterType
contextExecutionContext

Returns

Promise<boolean>

Defined in

packages/nestjs-access-control/src/access-control.guard.ts:43 (opens in a new tab)


checkAccessQueries()

protected checkAccessQueries(context, queriesPermitted): Promise<boolean>

Parameters

ParameterType
contextExecutionContext
queriesPermittedIQueryInfo[]

Returns

Promise<boolean>

Defined in

packages/nestjs-access-control/src/access-control.guard.ts:93 (opens in a new tab)