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

929 B

Raw Permalink Blame History

Interface: UnsecuredResult<PayloadType>

💗 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.

Result of decoding an Unsecured JWT.

Type Parameters

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

Properties

header

• header: JWSHeaderParameters

The decoded JOSE Header; always { "alg": "none" } for an Unsecured JWT.

payload

• payload: PayloadType & JWTPayload

JWT Claims Set.

929 B Raw Permalink Blame History