mirror of https://github.com/hanzoai/jose.git synced 2026-09-24 17:00:01 +00:00

Files

T

Filip Skokan d162246556 refactor(types): trim published declaration comments

Signed-off-by: Filip Skokan <[email protected]>

2026-07-30 00:37:15 +02:00

2.3 KiB

Raw Permalink Blame History

Interface: GeneralDecryptGetKey()<KeyType>

💗 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 General JWE Decryption dynamic key resolution. No token components have been verified at the time of this function call.

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.

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`	`JWEHeaderParameters` \| `undefined`	JWE or JWS Protected Header.
`token`	`FlattenedJWE`	The consumed JWE or JWS token.

Returns

2.3 KiB Raw Permalink Blame History