mirror of
https://github.com/danbulant/jose
synced 2026-05-21 21:39:04 +00:00
2 KiB
2 KiB
Interface: Signature
Table of contents
Methods
Methods
addSignature
▸ addSignature(...args): Signature
A shorthand for calling addSignature() on the enclosing GeneralSign instance
Parameters
| Name | Type |
|---|---|
...args |
[key: KeyLike | Uint8Array, options?: SignOptions] |
Returns
done
▸ done(): GeneralSign
Returns the enclosing GeneralSign
Returns
setProtectedHeader
▸ setProtectedHeader(protectedHeader): Signature
Sets the JWS Protected Header on the Signature object.
Parameters
| Name | Type | Description |
|---|---|---|
protectedHeader |
JWSHeaderParameters |
JWS Protected Header. |
Returns
setUnprotectedHeader
▸ setUnprotectedHeader(unprotectedHeader): Signature
Sets the JWS Unprotected Header on the Signature object.
Parameters
| Name | Type | Description |
|---|---|---|
unprotectedHeader |
JWSHeaderParameters |
JWS Unprotected Header. |
Returns
sign
▸ sign(...args): Promise<GeneralJWS>
A shorthand for calling encrypt() on the enclosing GeneralSign instance
Parameters
| Name | Type |
|---|---|
...args |
[] |
Returns
Promise<GeneralJWS>