types

Interfaces

Interface	Description
CompactDecryptResult	Compact JWE decryption result.
CompactJWEHeaderParameters	Recognized Compact JWE Header Parameters; additional members may also be present.
CompactJWSHeaderParameters	Recognized Compact JWS Header Parameters; additional members may also be present.
CompactVerifyResult	Compact JWS verification result.
CritOption	Shared "crit" option for signing, verification, encryption, and decryption.
CryptoKeyStructuralFallback	Structural fallback used when the host CryptoKey type cannot be inferred.
DecryptOptions	JWE Decryption options.
EncryptOptions	JWE Encryption options.
FlattenedDecryptResult	Flattened JWE JSON Serialization decryption result.
FlattenedJWE	Flattened JWE JSON Serialization token.
FlattenedJWS	Flattened JWS JSON Serialization token. The payload is an empty string when the unencoded payload option is used.
FlattenedJWSInput	Flattened JWS verification input.
FlattenedVerifyResult	Flattened JWS JSON Serialization verification result.
GeneralDecryptResult	General JWE JSON Serialization decryption result.
GeneralJWE	General JWE JSON Serialization token.
GeneralJWS	General JWS JSON Serialization token. The payload is an empty string when the unencoded payload option is used.
GeneralJWSInput	General JWS verification input.
GeneralVerifyResult	General JWS JSON Serialization verification result.
GetKeyFunction	Dynamic key resolver for consuming operations.
JoseHeaderParameters	Header Parameters common to JWE and JWS.
JSONWebKeySet	JSON Web Key Set.
JWEHeaderParameters	Recognized JWE Header Parameters; additional members may also be present.
JWEKeyManagementHeaderParameters	Recognized JWE Key Management-related Header Parameters.
JWK_AKP_Private	Convenience interface for private AKP JSON Web Keys.
JWK_AKP_Public	Convenience interface for public AKP JSON Web Keys.
JWK_EC_Private	Convenience interface for private EC JSON Web Keys.
JWK_EC_Public	Convenience interface for public EC JSON Web Keys.
JWK_oct	Convenience interface for "oct" JSON Web Keys.
JWK_OKP_Private	Convenience interface for private OKP JSON Web Keys.
JWK_OKP_Public	Convenience interface for public OKP JSON Web Keys.
JWK_RSA_Private	Convenience interface for private RSA JSON Web Keys.
JWK_RSA_Public	Convenience interface for public RSA JSON Web Keys.
JWSHeaderParameters	Recognized JWS Header Parameters; additional members may also be present.
JWTClaimVerificationOptions	JWT Claims Set verification options.
JWTDecryptResult	Encrypted JSON Web Token (JWT) decryption result.
JWTHeaderParameters	Recognized signed JWT Header Parameters; additional members may also be present.
JWTPayload	Recognized JWT Claims Set members; additional members may also be present.
JWTVerifyResult	Signed JSON Web Token (JWT) verification result.
KeyObject	Node.js KeyObject representation accepted as key input.
ProduceJWT	Shared fluent API for JWT-producing classes.
ResolvedKey	Key resolver result metadata.
SignOptions	JWS Signing options.
VerifyOptions	JWS Verification options.

Type Aliases

Type Alias	Description
AnyJWK	Discriminated union of supported JSON Web Key shapes, narrowed by the "kty" (Key Type) Parameter.
CryptoKey	The runtime's Web Crypto CryptoKey representation accepted as key input.
JWK	JSON Web Key (JWK). "RSA", "EC", "OKP", "AKP", and "oct" key types are supported.
JWKParameters	Generic JSON Web Key Parameters.
KeyInput	Key or secret input accepted by all sign, verify, encrypt, and decrypt operations.