Interface: Signature

💗 Help the project

Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.

Used to build General JWS object's individual signatures.

Methods

addSignature()

▸ addSignature(key, options?): Signature

A shorthand for calling addSignature() on the enclosing GeneralSign instance.

Parameters

Parameter	Type	Description
key	KeyInput	Private Key or Secret to sign the individual JWS signature with. See Algorithm Key Requirements.
options?	SignOptions	JWS Sign options.

Returns

Signature

---

done()

▸ done(): GeneralSign

Returns the enclosing GeneralSign instance

Returns

GeneralSign

---

setProtectedHeader()

▸ setProtectedHeader(protectedHeader): Signature

Sets the JWS Protected Header on the Signature object.

Parameters

Parameter	Type	Description
protectedHeader	JWSHeaderParameters	JWS Protected Header.

Returns

Signature

---

setUnprotectedHeader()

▸ setUnprotectedHeader(unprotectedHeader): Signature

Sets the JWS Unprotected Header on the Signature object.

Parameters

Parameter	Type	Description
unprotectedHeader	JWSHeaderParameters	JWS Unprotected Header.

Returns

Signature

---

sign()

▸ sign(): Promise<GeneralJWS>

A shorthand for calling sign() on the enclosing GeneralSign instance. Takes no arguments — each signature's key is supplied to addSignature.

Returns

Promise<GeneralJWS>