jose/docs/classes/jws_general_sign.GeneralSign.md

Class: GeneralSign

The GeneralSign class is a utility for creating General JWS objects.

example Usage

const jws = await new jose.GeneralSign(
  new TextEncoder().encode(
    'It’s a dangerous business, Frodo, going out your door.'
  )
)
  .addSignature(ecPrivateKey)
  .setProtectedHeader({ alg: 'ES256' })
  .addSignature(rsaPrivateKey)
  .setProtectedHeader({ alg: 'PS256' })
  .sign()

console.log(jws)

Table of contents

Constructors

• constructor

Methods

• addSignature
• sign

Constructors

constructor

• new GeneralSign(payload)

Parameters

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

Methods

addSignature

▸ addSignature(key, options?): Signature

Adds an additional signature for the General JWS object.

Parameters

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

Returns

Signature

---

sign

▸ sign(): Promise<GeneralJWS>

Signs and resolves the value of the General JWS object.

Returns

Promise<GeneralJWS>