Back to Jose

Class: JWKSMultipleMatchingKeys

docs/util/errors/classes/JWKSMultipleMatchingKeys.md

6.2.121.3 KB
Original Source

Class: JWKSMultipleMatchingKeys

šŸ’— 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 multiple keys match in a JWKS.

Examples

Checking thrown error is this one using a stable error code

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

Checking thrown error is this one using instanceof

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

Properties

[asyncIterator]

• [asyncIterator]: () => AsyncIterableIterator<CryptoKey>

Yields public keys matching the JWS Header so verification can be attempted with each. See the createRemoteJWKSet and createLocalJWKSet examples. Empty on manually constructed errors.

Returns

AsyncIterableIterator<CryptoKey>


code

• code: string = 'ERR_JWKS_MULTIPLE_MATCHING_KEYS'

A unique error code for JWKSMultipleMatchingKeys.