Back to Jose

Function: decodeProtectedHeader()

docs/util/decode_protected_header/functions/decodeProtectedHeader.md

6.2.21.0 KB
Original Source

Function: decodeProtectedHeader()

šŸ’— 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.

ā–ø decodeProtectedHeader(token): ProtectedHeaderParameters

Decodes the Protected Header of a JWE/JWS/JWT token utilizing any JOSE serialization.

This function is exported (as a named export) from the main 'jose' module entry point as well as from its subpath export 'jose/decode/protected_header'.

Parameters

ParameterTypeDescription
tokenstring | objectJWE/JWS/JWT token in any JOSE serialization.

Returns

ProtectedHeaderParameters

Example

js
const protectedHeader = jose.decodeProtectedHeader(token)
console.log(protectedHeader)