mirror of
https://github.com/danbulant/jose
synced 2026-05-19 04:18:52 +00:00
24 lines
726 B
Markdown
24 lines
726 B
Markdown
# Function: decodeJwt
|
|
|
|
▸ **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)
|