Skip to main content
Module

x/jose/types.d.ts

"JSON Web Almost Everything" - JWA, JWS, JWE, JWT, JWK, JWKS with no dependencies using runtime's native crypto in Node.js, Browser, Cloudflare Workers, Electron, and Deno.
Extremely Popular
Go to Latest
import * as jose from "https://deno.land/x/jose@v4.8.3/types.d.ts";

Interfaces

Recognized Compact JWE Header Parameters, any other Header Members may also be present.

Recognized Compact JWS Header Parameters, any other Header Members may also be present.

Shared Interface with a "crit" property for all sign, verify, encrypt and decrypt operations.

JWE Decryption options.

Deflate Raw implementation, e.g. promisified zlib.deflateRaw.

JWE Deflate option.

JWE Encryption options.

Flattened JWE definition.

Flattened JWS definition. Payload is returned as an empty string when JWS Unencoded Payload Option RFC7797 is used.

Flattened JWS definition for verify function inputs, allows payload as Uint8Array for detached signature validation.

General JWS definition. Payload is returned as an empty string when JWS Unencoded Payload Option RFC7797 is used.

General JWS definition for verify function inputs, allows payload as Uint8Array for detached signature validation.

Generic Interface for consuming operations dynamic key resolution. No token components have been verified at the time of this function call.

Inflate Raw implementation, e.g. promisified zlib.inflateRaw.

JSON Web Key Set

Recognized JWE Header Parameters, any other Header members may also be present.

Recognized JWE Key Management-related Header Parameters.

JSON Web Key (JWK). "RSA", "EC", "OKP", and "oct" key types are supported.

Recognized JWS Header Parameters, any other Header Members may also be present.

JWT Claims Set verification options.

Recognized Signed JWT Header Parameters, any other Header Members may also be present.

Recognized JWT Claims Set members, any other members may also be present.

JWS Signing options.

JWS Verification options.

Type Aliases

KeyLike are runtime-specific classes representing asymmetric keys or symmetric secrets. These are instances of CryptoKey and additionally KeyObject in Node.js runtime. Uint8Array instances are also accepted as symmetric secret representation only.