dan/jose
1
0
Fork 0
mirror of https://github.com/danbulant/jose synced 2026-05-19 04:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
jose/docs/interfaces/types.GetKeyFunction.md
Filip Skokan 004549de3f chore(release): 3.14.1
2021-07-21 12:37:17 +02:00

1.4 KiB
Raw Blame History

Interface: GetKeyFunction<T, T2>

types.GetKeyFunction

Type parameters

Name
T
T2

Hierarchy

Callable

GetKeyFunction

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

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

Promise<KeyLike>

Defined in

types.d.ts:81