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 9d10136a51 chore(release): 3.9.0
2021-03-15 17:21:54 +01:00

1.6 KiB
Raw Blame History

Interface: GetKeyFunction<T, T2>

types.GetKeyFunction

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.

Type parameters

Name
T
T2

Hierarchy

Callable

▸ GetKeyFunction(protectedHeader: T, token: T2): 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:79