dan/jose
1
0
Fork 0
mirror of https://github.com/danbulant/jose synced 2026-05-19 12:29:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
jose/docs/interfaces/types.GetKeyFunction.md
Filip Skokan a62dc93b75 chore(release): 4.5.1
2022-02-22 10:53:45 +01:00

854 B
Raw Blame History

Interface: GetKeyFunction<T, T2>

Type parameters

Name
T
T2

Callable

GetKeyFunction

▸ GetKeyFunction(protectedHeader, token): KeyLike | Uint8Array | Promise<KeyLike | Uint8Array>

Generic Interface for consuming operations dynamic key resolution. No token components have been verified at the time of this function call.

If you cannot match a key suitable for the token, throw an error instead.

Parameters

Name Type Description
protectedHeader T JWE or JWS Protected Header.
token T2 The consumed JWE or JWS token.

Returns

KeyLike | Uint8Array | Promise<KeyLike | Uint8Array>