mirror of
https://github.com/danbulant/jose
synced 2026-05-24 20:41:46 +00:00
98 lines
2.2 KiB
Markdown
98 lines
2.2 KiB
Markdown
# Class: CompactSign
|
||
|
||
[jws/compact/sign](../modules/jws_compact_sign.md).CompactSign
|
||
|
||
The CompactSign class is a utility for creating Compact JWS strings.
|
||
|
||
**`example`** ESM import
|
||
```js
|
||
import { CompactSign } from 'jose/jws/compact/sign'
|
||
```
|
||
|
||
**`example`** CJS import
|
||
```js
|
||
const { CompactSign } = require('jose/jws/compact/sign')
|
||
```
|
||
|
||
**`example`** Usage
|
||
```js
|
||
const encoder = new TextEncoder()
|
||
|
||
const jws = await new CompactSign(encoder.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. |
|
||
|
||
#### Defined in
|
||
|
||
[jws/compact/sign.ts:36](https://github.com/panva/jose/blob/v3.14.3/src/jws/compact/sign.ts#L36)
|
||
|
||
## Methods
|
||
|
||
### setProtectedHeader
|
||
|
||
▸ **setProtectedHeader**(`protectedHeader`): [`CompactSign`](jws_compact_sign.CompactSign.md)
|
||
|
||
Sets the JWS Protected Header on the Sign object.
|
||
|
||
#### Parameters
|
||
|
||
| Name | Type | Description |
|
||
| :------ | :------ | :------ |
|
||
| `protectedHeader` | [`JWSHeaderParameters`](../interfaces/types.JWSHeaderParameters.md) | JWS Protected Header. |
|
||
|
||
#### Returns
|
||
|
||
[`CompactSign`](jws_compact_sign.CompactSign.md)
|
||
|
||
#### Defined in
|
||
|
||
[jws/compact/sign.ts:45](https://github.com/panva/jose/blob/v3.14.3/src/jws/compact/sign.ts#L45)
|
||
|
||
___
|
||
|
||
### sign
|
||
|
||
▸ **sign**(`key`, `options?`): `Promise`<`string`\>
|
||
|
||
Signs and resolves the value of the Compact JWS string.
|
||
|
||
#### Parameters
|
||
|
||
| Name | Type | Description |
|
||
| :------ | :------ | :------ |
|
||
| `key` | [`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`\>
|
||
|
||
#### Defined in
|
||
|
||
[jws/compact/sign.ts:56](https://github.com/panva/jose/blob/v3.14.3/src/jws/compact/sign.ts#L56)
|