Skip to content

Commit f6bae6b

Browse files
committed
chore: bump typedoc and typescript
1 parent f6ae30d commit f6bae6b

File tree

121 files changed

+701
-679
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

121 files changed

+701
-679
lines changed

docs/jwe/compact/decrypt/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@
22

33
Decrypting JSON Web Encryption (JWE) in Compact Serialization
44

5-
## Index
6-
7-
### Interfaces
5+
## Interfaces
86

97
- [CompactDecryptGetKey](interfaces/CompactDecryptGetKey.md)
108

11-
### Functions
9+
## Functions
1210

1311
- [compactDecrypt](functions/compactDecrypt.md)

docs/jwe/compact/decrypt/functions/compactDecrypt.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Support from the community to continue maintaining and improving this module is
66

77
## Call Signature
88

9-
**compactDecrypt**(`jwe`, `key`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`CompactDecryptResult`](../../../../types/interfaces/CompactDecryptResult.md)\>
9+
**compactDecrypt**(`jwe`, `key`, `options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`CompactDecryptResult`](../../../../types/interfaces/CompactDecryptResult.md)\>
1010

1111
Decrypts a Compact JWE.
1212

@@ -19,7 +19,7 @@ as from its subpath export `'jose/jwe/compact/decrypt'`.
1919
| ------ | ------ | ------ |
2020
| `jwe` | `string` \| [`Uint8Array`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) | Compact JWE. |
2121
| `key` | [`Uint8Array`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) \| [`CryptoKey`](https://developer.mozilla.org/docs/Web/API/CryptoKey) \| [`JWK`](../../../../types/interfaces/JWK.md) \| [`KeyObject`](../../../../types/interfaces/KeyObject.md) | Private Key or Secret to decrypt the JWE with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jwe-alg). |
22-
| `options`? | [`DecryptOptions`](../../../../types/interfaces/DecryptOptions.md) | JWE Decryption options. |
22+
| `options?` | [`DecryptOptions`](../../../../types/interfaces/DecryptOptions.md) | JWE Decryption options. |
2323

2424
### Returns
2525

@@ -39,15 +39,15 @@ console.log(new TextDecoder().decode(plaintext))
3939

4040
## Call Signature
4141

42-
**compactDecrypt**(`jwe`, `getKey`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`CompactDecryptResult`](../../../../types/interfaces/CompactDecryptResult.md) & [`ResolvedKey`](../../../../types/interfaces/ResolvedKey.md)\>
42+
**compactDecrypt**(`jwe`, `getKey`, `options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`CompactDecryptResult`](../../../../types/interfaces/CompactDecryptResult.md) & [`ResolvedKey`](../../../../types/interfaces/ResolvedKey.md)\>
4343

4444
### Parameters
4545

4646
| Parameter | Type | Description |
4747
| ------ | ------ | ------ |
4848
| `jwe` | `string` \| [`Uint8Array`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) | Compact JWE. |
4949
| `getKey` | [`CompactDecryptGetKey`](../interfaces/CompactDecryptGetKey.md) | Function resolving Private Key or Secret to decrypt the JWE with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jwe-alg). |
50-
| `options`? | [`DecryptOptions`](../../../../types/interfaces/DecryptOptions.md) | JWE Decryption options. |
50+
| `options?` | [`DecryptOptions`](../../../../types/interfaces/DecryptOptions.md) | JWE Decryption options. |
5151

5252
### Returns
5353

docs/jwe/compact/decrypt/interfaces/CompactDecryptGetKey.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ verified at the time of this function call.
99

