mirror of
https://github.com/danbulant/jose
synced 2026-05-23 06:18:58 +00:00
37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# Function: decodeProtectedHeader
|
|
|
|
[util/decode_protected_header](../modules/util_decode_protected_header.md).decodeProtectedHeader
|
|
|
|
▸ **decodeProtectedHeader**(`token`): [`ProtectedHeaderParameters`](../types/util_decode_protected_header.ProtectedHeaderParameters.md)
|
|
|
|
Decodes the Protected Header of a JWE/JWS/JWT token utilizing any JOSE serialization.
|
|
|
|
**`example`** ESM import
|
|
```js
|
|
import { decodeProtectedHeader } from 'jose/util/decode_protected_header'
|
|
```
|
|
|
|
**`example`** CJS import
|
|
```js
|
|
const { decodeProtectedHeader } = require('jose/util/decode_protected_header')
|
|
```
|
|
|
|
**`example`** Usage
|
|
```js
|
|
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:29](https://github.com/panva/jose/blob/v3.14.2/src/util/decode_protected_header.ts#L29)
|