jose/docs/interfaces/jwe_general_encrypt.Recipient.md
2021-11-11 17:14:02 +01:00

1.7 KiB

Interface: Recipient

Table of contents

Methods

Methods

addRecipient

addRecipient(...args): Recipient

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

Parameters

Name Type
...args [key: KeyLike | Uint8Array, 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