Skip to main content

Class: JWT

Implements

Constructors

new JWT()

new JWT(jwtStr): JWT

Parameters

jwtStr: string

Returns

JWT

Accessors

get header(): JWTHeader

Returns

JWTHeader


claims

get claims(): JWTPayload

Returns

JWTPayload


payload

get payload(): JWTPayload

Returns

JWTPayload


rawValue

get rawValue(): string

Remarks

RawRepresentable

Returns

string

stringified representation of the JWT

Implementation of

RawRepresentable.rawValue


isExpired

get isExpired(): boolean

Returns

boolean

Implementation of

Expires.isExpired


isValid

get isValid(): boolean

Returns

boolean

Implementation of

Expires.isValid

Methods

verifySignature()

verifySignature(keySet): Promise<boolean>

Parameters

keySet: JWKS

Returns

Promise<boolean>


validate()

validate(keySet): Promise<boolean>

Parameters

keySet: JWKS

Returns

Promise<boolean>


toJSON()

toJSON(): object

Returns

object

rawValue

rawValue: string


toString()

toString(): string

Returns a string representation of an object.

Returns

string

JWT Claim accessor

audience

get audience(): undefined | string

Returns

undefined | string


expirationTime

get expirationTime(): undefined | Date

Returns

undefined | Date


expiresIn

get expiresIn(): number

Returns

number

Implementation of

Expires.expiresIn


issuer

get issuer(): undefined | string

Returns

undefined | string


issuedAt

get issuedAt(): undefined | Date

Returns

undefined | Date

Implementation of

Expires.issuedAt


notBefore

get notBefore(): undefined | Date

Returns

undefined | Date


scope

get scope(): undefined | string[]

Returns

undefined | string[]


scopes

get scopes(): undefined | string[]

Returns

undefined | string[]


subject

get subject(): undefined | string

Returns

undefined | string


expiresAt

get expiresAt(): undefined | Date

Returns

undefined | Date

Implementation of

Expires.expiresAt