jose/docs/interfaces/jwe_general_encrypt.Recipient.md

Interface: Recipient

💗 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.

---

Table of contents

Methods

• addRecipient
• done
• encrypt
• setUnprotectedHeader

Methods

addRecipient

▸ addRecipient(...args): Recipient

A shorthand for calling addRecipient() on the enclosing GeneralEncrypt instance

Parameters

Name	Type
...args	[key: Uint8Array | KeyLike, options?: CritOption]

Returns

Recipient

---

done

▸ done(): GeneralEncrypt

Returns the enclosing GeneralEncrypt

Returns

GeneralEncrypt

---

encrypt

▸ encrypt(...args): Promise<GeneralJWE>

A shorthand for calling encrypt() on the enclosing GeneralEncrypt instance

Parameters

Name	Type
...args	[options?: DeflateOption]

Returns

Promise<GeneralJWE>

---

setUnprotectedHeader

▸ setUnprotectedHeader(unprotectedHeader): Recipient

Sets the JWE Per-Recipient Unprotected Header on the Recipient object.

Parameters

Name	Type	Description
unprotectedHeader	JWEHeaderParameters	JWE Per-Recipient Unprotected Header.

Returns

Recipient