mirror of
https://github.com/danbulant/jose
synced 2026-05-25 04:51:47 +00:00
36 lines
1.1 KiB
Markdown
36 lines
1.1 KiB
Markdown
# Function: decodeProtectedHeader
|
|
|
|
[util/decode_protected_header](../modules/util_decode_protected_header.md).decodeProtectedHeader
|
|
|
|
▸ **decodeProtectedHeader**(`token`: *string* \| *object*): [*ProtectedHeaderParameters*](../types/util_decode_protected_header.protectedheaderparameters.md)
|
|
|
|
Decodes the Protected Header of a JWE/JWS/JWT token utilizing any JOSE serialization.
|
|
|
|
**`example`**
|
|
```js
|
|
// ESM import
|
|
import { decodeProtectedHeader } from 'jose/util/decode_protected_header'
|
|
```
|
|
|
|
**`example`**
|
|
```js
|
|
// CJS import
|
|
const { decodeProtectedHeader } = require('jose/util/decode_protected_header')
|
|
```
|
|
|
|
**`example`**
|
|
```js
|
|
// 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*](../types/util_decode_protected_header.protectedheaderparameters.md)
|
|
|
|
Defined in: [util/decode_protected_header.ts:34](https://github.com/panva/jose/blob/v3.11.0/src/util/decode_protected_header.ts#L34)
|