1010
**CompactDecryptGetKey**(`protectedHeader`, `token`): [`Uint8Array`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) \| [`CryptoKey`](https://developer.mozilla.org/docs/Web/API/CryptoKey) \| [`JWK`](../../../../types/interfaces/JWK.md) \| [`KeyObject`](../../../../types/interfaces/KeyObject.md) \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Uint8Array`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) \| [`CryptoKey`](https://developer.mozilla.org/docs/Web/API/CryptoKey) \| [`JWK`](../../../../types/interfaces/JWK.md) \| [`KeyObject`](../../../../types/interfaces/KeyObject.md)\>
1111

12-
Interface for Compact JWE Decryption dynamic key resolution. No token components have been
13-
verified at the time of this function call.
12+
Dynamic key resolution function. No token components have been verified at the time of this
13+
function call.
14+
15+
If a suitable key for the token cannot be matched, throw an error instead.
1416

1517
## Parameters
1618

docs/jwe/compact/encrypt/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Encrypting JSON Web Encryption (JWE) in Compact Serialization
44

5-
## Index
6-
7-
### Classes
5+
## Classes
86

97
- [CompactEncrypt](classes/CompactEncrypt.md)

docs/jwe/compact/encrypt/classes/CompactEncrypt.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ console.log(jwe)
2323

2424
## Constructors
2525

26-
### new CompactEncrypt()
26+
### Constructor
2727

28-
**new CompactEncrypt**(`plaintext`): [`CompactEncrypt`](CompactEncrypt.md)
28+
**new CompactEncrypt**(`plaintext`): `CompactEncrypt`
2929

30-
[CompactEncrypt](CompactEncrypt.md) constructor
30+
CompactEncrypt constructor
3131

3232
#### Parameters
3333

@@ -37,13 +37,13 @@ console.log(jwe)
3737

3838
#### Returns
3939

40-
[`CompactEncrypt`](CompactEncrypt.md)
40+
`CompactEncrypt`
4141

4242
## Methods
4343

4444
### encrypt()
4545

46-
**encrypt**(`key`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>
46+
**encrypt**(`key`, `options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>
4747

4848
Encrypts and resolves the value of the Compact JWE string.
4949

@@ -52,7 +52,7 @@ Encrypts and resolves the value of the Compact JWE string.
5252
| Parameter | Type | Description |
5353
| ------ | ------ | ------ |
5454
| `key` | [`Uint8Array`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) \| [`CryptoKey`](https://developer.mozilla.org/docs/Web/API/CryptoKey) \| [`JWK`](../../../../types/interfaces/JWK.md) \| [`KeyObject`](../../../../types/interfaces/KeyObject.md) | Public Key or Secret to encrypt the JWE with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jwe-alg). |
55-
| `options`? | [`EncryptOptions`](../../../../types/interfaces/EncryptOptions.md) | JWE Encryption options. |
55+
| `options?` | [`EncryptOptions`](../../../../types/interfaces/EncryptOptions.md) | JWE Encryption options. |
5656

5757
#### Returns
5858

docs/jwe/flattened/decrypt/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@
22

33
Decrypting JSON Web Encryption (JWE) in Flattened JSON Serialization
44

5-
## Index
6-
7-
### Interfaces
5+
## Interfaces
86

97
- [FlattenedDecryptGetKey](interfaces/FlattenedDecryptGetKey.md)
108

11-
### Functions
9+
## Functions
1210

1311
- [flattenedDecrypt](functions/flattenedDecrypt.md)

docs/jwe/flattened/decrypt/functions/flattenedDecrypt.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Support from the community to continue maintaining and improving this module is
66

77
## Call Signature
88

9-
**flattenedDecrypt**(`jwe`, `key`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`FlattenedDecryptResult`](../../../../types/interfaces/FlattenedDecryptResult.md)\>
9+
**flattenedDecrypt**(`jwe`, `key`, `options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`FlattenedDecryptResult`](../../../../types/interfaces/FlattenedDecryptResult.md)\>
1010

1111
Decrypts a Flattened JWE.
1212

@@ -19,7 +19,7 @@ as from its subpath export `'jose/jwe/flattened/decrypt'`.
1919
| ------ | ------ | ------ |
2020
| `jwe` | [`FlattenedJWE`](../../../../types/interfaces/FlattenedJWE.md) | Flattened JWE. |
2121
| `key` | [`Uint8Array`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) \| [`CryptoKey`](https://developer.mozilla.org/docs/Web/API/CryptoKey) \| [`JWK`](../../../../types/interfaces/JWK.md) \| [`KeyObject`](../../../../types/interfaces/KeyObject.md) | Private Key or Secret to decrypt the JWE with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jwe-alg). |
22-
| `options`? | [`DecryptOptions`](../../../../types/interfaces/DecryptOptions.md) | JWE Decryption options. |
22+
| `options?` | [`DecryptOptions`](../../../../types/interfaces/DecryptOptions.md) | JWE Decryption options. |
2323

2424
### Returns
2525

@@ -49,15 +49,15 @@ console.log(decoder.decode(additionalAuthenticatedData))
4949

5050
## Call Signature
5151

52-
**flattenedDecrypt**(`jwe`, `getKey`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`FlattenedDecryptResult`](../../../../types/interfaces/FlattenedDecryptResult.md) & [`ResolvedKey`](../../../../types/interfaces/ResolvedKey.md)\>
52+
**flattenedDecrypt**(`jwe`, `getKey`, `options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`FlattenedDecryptResult`](../../../../types/interfaces/FlattenedDecryptResult.md) & [`ResolvedKey`](../../../../types/interfaces/ResolvedKey.md)\>
5353

5454
### Parameters
5555

5656
| Parameter | Type | Description |
5757
| ------ | ------ | ------ |
5858
| `jwe` | [`FlattenedJWE`](../../../../types/interfaces/FlattenedJWE.md) | Flattened JWE. |
5959
| `getKey` | [`FlattenedDecryptGetKey`](../interfaces/FlattenedDecryptGetKey.md) | Function resolving Private Key or Secret to decrypt the JWE with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jwe-alg). |
60-
| `options`? | [`DecryptOptions`](../../../../types/interfaces/DecryptOptions.md) | JWE Decryption options. |
60+
| `options?` | [`DecryptOptions`](../../../../types/interfaces/DecryptOptions.md) | JWE Decryption options. |
6161

6262
### Returns
6363

docs/jwe/flattened/decrypt/interfaces/FlattenedDecryptGetKey.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ verified at the time of this function call.
99

1010
**FlattenedDecryptGetKey**(`protectedHeader`, `token`): [`Uint8Array`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) \| [`CryptoKey`](https://developer.mozilla.org/docs/Web/API/CryptoKey) \| [`JWK`](../../../../types/interfaces/JWK.md) \| [`KeyObject`](../../../../types/interfaces/KeyObject.md) \| [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Uint8Array`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) \| [`CryptoKey`](https://developer.mozilla.org/docs/Web/API/CryptoKey) \| [`JWK`](../../../../types/interfaces/JWK.md) \| [`KeyObject`](../../../../types/interfaces/KeyObject.md)\>
1111

12-
Interface for Flattened JWE Decryption dynamic key resolution. No token components have been
13-
verified at the time of this function call.
12+
Dynamic key resolution function. No token components have been verified at the time of this
13+
function call.
14+
15+
If a suitable key for the token cannot be matched, throw an error instead.
1416

1517
## Parameters
1618

docs/jwe/flattened/encrypt/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Encrypting JSON Web Encryption (JWE) in Flattened JSON Serialization
44

5-
## Index
6-
7-
### Classes
5+
## Classes
86

97
- [FlattenedEncrypt](classes/FlattenedEncrypt.md)

docs/jwe/flattened/encrypt/classes/FlattenedEncrypt.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ console.log(jwe)
2424

2525
## Constructors
2626

27-
### new FlattenedEncrypt()
27+
### Constructor
2828

29-
**new FlattenedEncrypt**(`plaintext`): [`FlattenedEncrypt`](FlattenedEncrypt.md)
29+
**new FlattenedEncrypt**(`plaintext`): `FlattenedEncrypt`
3030

31-
[FlattenedEncrypt](FlattenedEncrypt.md) constructor
31+
FlattenedEncrypt constructor
3232

3333
#### Parameters
3434

@@ -38,13 +38,13 @@ console.log(jwe)
3838

3939
#### Returns
4040

41-
[`FlattenedEncrypt`](FlattenedEncrypt.md)
41+
`FlattenedEncrypt`
4242

4343
## Methods
4444

4545
### encrypt()
4646

47-
**encrypt**(`key`, `options`?): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`FlattenedJWE`](../../../../types/interfaces/FlattenedJWE.md)\>
47+
**encrypt**(`key`, `options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`FlattenedJWE`](../../../../types/interfaces/FlattenedJWE.md)\>
4848

4949
Encrypts and resolves the value of the Flattened JWE object.
5050

@@ -53,7 +53,7 @@ Encrypts and resolves the value of the Flattened JWE object.
5353
| Parameter | Type | Description |
5454
| ------ | ------ | ------ |
5555
| `key` | [`Uint8Array`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) \| [`CryptoKey`](https://developer.mozilla.org/docs/Web/API/CryptoKey) \| [`JWK`](../../../../types/interfaces/JWK.md) \| [`KeyObject`](../../../../types/interfaces/KeyObject.md) | Public Key or Secret to encrypt the JWE with. See [Algorithm Key Requirements](https://github.com/panva/jose/issues/210#jwe-alg). |
56-
| `options`? | [`EncryptOptions`](../../../../types/interfaces/EncryptOptions.md) | JWE Encryption options. |
56+
| `options?` | [`EncryptOptions`](../../../../types/interfaces/EncryptOptions.md) | JWE Encryption options. |
5757

5858
#### Returns
5959

0 commit comments

Comments
 (0)