docs: update typedoc, format tsdoc

.prettierrc.json

@@ -2,5 +2,10 @@
   "trailingComma": "all",
   "singleQuote": true,
   "printWidth": 100,
-  "semi": false
+  "semi": false,
+  "plugins": ["prettier-plugin-jsdoc"],
+  "tsdoc": true,
+  "jsdocSeparateReturnsFromParam": true,
+  "jsdocSeparateTagGroups": true,
+  "jsdocPrintWidth": 100
 }

docs/classes/jwe_compact_encrypt.CompactEncrypt.md

@@ -5,11 +5,10 @@
 The CompactEncrypt class is a utility for creating Compact JWE strings.
 
 **`example`** Usage
+
 ```js
 const jwe = await new jose.CompactEncrypt(
-  new TextEncoder().encode(
-    'It’s a dangerous business, Frodo, going out your door.'
-  )
+  new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
 )
   .setProtectedHeader({ alg: 'RSA-OAEP-256', enc: 'A256GCM' })
   .encrypt(publicKey)
@@ -68,11 +67,11 @@ ___
 
 ▸ **setContentEncryptionKey**(`cek`): [`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
 
-Sets a content encryption key to use, by default a random suitable one
-is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
+Sets a content encryption key to use, by default a random suitable one is generated for the JWE
+enc" (Encryption Algorithm) Header Parameter.
 
-**`deprecated`** You should not use this method. It is only really intended
-for test and vector validation purposes.
+**`deprecated`** You should not use this method. It is only really intended for test and vector
+  validation purposes.
 
 #### Parameters
 
