Skip to content

Commit 72ecff6

Browse files
committed
feat: add subpath module exports
1 parent c502731 commit 72ecff6

File tree

62 files changed

+472
-4
lines changed

Some content is hidden

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

62 files changed

+472
-4
lines changed

docs/classes/jwe_compact_encrypt.CompactEncrypt.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
88

99
The CompactEncrypt class is used to build and encrypt Compact JWE strings.
1010

11+
This class is exported (as a named export) from the main `'jose'` module entry point as well as
12+
from its subpath export `'jose/jwe/compact/encrypt'`.
13+
1114
**`Example`**
1215

1316
```js

docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
88

99
The FlattenedEncrypt class is used to build and encrypt Flattened JWE objects.
1010

11+
This class is exported (as a named export) from the main `'jose'` module entry point as well as
12+
from its subpath export `'jose/jwe/flattened/encrypt'`.
13+
1114
**`Example`**
1215

1316
```js

docs/classes/jwe_general_encrypt.GeneralEncrypt.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
88

99
The GeneralEncrypt class is used to build and encrypt General JWE objects.
1010

11+
This class is exported (as a named export) from the main `'jose'` module entry point as well as
12+
from its subpath export `'jose/jwe/general/encrypt'`.
13+
1114
**`Example`**
1215

1316
```js

docs/classes/jws_compact_sign.CompactSign.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
88

99
The CompactSign class is used to build and sign Compact JWS strings.
1010

11+
This class is exported (as a named export) from the main `'jose'` module entry point as well as
12+
from its subpath export `'jose/jws/compact/sign'`.
13+
1114
**`Example`**
1215

1316
```js

docs/classes/jws_flattened_sign.FlattenedSign.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
88

99
The FlattenedSign class is used to build and sign Flattened JWS objects.
1010

11+
This class is exported (as a named export) from the main `'jose'` module entry point as well as
12+
from its subpath export `'jose/jws/flattened/sign'`.
13+
1114
**`Example`**
1215

1316
```js

docs/classes/jws_general_sign.GeneralSign.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
88

99
The GeneralSign class is used to build and sign General JWS objects.
1010

11+
This class is exported (as a named export) from the main `'jose'` module entry point as well as
12+
from its subpath export `'jose/jws/general/sign'`.
13+
1114
**`Example`**
1215

1316
```js

docs/classes/jwt_encrypt.EncryptJWT.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
88

99
The EncryptJWT class is used to build and encrypt Compact JWE formatted JSON Web Tokens.
1010

11+
This class is exported (as a named export) from the main `'jose'` module entry point as well as
12+
from its subpath export `'jose/jwt/encrypt'`.
13+
1114
**`Example`**
1215

1316
```js

docs/classes/jwt_sign.SignJWT.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
88

99
The SignJWT class is used to build and sign Compact JWS formatted JSON Web Tokens.
1010

11+
This class is exported (as a named export) from the main `'jose'` module entry point as well as
12+
from its subpath export `'jose/jwt/sign'`.
13+
1114
**`Example`**
1215

1316
Usage with a symmetric secret

docs/classes/jwt_unsecured.UnsecuredJWT.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ Support from the community to continue maintaining and improving this module is
88

99
The UnsecuredJWT class is a utility for dealing with `{ "alg": "none" }` Unsecured JWTs.
1010

11+
This class is exported (as a named export) from the main `'jose'` module entry point as well as
12+
from its subpath export `'jose/jwt/unsecured'`.
13+
1114
**`Example`**
1215

1316
Encoding

docs/functions/jwe_compact_decrypt.compactDecrypt.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ Support from the community to continue maintaining and improving this module is
1010

1111
Decrypts a Compact JWE.
1212

13+
This function is exported (as a named export) from the main `'jose'` module entry point as well
14+
as from its subpath export `'jose/jwe/compact/decrypt'`.
15+
1316
#### Parameters
1417

1518
| Name | Type | Description |

0 commit comments

Comments
 (0)