Interface: CompactVerifyGetKey()\
July 29, 2026 · View on GitHub
💗 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.
Interface for Compact JWS Verification dynamic key resolution. No token components have been verified at the time of this function call.
See
createRemoteJWKSet to verify using a remote JSON Web Key Set.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
KeyType extends CryptoKey | Uint8Array | CryptoKey | Uint8Array | Type definition of the keys the function resolves. Narrowing it is what lets ResolvedKey.key be inferred at the call site. |
▸ CompactVerifyGetKey(protectedHeader, token): JWK | KeyObject | KeyType | Promise<JWK | KeyObject | KeyType>
Dynamic key resolution function. No token components have been verified at the time of this function call. If a suitable key for the token cannot be matched, throw an error instead.
Parameters
| Parameter | Type | Description |
|---|---|---|
protectedHeader | CompactJWSHeaderParameters | JWE or JWS Protected Header. |
token | FlattenedJWSInput | The consumed JWE or JWS token. |
Returns
JWK | KeyObject | KeyType | Promise<JWK | KeyObject | KeyType>