jose/docs/interfaces/jwt_decrypt.jwtdecryptgetkey.md
2021-03-18 07:51:50 +01:00

30 lines
1.1 KiB
Markdown

# Interface: JWTDecryptGetKey
[jwt/decrypt](../modules/jwt_decrypt.md).JWTDecryptGetKey
Interface for JWT Decryption dynamic key resolution.
No token components have been verified at the time of this function call.
## Hierarchy
* [*GetKeyFunction*](types.getkeyfunction.md)<[*JWEHeaderParameters*](types.jweheaderparameters.md), [*FlattenedJWE*](types.flattenedjwe.md)\>
**JWTDecryptGetKey**
## Callable
**JWTDecryptGetKey**(`protectedHeader`: [*JWEHeaderParameters*](types.jweheaderparameters.md), `token`: [*FlattenedJWE*](types.flattenedjwe.md)): *Promise*<[*KeyLike*](../types/types.keylike.md)\>
Interface for JWT Decryption dynamic key resolution.
No token components have been verified at the time of this function call.
#### Parameters:
Name | Type |
:------ | :------ |
`protectedHeader` | [*JWEHeaderParameters*](types.jweheaderparameters.md) |
`token` | [*FlattenedJWE*](types.flattenedjwe.md) |
**Returns:** *Promise*<[*KeyLike*](../types/types.keylike.md)\>
Defined in: [types.d.ts:79](https://github.com/panva/jose/blob/v3.10.0/src/types.d.ts#L79)