File: jwe_general_encrypt.Recipient.md

package info (click to toggle)
node-jose 4.11.4-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, trixie
  • size: 4,264 kB
  • sloc: javascript: 16,258; sh: 111; makefile: 4
file content (78 lines) | stat: -rw-r--r-- 1,765 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# Interface: Recipient

[💗 Help the project](https://github.com/sponsors/panva)

## 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: Uint8Array \| KeyLike, 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)