File: util_errors.JWTClaimValidationFailed.md

package info (click to toggle)
node-jose 4.11.4-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, trixie
  • size: 4,264 kB
  • sloc: javascript: 16,258; sh: 111; makefile: 4
file content (75 lines) | stat: -rw-r--r-- 1,424 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# Class: JWTClaimValidationFailed

[💗 Help the project](https://github.com/sponsors/panva)

An error subclass thrown when a JWT Claim Set member validation fails.

## Implemented by

- [`JWTExpired`](util_errors.JWTExpired.md)

## Table of contents

### Constructors

- [constructor](util_errors.JWTClaimValidationFailed.md#constructor)

### Properties

- [claim](util_errors.JWTClaimValidationFailed.md#claim)
- [code](util_errors.JWTClaimValidationFailed.md#code)
- [reason](util_errors.JWTClaimValidationFailed.md#reason)

### Accessors

- [code](util_errors.JWTClaimValidationFailed.md#code-1)

## 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"``