jose/docs/functions/jws_compact_verify.compactVerify.md

Function: compactVerify

jws/compact/verify.compactVerify

▸ compactVerify(jws, key, options?): Promise<CompactVerifyResult>

Verifies the signature and format of and afterwards decodes the Compact JWS.

example ESM import

import { compactVerify } from 'jose/jws/compact/verify'

example CJS import

const { compactVerify } = require('jose/jws/compact/verify')

example Usage

const decoder = new TextDecoder()
const jws = 'eyJhbGciOiJFUzI1NiJ9.SXTigJlzIGEgZGFuZ2Vyb3VzIGJ1c2luZXNzLCBGcm9kbywgZ29pbmcgb3V0IHlvdXIgZG9vci4.kkAs_gPPxWMI3rHuVlxHaTPfDWDoqdI8jSvuSmqV-8IHIWXg9mcAeC9ggV-45ZHRbiRJ3obUIFo1rHphPA5URg'

const { payload, protectedHeader } = await compactVerify(jws, publicKey)

console.log(protectedHeader)
console.log(decoder.decode(payload))

Parameters

Name	Type	Description
jws	string | Uint8Array	Compact JWS.
key	KeyLike | CompactVerifyGetKey	Key, or a function resolving a key, to verify the JWS with.
options?	VerifyOptions	JWS Verify options.

Returns

Promise<CompactVerifyResult>

Defined in

jws/compact/verify.ts:51