jose/docs/classes/util_errors.JWTClaimValidationFailed.md

Class: JWTClaimValidationFailed

💗 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 Claim Set member validation fails.

Example

Checking thrown error is this one using a stable error code

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

Example

Checking thrown error is this one using instanceof

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

Implemented by

• JWTExpired

Table of contents

Constructors

• constructor

Properties

• claim
• code
• reason

Accessors

• code

Constructors

constructor

• new JWTClaimValidationFailed(message, claim?, reason?)

Parameters

Name	Type	Default value
message	string	undefined
claim	string	'unspecified'
reason	string	'unspecified'

Properties

claim

• claim: string

The Claim for which the validation failed.

---

code

• code: string = 'ERR_JWT_CLAIM_VALIDATION_FAILED'

A unique error code for the particular error subclass.

---

reason

• reason: string

Reason code for the validation failure.

Accessors

code

• Static get code(): "ERR_JWT_CLAIM_VALIDATION_FAILED"

A unique error code for the particular error subclass.

Returns

"ERR_JWT_CLAIM_VALIDATION_FAILED"