jose/docs/interfaces/jwe_general_decrypt.generaldecryptgetkey.md
2021-03-26 14:50:10 +01:00

30 lines
1.1 KiB
Markdown

# Interface: GeneralDecryptGetKey
[jwe/general/decrypt](../modules/jwe_general_decrypt.md).GeneralDecryptGetKey
Interface for General JWE 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)\>
**GeneralDecryptGetKey**
## Callable
**GeneralDecryptGetKey**(`protectedHeader`: [*JWEHeaderParameters*](types.jweheaderparameters.md), `token`: [*FlattenedJWE*](types.flattenedjwe.md)): *Promise*<[*KeyLike*](../types/types.keylike.md)\>
Interface for General JWE 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.11.1/src/types.d.ts#L79)