mirror of
https://github.com/danbulant/jose
synced 2026-05-22 22:09:14 +00:00
76 lines
1.7 KiB
Markdown
76 lines
1.7 KiB
Markdown
# Interface: Recipient
|
|
|
|
## Table of contents
|
|
|
|
### Methods
|
|
|
|
- [addRecipient](jwe_general_encrypt.Recipient.md#addrecipient)
|
|
- [done](jwe_general_encrypt.Recipient.md#done)
|
|
- [encrypt](jwe_general_encrypt.Recipient.md#encrypt)
|
|
- [setUnprotectedHeader](jwe_general_encrypt.Recipient.md#setunprotectedheader)
|
|
|
|
## Methods
|
|
|
|
### addRecipient
|
|
|
|
▸ **addRecipient**(...`args`): [`Recipient`](jwe_general_encrypt.Recipient.md)
|
|
|
|
A shorthand for calling addRecipient() on the enclosing GeneralEncrypt instance
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `...args` | [key: KeyLike \| Uint8Array, options?: CritOption] |
|
|
|
|
#### Returns
|
|
|
|
[`Recipient`](jwe_general_encrypt.Recipient.md)
|
|
|
|
___
|
|
|
|
### done
|
|
|
|
▸ **done**(): [`GeneralEncrypt`](../classes/jwe_general_encrypt.GeneralEncrypt.md)
|
|
|
|
Returns the enclosing GeneralEncrypt
|
|
|
|
#### Returns
|
|
|
|
[`GeneralEncrypt`](../classes/jwe_general_encrypt.GeneralEncrypt.md)
|
|
|
|
___
|
|
|
|
### encrypt
|
|
|
|
▸ **encrypt**(...`args`): `Promise`<[`GeneralJWE`](types.GeneralJWE.md)\>
|
|
|
|
A shorthand for calling encrypt() on the enclosing GeneralEncrypt instance
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `...args` | [options?: DeflateOption] |
|
|
|
|
#### Returns
|
|
|
|
`Promise`<[`GeneralJWE`](types.GeneralJWE.md)\>
|
|
|
|
___
|
|
|
|
### setUnprotectedHeader
|
|
|
|
▸ **setUnprotectedHeader**(`unprotectedHeader`): [`Recipient`](jwe_general_encrypt.Recipient.md)
|
|
|
|
Sets the JWE Per-Recipient Unprotected Header on the Recipient object.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `unprotectedHeader` | [`JWEHeaderParameters`](types.JWEHeaderParameters.md) | JWE Per-Recipient Unprotected Header. |
|
|
|
|
#### Returns
|
|
|
|
[`Recipient`](jwe_general_encrypt.Recipient.md)
|