jose/docs/classes/_jws_compact_sign_.compactsign.md

Class: 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 { default: CompactSign } = require('jose/jws/compact/sign')

example

// usage
import parseJwk from 'jose/jwk/parse'

const encoder = new TextEncoder()
const privateKey = await parseJwk({
  alg: 'ES256',
  crv: 'P-256',
  kty: 'EC',
  d: 'VhsfgSRKcvHCGpLyygMbO_YpXc7bVKwi12KQTE4yOR4',
  x: 'ySK38C1jBdLwDsNWKzzBHqKYEE5Cgv-qjWvorUXk9fw',
  y: '_LeQBw07cf5t57Iavn4j-BqJsAD1dpoz8gokd3sBsOo'
})

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)

Index

Constructors

• constructor

Methods

• setProtectedHeader
• sign

Constructors

constructor

+ new CompactSign(payload: Uint8Array): CompactSign

Defined in src/jws/compact/sign.ts:44

Parameters:

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

Returns: CompactSign

Methods

setProtectedHeader

▸ setProtectedHeader(protectedHeader: JWSHeaderParameters): this

Defined in src/jws/compact/sign.ts:58

Sets the JWS Protected Header on the Sign object.

Parameters:

Name	Type	Description
protectedHeader	JWSHeaderParameters	JWS Protected Header.

Returns: this

---

sign

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

Defined in src/jws/compact/sign.ts:69

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>