Back to Jose

Class: JWTExpired

docs/util/errors/classes/JWTExpired.md

6.2.121.5 KB
Original Source

Class: JWTExpired

šŸ’— Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

Thrown when a JWT has expired or exceeds the configured maximum token age.

Examples

Checking thrown error is this one using a stable error code

js
if (err.code === 'ERR_JWT_EXPIRED') {
  // ...
}

Checking thrown error is this one using instanceof

js
if (err instanceof jose.errors.JWTExpired) {
  // ...
}

Properties

cause

• cause: JWTClaimValidationFailure

The JWTClaimValidationFailure details carried by this error.


claim

• claim: string

Claim or header that failed validation.


code

• code: string = 'ERR_JWT_EXPIRED'

A unique error code for JWTExpired.


payload

• payload: JWTPayload

The parsed JWT Claims Set; validation of other claims may be incomplete. With jwtVerify and jwtDecrypt, token authentication precedes claim validation. jwt/unsecured.UnsecuredJWT.decode does not authenticate tokens.


reason

• reason: string

Reason code for the validation failure.