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
|
# Class: CompactSign
[💗 Help the project](https://github.com/sponsors/panva)
The CompactSign class is a utility for creating Compact JWS strings.
**`example`** Usage
```js
const jws = await new jose.CompactSign(
new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
)
.setProtectedHeader({ alg: 'ES256' })
.sign(privateKey)
console.log(jws)
```
## Table of contents
### Constructors
- [constructor](jws_compact_sign.CompactSign.md#constructor)
### Methods
- [setProtectedHeader](jws_compact_sign.CompactSign.md#setprotectedheader)
- [sign](jws_compact_sign.CompactSign.md#sign)
## Constructors
### constructor
• **new CompactSign**(`payload`)
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | `Uint8Array` | Binary representation of the payload to sign. |
## Methods
### setProtectedHeader
â–¸ **setProtectedHeader**(`protectedHeader`): [`CompactSign`](jws_compact_sign.CompactSign.md)
Sets the JWS Protected Header on the Sign object.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `protectedHeader` | [`CompactJWSHeaderParameters`](../interfaces/types.CompactJWSHeaderParameters.md) | JWS Protected Header. |
#### Returns
[`CompactSign`](jws_compact_sign.CompactSign.md)
___
### sign
â–¸ **sign**(`key`, `options?`): `Promise`<`string`\>
Signs and resolves the value of the Compact JWS string.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `key` | `Uint8Array` \| [`KeyLike`](../types/types.KeyLike.md) | Private Key or Secret to sign the JWS with. |
| `options?` | [`SignOptions`](../interfaces/types.SignOptions.md) | JWS Sign options. |
#### Returns
`Promise`<`string`\>
|
