mirror of
https://github.com/danbulant/jose
synced 2026-05-19 20:38:42 +00:00
74 lines
1.7 KiB
Markdown
74 lines
1.7 KiB
Markdown
# Class: JOSEError
|
|
|
|
[util/errors](../modules/util_errors.md).JOSEError
|
|
|
|
A generic Error subclass that all other specific
|
|
JOSE Error subclasses inherit from.
|
|
|
|
## Hierarchy
|
|
|
|
* *Error*
|
|
|
|
↳ **JOSEError**
|
|
|
|
↳↳ [*JWTClaimValidationFailed*](util_errors.jwtclaimvalidationfailed.md)
|
|
|
|
↳↳ [*JOSEAlgNotAllowed*](util_errors.josealgnotallowed.md)
|
|
|
|
↳↳ [*JOSENotSupported*](util_errors.josenotsupported.md)
|
|
|
|
↳↳ [*JWEDecryptionFailed*](util_errors.jwedecryptionfailed.md)
|
|
|
|
↳↳ [*JWEInvalid*](util_errors.jweinvalid.md)
|
|
|
|
↳↳ [*JWSInvalid*](util_errors.jwsinvalid.md)
|
|
|
|
↳↳ [*JWTInvalid*](util_errors.jwtinvalid.md)
|
|
|
|
↳↳ [*JWKInvalid*](util_errors.jwkinvalid.md)
|
|
|
|
↳↳ [*JWKSInvalid*](util_errors.jwksinvalid.md)
|
|
|
|
↳↳ [*JWKSNoMatchingKey*](util_errors.jwksnomatchingkey.md)
|
|
|
|
↳↳ [*JWKSMultipleMatchingKeys*](util_errors.jwksmultiplematchingkeys.md)
|
|
|
|
↳↳ [*JWSSignatureVerificationFailed*](util_errors.jwssignatureverificationfailed.md)
|
|
|
|
## Table of contents
|
|
|
|
### Constructors
|
|
|
|
- [constructor](util_errors.joseerror.md#constructor)
|
|
|
|
### Properties
|
|
|
|
- [code](util_errors.joseerror.md#code)
|
|
|
|
## Constructors
|
|
|
|
### constructor
|
|
|
|
\+ **new JOSEError**(`message?`: *string*): [*JOSEError*](util_errors.joseerror.md)
|
|
|
|
#### Parameters:
|
|
|
|
Name | Type |
|
|
:------ | :------ |
|
|
`message?` | *string* |
|
|
|
|
**Returns:** [*JOSEError*](util_errors.joseerror.md)
|
|
|
|
Overrides: void
|
|
|
|
Defined in: [util/errors.ts:11](https://github.com/panva/jose/blob/v3.9.0/src/util/errors.ts#L11)
|
|
|
|
## Properties
|
|
|
|
### code
|
|
|
|
• **code**: *string*= 'ERR\_JOSE\_GENERIC'
|
|
|
|
A unique error code for the particular error subclass.
|
|
|
|
Defined in: [util/errors.ts:11](https://github.com/panva/jose/blob/v3.9.0/src/util/errors.ts#L11)
|