jose/docs/functions/_util_decode_protected_header_.decodeprotectedheader.md
2020-12-21 19:03:10 +01:00

1 KiB

Function: decodeProtectedHeader

decodeProtectedHeader(token: string | object): ProtectedHeaderParameters

Defined in src/util/decode_protected_header.ts:34

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

example

// ESM import
import decodeProtectedHeader from 'jose/util/decode_protected_header'

example

// CJS import
const { default: decodeProtectedHeader } = require('jose/util/decode_protected_header')

example

// usage
const protectedHeader = decodeProtectedHeader(token)
console.log(protectedHeader)

Parameters:

Name Type Description
token string | object JWE/JWS/JWT token in any JOSE serialization.

Returns: ProtectedHeaderParameters