jws_compact_sign.CompactSign.md

Class: CompactSign

jws/compact/sign.CompactSign

The CompactSign class is a utility for creating Compact JWS strings.

example ESM import

import { CompactSign } from 'jose/jws/compact/sign'

example CJS import

const { CompactSign } = require('jose/jws/compact/sign')

example Deno import

import { CompactSign } from 'https://deno.land/x/jose@v3.17.0/jws/compact/sign.ts'

example Usage

const encoder = new TextEncoder()

const jws = await new CompactSign(encoder.encode('It’s a dangerous business, Frodo, going out your door.'))
  .setProtectedHeader({ alg: 'ES256' })
  .sign(privateKey)

console.log(jws)

Table of contents

Constructors

• constructor

Methods

• setProtectedHeader
• sign

Constructors

constructor

• new CompactSign(payload)

Parameters

Name	Type	Description
payload	Uint8Array	Binary representation of the payload to sign.

Defined in

jws/compact/sign.ts:39

Methods

setProtectedHeader

▸ setProtectedHeader(protectedHeader): CompactSign

Sets the JWS Protected Header on the Sign object.

Parameters

Name	Type	Description
protectedHeader	JWSHeaderParameters	JWS Protected Header.

Returns

CompactSign

Defined in

jws/compact/sign.ts:48

---

sign

▸ sign(key, options?): Promise<string>

Signs and resolves the value of the Compact JWS string.

Parameters

Name	Type	Description
key	KeyLike	Private Key or Secret to sign the JWS with.
options?	SignOptions	JWS Sign options.

Returns

Promise<string>

Defined in

jws/compact/sign.ts:59