mirror of https://github.com/hanzoai/jose.git synced 2026-09-24 17:00:01 +00:00

Files

T

Filip Skokan 101557a764 docs: document consumer-supplied type parameters

Document PayloadType on JWT results and decoders, and KeyType on
dynamic key resolvers so consumers know what each explicit argument
controls. Correct ResolvedKey type-parameter tags in generated docs.

Signed-off-by: Filip Skokan <[email protected]>

2026-07-29 18:50:54 +02:00

1.4 KiB

Raw Permalink Blame History

Function: decodeJwt()

💗 Help the project

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)

1.4 KiB Raw Permalink Blame History