File: util_decode_jwt.decodeJwt.md

package info (click to toggle)
node-jose 4.11.4-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, trixie
  • size: 4,264 kB
  • sloc: javascript: 16,258; sh: 111; makefile: 4
file content (27 lines) | stat: -rw-r--r-- 787 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Function: decodeJwt

[💗 Help the project](https://github.com/sponsors/panva)

â–¸ **decodeJwt**(`jwt`): [`JWTPayload`](../interfaces/types.JWTPayload.md)

Decodes a signed JSON Web Token payload. This does not validate the JWT Claims Set types or
values. This does not validate the JWS Signature. For a proper Signed JWT Claims Set validation
and JWS signature verification use `jose.jwtVerify()`. For an encrypted JWT Claims Set validation
and JWE decryption use `jose.jwtDecrypt()`.

**`example`** Usage

```js
const claims = jose.decodeJwt(token)
console.log(claims)
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `jwt` | `string` | JWT token in compact JWS serialization. |

#### Returns

[`JWTPayload`](../interfaces/types.JWTPayload.md)