Back to Jose

Interface: RemoteJWKSet()

docs/jwks/remote/interfaces/RemoteJWKSet.md

6.2.92.5 KB
Original Source

Interface: RemoteJWKSet()

šŸ’— 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.

The key resolution function returned by createRemoteJWKSet.

See

jwtVerify and the other consuming functions, all of which accept this directly.

ā–ø RemoteJWKSet(protectedHeader?, token?): Promise<CryptoKey>

The key resolution function returned by createRemoteJWKSet.

Parameters

ParameterType
protectedHeader?JWSHeaderParameters
token?FlattenedJWSInput

Returns

Promise<CryptoKey>

See

jwtVerify and the other consuming functions, all of which accept this directly.

Properties

coolingDown

• readonly coolingDown: boolean

Whether the cooldown window following the last successful fetch is still in effect.


fresh

• readonly fresh: boolean

Whether the currently cached JSON Web Key Set is within its RemoteJWKSetOptions.cacheMaxAge.


jwks

• jwks: () => JSONWebKeySet | undefined

The currently cached JSON Web Key Set, or undefined when none has been fetched or seeded via jwksCache yet.

Returns

JSONWebKeySet | undefined


reload

• reload: () => Promise<void>

Triggers a JSON Web Key Set fetch, bypassing the cooldown.

Returns

Promise<void>


reloading

• readonly reloading: boolean

Whether a JSON Web Key Set fetch is currently in flight.