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.
▸ addSignature(key, options?): Signature
A shorthand for calling addSignature() on the enclosing GeneralSign instance.
| 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. |
Signature
▸ done(): GeneralSign
Returns the enclosing GeneralSign instance
▸ setProtectedHeader(protectedHeader): Signature
Sets the JWS Protected Header on the Signature object.
| Parameter | Type | Description |
|---|---|---|
protectedHeader |
JWSHeaderParameters |
JWS Protected Header. |
Signature
▸ setUnprotectedHeader(unprotectedHeader): Signature
Sets the JWS Unprotected Header on the Signature object.
| Parameter | Type | Description |
|---|---|---|
unprotectedHeader |
JWSHeaderParameters |
JWS Unprotected Header. |
Signature
▸ sign(): Promise<GeneralJWS>
A shorthand for calling sign() on the enclosing GeneralSign instance. Takes no arguments — each signature's key is supplied to addSignature.