Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.42 KB

File metadata and controls

38 lines (25 loc) · 1.42 KB

Function: decodeJwt()

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

decodeJwt<PayloadType>(jwt): PayloadType & JWTPayload

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().

This function is exported (as a named export) from the main 'jose' module entry point as well as from its subpath export 'jose/jwt/decode'.

Type Parameters

Type Parameter Default type Description
PayloadType JWTPayload Type definition of the JWT Claims Set the token is expected to carry.

Parameters

Parameter Type Description
jwt string JWT token in compact JWS serialization.

Returns

PayloadType & JWTPayload

Example

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