The FlattenedSign class is a utility for creating Flattened JWS objects.
example
Usage
const jws = await new jose.FlattenedSign(
new TextEncoder().encode(
'It’s a dangerous business, Frodo, going out your door.'
)
)
.setProtectedHeader({ alg: 'ES256' })
.sign(privateKey)
console.log(jws)
• new FlattenedSign(payload
)
Name | Type | Description |
---|---|---|
payload |
Uint8Array |
Binary representation of the payload to sign. |
▸ setProtectedHeader(protectedHeader
): FlattenedSign
Sets the JWS Protected Header on the FlattenedSign object.
Name | Type | Description |
---|---|---|
protectedHeader |
JWSHeaderParameters |
JWS Protected Header. |
▸ setUnprotectedHeader(unprotectedHeader
): FlattenedSign
Sets the JWS Unprotected Header on the FlattenedSign object.
Name | Type | Description |
---|---|---|
unprotectedHeader |
JWSHeaderParameters |
JWS Unprotected Header. |
▸ sign(key
, options?
): Promise
<FlattenedJWS
>
Signs and resolves the value of the Flattened JWS object.
Name | Type | Description |
---|---|---|
key |
Uint8Array | KeyLike |
Private Key or Secret to sign the JWS with. |
options? |
SignOptions |
JWS Sign options. |
Promise
<FlattenedJWS
>