jose/docs/interfaces/jws_compact_verify.CompactVerifyGetKey.md
2021-08-20 22:40:04 +02:00

36 lines
1.1 KiB
Markdown

# Interface: CompactVerifyGetKey
[jws/compact/verify](../modules/jws_compact_verify.md).CompactVerifyGetKey
## Hierarchy
- [`GetKeyFunction`](types.GetKeyFunction.md)<[`JWSHeaderParameters`](types.JWSHeaderParameters.md), [`FlattenedJWSInput`](types.FlattenedJWSInput.md)\>
**`CompactVerifyGetKey`**
## Callable
### CompactVerifyGetKey
**CompactVerifyGetKey**(`protectedHeader`, `token`): `Promise`<[`KeyLike`](../types/types.KeyLike.md)\>
Interface for Compact JWS Verification dynamic key resolution.
No token components have been verified at the time of this function call.
See [createRemoteJWKSet](../functions/jwks_remote.createRemoteJWKSet.md#function-createremotejwkset)
to verify using a remote JSON Web Key Set.
#### Parameters
| Name | Type |
| :------ | :------ |
| `protectedHeader` | [`JWSHeaderParameters`](types.JWSHeaderParameters.md) |
| `token` | [`FlattenedJWSInput`](types.FlattenedJWSInput.md) |
#### Returns
`Promise`<[`KeyLike`](../types/types.KeyLike.md)\>
#### Defined in
[types.d.ts:152](https://github.com/panva/jose/blob/v3.15.4/src/types.d.ts#L152)