Skip to main content

Class: JwtAuthGuard

auth/src.JwtAuthGuard

Extends​

  • IAuthGuard

Constructors​

new JwtAuthGuard(tokenService, clsService, reflector, abstractTenantResolution)​

new JwtAuthGuard(tokenService, clsService, reflector, abstractTenantResolution?): JwtAuthGuard

Parameters​

▪ tokenService: TokenService<IAccessTokenPayload, IRefreshTokenPayload>

▪ clsService: ClsService<UserClsStore<IAccessTokenPayload>>

▪ reflector: Reflector

▪ abstractTenantResolution?: AbstractTenantResolutionService<IAccessTokenPayload>

Returns​

JwtAuthGuard

Overrides​

AuthGuard('jwt').constructor

Source​

libs/auth/src/lib/guards/jwt-auth.guard.ts:18

Properties​

arguments​

static arguments: any

Inherited from​

AuthGuard('jwt').arguments

Source​

node_modules/typescript/lib/lib.es5.d.ts:305

caller​

static caller: Function

Inherited from​

AuthGuard('jwt').caller

Source​

node_modules/typescript/lib/lib.es5.d.ts:306

length​

static readonly length: number

Inherited from​

AuthGuard('jwt').length

Source​

node_modules/typescript/lib/lib.es5.d.ts:302

name​

static readonly name: string

Returns the name of the function. Function names are read-only and can not be changed.

Inherited from​

AuthGuard('jwt').name

Source​

node_modules/typescript/lib/lib.es2015.core.d.ts:95

Methods​

canActivate​

canActivate(context): Promise<boolean>

Verify the token is valid

Parameters​

▪ context: ExecutionContext

{ExecutionContext}

Returns​

Promise<boolean>

super.canActivate(context)

Overrides​

AuthGuard('jwt').canActivate

Source​

libs/auth/src/lib/guards/jwt-auth.guard.ts:33

getAuthenticateOptions​

getAuthenticateOptions(context): IAuthModuleOptions<any>

Parameters​

▪ context: ExecutionContext

Returns​

IAuthModuleOptions<any>

Inherited from​

AuthGuard('jwt').getAuthenticateOptions

Source​

node_modules/@nestjs/passport/dist/auth.guard.d.ts:9

getRequest​

getRequest<T>(context): T

Type parameters​

▪ T = any

Parameters​

▪ context: ExecutionContext

Returns​

T

Inherited from​

AuthGuard('jwt').getRequest

Source​

node_modules/@nestjs/passport/dist/auth.guard.d.ts:10

handleRequest​

handleRequest<TUser>(err, user, info, context, status?): TUser

Type parameters​

▪ TUser = any

Parameters​

▪ err: any

▪ user: any

▪ info: any

▪ context: ExecutionContext

▪ status?: any

Returns​

TUser

Inherited from​

AuthGuard('jwt').handleRequest

Source​

node_modules/@nestjs/passport/dist/auth.guard.d.ts:8

logIn​

logIn<TRequest>(request): Promise<void>

Type parameters​

▪ TRequest extends object = any

Parameters​

▪ request: TRequest

Returns​

Promise<void>

Inherited from​

AuthGuard('jwt').logIn

Source​

node_modules/@nestjs/passport/dist/auth.guard.d.ts:5

[hasInstance]​

static [hasInstance](value): boolean

Determines whether the given value inherits from this function if this function was used as a constructor function.

A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.

Parameters​

▪ value: any

Returns​

boolean

Inherited from​

AuthGuard('jwt').[hasInstance]

Source​

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:164

apply​

static apply(this, thisArg, argArray?): any

Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

Parameters​

▪ this: Function

▪ thisArg: any

The object to be used as the this object.

▪ argArray?: any

A set of arguments to be passed to the function.

Returns​

any

Inherited from​

AuthGuard('jwt').apply

Source​

node_modules/typescript/lib/lib.es5.d.ts:281

bind​

static bind(this, thisArg, ...argArray): any

For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

Parameters​

▪ this: Function

▪ thisArg: any

An object to which the this keyword can refer inside the new function.

▪ ...argArray: any[]

A list of arguments to be passed to the new function.

Returns​

any

Inherited from​

AuthGuard('jwt').bind

Source​

node_modules/typescript/lib/lib.es5.d.ts:296

call​

static call(this, thisArg, ...argArray): any

Calls a method of an object, substituting another object for the current object.

Parameters​

▪ this: Function

▪ thisArg: any

The object to be used as the current object.

▪ ...argArray: any[]

A list of arguments to be passed to the method.

Returns​

any

Inherited from​

AuthGuard('jwt').call

Source​

node_modules/typescript/lib/lib.es5.d.ts:288

toString​

static toString(): string

Returns a string representation of a function.

Returns​

string

Inherited from​

AuthGuard('jwt').toString

Source​

node_modules/typescript/lib/lib.es5.d.ts:299

Generated using typedoc-plugin-markdown and TypeDoc