util_errors.JWTExpired.md

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.

---

An error subclass thrown when a JWT is expired.

Example

Checking thrown error is this one using a stable error code

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

Example

Checking thrown error is this one using instanceof

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

Implements

• JWTClaimValidationFailed

Table of contents

Properties

• claim
• code
• payload
• reason

Properties

claim

• claim: string

The Claim for which the validation failed.

---

code

• code: string = 'ERR_JWT_EXPIRED'

A unique error code for this particular error subclass.

---

payload

• payload: JWTPayload

The parsed JWT Claims Set (aka payload). Other JWT claims may or may not have been verified at this point. The JSON Web Signature (JWS) or a JSON Web Encryption (JWE) structures' integrity has however been verified. Claims Set verification happens after the JWS Signature or JWE Decryption processes.

---

reason

• reason: string

Reason code for the validation failure.