@@ -90,12 +89,11 @@ ___
 
 ▸ **setInitializationVector**(`iv`): [`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
 
-Sets the JWE Initialization Vector to use for content encryption, by default
-a random suitable one is generated for the JWE enc" (Encryption Algorithm)
-Header Parameter.
+Sets the JWE Initialization Vector to use for content encryption, by default a random suitable
+one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
 
-**`deprecated`** You should not use this method. It is only really intended
-for test and vector validation purposes.
+**`deprecated`** You should not use this method. It is only really intended for test and vector
+  validation purposes.
 
 #### Parameters
 
@@ -113,9 +111,9 @@ ___
 
 ▸ **setKeyManagementParameters**(`parameters`): [`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
 
-Sets the JWE Key Management parameters to be used when encrypting the Content
-Encryption Key. You do not need to invoke this method, it is only really
-intended for test and vector validation purposes.
+Sets the JWE Key Management parameters to be used when encrypting the Content Encryption Key.
+You do not need to invoke this method, it is only really intended for test and vector
+validation purposes.
 
 #### Parameters
 

docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md

@@ -2,15 +2,13 @@
 
 [💗 Help the project](https://github.com/sponsors/panva)
 
-The FlattenedEncrypt class is a utility for creating Flattened JWE
-objects.
+The FlattenedEncrypt class is a utility for creating Flattened JWE objects.
 
 **`example`** Usage
+
 ```js
 const jwe = await new jose.FlattenedEncrypt(
-  new TextEncoder().encode(
-    'It’s a dangerous business, Frodo, going out your door.'
-  )
+  new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
 )
   .setProtectedHeader({ alg: 'RSA-OAEP-256', enc: 'A256GCM' })
   .setAdditionalAuthenticatedData(encoder.encode('The Fellowship of the Ring'))
@@ -91,11 +89,11 @@ ___
 
 ▸ **setContentEncryptionKey**(`cek`): [`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
 
-Sets a content encryption key to use, by default a random suitable one
-is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
+Sets a content encryption key to use, by default a random suitable one is generated for the JWE
+enc" (Encryption Algorithm) Header Parameter.
 
-**`deprecated`** You should not use this method. It is only really intended
-for test and vector validation purposes.
+**`deprecated`** You should not use this method. It is only really intended for test and vector
+  validation purposes.
 
 #### Parameters
 
@@ -113,12 +111,11 @@ ___
 
 ▸ **setInitializationVector**(`iv`): [`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
 
-Sets the JWE Initialization Vector to use for content encryption, by default
-a random suitable one is generated for the JWE enc" (Encryption Algorithm)
-Header Parameter.
+Sets the JWE Initialization Vector to use for content encryption, by default a random suitable
+one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
 
-**`deprecated`** You should not use this method. It is only really intended
-for test and vector validation purposes.
+**`deprecated`** You should not use this method. It is only really intended for test and vector
+  validation purposes.
 
 #### Parameters
 
@@ -136,10 +133,10 @@ ___
 
 ▸ **setKeyManagementParameters**(`parameters`): [`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
 
-Sets the JWE Key Management parameters to be used when encrypting.
-Use of this is method is really only needed for ECDH based algorithms
-when utilizing the Agreement PartyUInfo or Agreement PartyVInfo parameters.
-Other parameters will always be randomly generated when needed and missing.
+Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is
+really only needed for ECDH based algorithms when utilizing the Agreement PartyUInfo or
+Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed
+and missing.
 
 #### Parameters
 

docs/classes/jwe_general_encrypt.GeneralEncrypt.md

@@ -5,11 +5,10 @@
 The GeneralEncrypt class is a utility for creating General JWE objects.
 
 **`example`** Usage
+
 ```js
 const jwe = await new jose.GeneralEncrypt(
-  new TextEncoder().encode(
-    'It’s a dangerous business, Frodo, going out your door.'
-  )
+  new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
 )
   .setProtectedHeader({ enc: 'A256GCM' })
   .addRecipient(ecPublicKey)

docs/classes/jws_compact_sign.CompactSign.md

@@ -5,11 +5,10 @@
 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.'
-  )
+  new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
 )
   .setProtectedHeader({ alg: 'ES256' })
   .sign(privateKey)

docs/classes/jws_flattened_sign.FlattenedSign.md

@@ -5,11 +5,10 @@
 The FlattenedSign class is a utility for creating Flattened JWS objects.
 
 **`example`** Usage
+
 ```js
 const jws = await new jose.FlattenedSign(
-  new TextEncoder().encode(
-    'It’s a dangerous business, Frodo, going out your door.'
-  )
+  new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
 )
   .setProtectedHeader({ alg: 'ES256' })
   .sign(privateKey)

docs/classes/jws_general_sign.GeneralSign.md

@@ -5,11 +5,10 @@
 The GeneralSign class is a utility for creating General JWS objects.
 
 **`example`** Usage
+
 ```js
 const jws = await new jose.GeneralSign(
-  new TextEncoder().encode(
-    'It’s a dangerous business, Frodo, going out your door.'
-  )
+  new TextEncoder().encode('It’s a dangerous business, Frodo, going out your door.'),
 )
   .addSignature(ecPrivateKey)
   .setProtectedHeader({ alg: 'ES256' })

docs/classes/jwt_encrypt.EncryptJWT.md

@@ -5,6 +5,7 @@
 The EncryptJWT class is a utility for creating Compact JWE formatted JWT strings.
 
 **`example`** Usage
+
 ```js
 const jwt = await new jose.EncryptJWT({ 'urn:example:claim': true })
   .setProtectedHeader({ alg: 'dir', enc: 'A256GCM' })
@@ -135,11 +136,11 @@ ___
 
 ▸ **setContentEncryptionKey**(`cek`): [`EncryptJWT`](jwt_encrypt.EncryptJWT.md)
 
-Sets a content encryption key to use, by default a random suitable one
-is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
+Sets a content encryption key to use, by default a random suitable one is generated for the JWE
+enc" (Encryption Algorithm) Header Parameter.
 
-**`deprecated`** You should not use this method. It is only really intended
-for test and vector validation purposes.
+**`deprecated`** You should not use this method. It is only really intended for test and vector
+  validation purposes.
 
 #### Parameters
 
@@ -163,7 +164,7 @@ Set "exp" (Expiration Time) Claim.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `input` | `string` \| `number` | "exp" (Expiration Time) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. |
+| `input` | `string` \| `number` | "exp" (Expiration Time) Claim value to set on the JWT Claims Set. When number is   passed that is used as a value, when string is passed it is resolved to a time span and added   to the current timestamp. |
 
 #### Returns
 
@@ -175,12 +176,11 @@ ___
 
 ▸ **setInitializationVector**(`iv`): [`EncryptJWT`](jwt_encrypt.EncryptJWT.md)
 
-Sets the JWE Initialization Vector to use for content encryption, by default
-a random suitable one is generated for the JWE enc" (Encryption Algorithm)
-Header Parameter.
+Sets the JWE Initialization Vector to use for content encryption, by default a random suitable
+one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
 
-**`deprecated`** You should not use this method. It is only really intended
-for test and vector validation purposes.
+**`deprecated`** You should not use this method. It is only really intended for test and vector
+  validation purposes.
 
 #### Parameters
 
@@ -252,10 +252,10 @@ ___
 
 ▸ **setKeyManagementParameters**(`parameters`): [`EncryptJWT`](jwt_encrypt.EncryptJWT.md)
 
-Sets the JWE Key Management parameters to be used when encrypting.
-Use of this is method is really only needed for ECDH based algorithms
-when utilizing the Agreement PartyUInfo or Agreement PartyVInfo parameters.
-Other parameters will always be randomly generated when needed and missing.
+Sets the JWE Key Management parameters to be used when encrypting. Use of this is method is
+really only needed for ECDH based algorithms when utilizing the Agreement PartyUInfo or
+Agreement PartyVInfo parameters. Other parameters will always be randomly generated when needed
+and missing.
 
 #### Parameters
 
@@ -279,7 +279,7 @@ Set "nbf" (Not Before) Claim.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `input` | `string` \| `number` | "nbf" (Not Before) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. |
+| `input` | `string` \| `number` | "nbf" (Not Before) Claim value to set on the JWT Claims Set. When number is passed   that is used as a value, when string is passed it is resolved to a time span and added to the   current timestamp. |
 
 #### Returns
 
@@ -297,7 +297,7 @@ Sets the JWE Protected Header on the EncryptJWT object.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `protectedHeader` | [`CompactJWEHeaderParameters`](../interfaces/types.CompactJWEHeaderParameters.md) | JWE Protected Header. Must contain an "alg" (JWE Algorithm) and "enc" (JWE Encryption Algorithm) properties. |
+| `protectedHeader` | [`CompactJWEHeaderParameters`](../interfaces/types.CompactJWEHeaderParameters.md) | JWE Protected Header. Must contain an "alg" (JWE Algorithm) and "enc"   (JWE Encryption Algorithm) properties. |
 
 #### Returns
 

docs/classes/jwt_produce.ProduceJWT.md

@@ -62,7 +62,7 @@ Set "exp" (Expiration Time) Claim.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `input` | `string` \| `number` | "exp" (Expiration Time) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. |
+| `input` | `string` \| `number` | "exp" (Expiration Time) Claim value to set on the JWT Claims Set. When number is   passed that is used as a value, when string is passed it is resolved to a time span and added   to the current timestamp. |
 
 #### Returns
 
@@ -134,7 +134,7 @@ Set "nbf" (Not Before) Claim.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `input` | `string` \| `number` | "nbf" (Not Before) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. |
+| `input` | `string` \| `number` | "nbf" (Not Before) Claim value to set on the JWT Claims Set. When number is passed   that is used as a value, when string is passed it is resolved to a time span and added to the   current timestamp. |
 
 #### Returns
 

docs/classes/jwt_sign.SignJWT.md

@@ -5,6 +5,7 @@
 The SignJWT class is a utility for creating Compact JWS formatted JWT strings.
 
 **`example`** Usage
+
 ```js
 const jwt = await new jose.SignJWT({ 'urn:example:claim': true })
   .setProtectedHeader({ alg: 'ES256' })
@@ -77,7 +78,7 @@ Set "exp" (Expiration Time) Claim.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `input` | `string` \| `number` | "exp" (Expiration Time) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. |
+| `input` | `string` \| `number` | "exp" (Expiration Time) Claim value to set on the JWT Claims Set. When number is   passed that is used as a value, when string is passed it is resolved to a time span and added   to the current timestamp. |
 
 #### Returns
 
@@ -149,7 +150,7 @@ Set "nbf" (Not Before) Claim.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `input` | `string` \| `number` | "nbf" (Not Before) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. |
+| `input` | `string` \| `number` | "nbf" (Not Before) Claim value to set on the JWT Claims Set. When number is passed   that is used as a value, when string is passed it is resolved to a time span and added to the   current timestamp. |
 
 #### Returns
 

docs/classes/jwt_unsecured.UnsecuredJWT.md

@@ -5,6 +5,7 @@
 The UnsecuredJWT class is a utility for dealing with `{ "alg": "none" }` Unsecured JWTs.
 
 **`example`** Encoding
+
 ```js
 const unsecuredJwt = new jose.UnsecuredJWT({ 'urn:example:claim': true })
   .setIssuedAt()
@@ -17,10 +18,11 @@ console.log(unsecuredJwt)
 ```
 
 **`example`** Decoding
+
 ```js
 const payload = jose.UnsecuredJWT.decode(jwt, {
   issuer: 'urn:example:issuer',
-  audience: 'urn:example:audience'
+  audience: 'urn:example:audience',
 })
 
 console.log(payload)
@@ -117,7 +119,7 @@ Set "exp" (Expiration Time) Claim.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `input` | `string` \| `number` | "exp" (Expiration Time) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. |
+| `input` | `string` \| `number` | "exp" (Expiration Time) Claim value to set on the JWT Claims Set. When number is   passed that is used as a value, when string is passed it is resolved to a time span and added   to the current timestamp. |
 
 #### Returns
 
@@ -189,7 +191,7 @@ Set "nbf" (Not Before) Claim.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `input` | `string` \| `number` | "nbf" (Not Before) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. |
+| `input` | `string` \| `number` | "nbf" (Not Before) Claim value to set on the JWT Claims Set. When number is passed   that is used as a value, when string is passed it is resolved to a time span and added to the   current timestamp. |
 
 #### Returns
 

docs/classes/util_errors.JOSEAlgNotAllowed.md

@@ -44,6 +44,8 @@ A unique error code for the particular error subclass.
 
 • `Static` `get` **code**(): ``"ERR_JOSE_ALG_NOT_ALLOWED"``
 
+A unique error code for the particular error subclass.
+
 #### Returns
 
 ``"ERR_JOSE_ALG_NOT_ALLOWED"``

docs/classes/util_errors.JOSEError.md

@@ -2,8 +2,7 @@
 
 [💗 Help the project](https://github.com/sponsors/panva)
 
-A generic Error subclass that all other specific
-JOSE Error subclasses inherit from.
+A generic Error subclass that all other specific JOSE Error subclasses inherit from.
 
 ## Table of contents
 

docs/classes/util_errors.JOSENotSupported.md

@@ -45,6 +45,8 @@ A unique error code for the particular error subclass.
 
 • `Static` `get` **code**(): ``"ERR_JOSE_NOT_SUPPORTED"``
 
+A unique error code for the particular error subclass.
+
 #### Returns
 
 ``"ERR_JOSE_NOT_SUPPORTED"``

docs/classes/util_errors.JWEDecryptionFailed.md

@@ -51,6 +51,8 @@ ___
 
 • `Static` `get` **code**(): ``"ERR_JWE_DECRYPTION_FAILED"``
 
+A unique error code for the particular error subclass.
+
 #### Returns
 
 ``"ERR_JWE_DECRYPTION_FAILED"``