jws_flattened_sign.FlattenedSign.md

Class: FlattenedSign

jws/flattened/sign.FlattenedSign

The FlattenedSign class is a utility for creating Flattened JWS objects.

example ESM import

import { FlattenedSign } from 'jose/jws/flattened/sign'

example CJS import

const { FlattenedSign } = require('jose/jws/flattened/sign')

example Deno import

import { FlattenedSign } from 'https://deno.land/x/jose@v3.15.5/jws/flattened/sign.ts'

example Usage

const encoder = new TextEncoder()

const jws = await new FlattenedSign(encoder.encode('It’s a dangerous business, Frodo, going out your door.'))
  .setProtectedHeader({ alg: 'ES256' })
  .sign(privateKey)
console.log(jws)

Table of contents

Constructors

• constructor

Methods

• setProtectedHeader
• setUnprotectedHeader
• sign

Constructors

constructor

• new FlattenedSign(payload)

Parameters

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

Defined in

jws/flattened/sign.ts:51

Methods

setProtectedHeader

▸ setProtectedHeader(protectedHeader): FlattenedSign

Sets the JWS Protected Header on the FlattenedSign object.

Parameters

Name	Type	Description
protectedHeader	JWSHeaderParameters	JWS Protected Header.

Returns

FlattenedSign

Defined in

jws/flattened/sign.ts:60

---

setUnprotectedHeader

▸ setUnprotectedHeader(unprotectedHeader): FlattenedSign

Sets the JWS Unprotected Header on the FlattenedSign object.

Parameters

Name	Type	Description
unprotectedHeader	JWSHeaderParameters	JWS Unprotected Header.

Returns

FlattenedSign

Defined in

jws/flattened/sign.ts:73

---

sign

▸ sign(key, options?): Promise<FlattenedJWS>

Signs and resolves the value of the Flattened JWS object.

Parameters

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

Returns

Promise<FlattenedJWS>

Defined in

jws/flattened/sign.ts:87