refactor: add explicit return types everywhere

panva · Jun 3, 2024 · cc2b2d7 · cc2b2d7
1 parent 89a2604
commit cc2b2d7
Show file tree

Hide file tree

Showing 19 changed files with 136 additions and 134 deletions.
diff --git a/docs/classes/jwe_compact_encrypt.CompactEncrypt.md b/docs/classes/jwe_compact_encrypt.CompactEncrypt.md
@@ -73,7 +73,7 @@ ___
 
 ### setContentEncryptionKey
 
-▸ **setContentEncryptionKey**(`cek`): [`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
+▸ **setContentEncryptionKey**(`cek`): `this`
 
 Sets a content encryption key to use, by default a random suitable one is generated for the JWE
 enc" (Encryption Algorithm) Header Parameter.
@@ -86,7 +86,7 @@ enc" (Encryption Algorithm) Header Parameter.
 
 #### Returns
 
-[`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
+`this`
 
 **`Deprecated`**
 
@@ -97,7 +97,7 @@ ___
 
 ### setInitializationVector
 
-▸ **setInitializationVector**(`iv`): [`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
+▸ **setInitializationVector**(`iv`): `this`
 
 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.
@@ -110,7 +110,7 @@ one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
 
 #### Returns
 
-[`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
+`this`
 
 **`Deprecated`**
 
@@ -121,7 +121,7 @@ ___
 
 ### setKeyManagementParameters
 
-▸ **setKeyManagementParameters**(`parameters`): [`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
+▸ **setKeyManagementParameters**(`parameters`): `this`
 
 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
@@ -135,13 +135,13 @@ validation purposes.
 
 #### Returns
 
-[`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
+`this`
 
 ___
 
 ### setProtectedHeader
 
-▸ **setProtectedHeader**(`protectedHeader`): [`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
+▸ **setProtectedHeader**(`protectedHeader`): `this`
 
 Sets the JWE Protected Header on the CompactEncrypt object.
 
@@ -153,4 +153,4 @@ Sets the JWE Protected Header on the CompactEncrypt object.
 
 #### Returns
 
-[`CompactEncrypt`](jwe_compact_encrypt.CompactEncrypt.md)
+`this`
diff --git a/docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md b/docs/classes/jwe_flattened_encrypt.FlattenedEncrypt.md
@@ -77,7 +77,7 @@ ___
 
 ### setAdditionalAuthenticatedData
 
-▸ **setAdditionalAuthenticatedData**(`aad`): [`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+▸ **setAdditionalAuthenticatedData**(`aad`): `this`
 
 Sets the Additional Authenticated Data on the FlattenedEncrypt object.
 
@@ -89,13 +89,13 @@ Sets the Additional Authenticated Data on the FlattenedEncrypt object.
 
 #### Returns
 
-[`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+`this`
 
 ___
 
 ### setContentEncryptionKey
 
-▸ **setContentEncryptionKey**(`cek`): [`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+▸ **setContentEncryptionKey**(`cek`): `this`
 
 Sets a content encryption key to use, by default a random suitable one is generated for the JWE
 enc" (Encryption Algorithm) Header Parameter.
@@ -108,7 +108,7 @@ enc" (Encryption Algorithm) Header Parameter.
 
 #### Returns
 
-[`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+`this`
 
 **`Deprecated`**
 
@@ -119,7 +119,7 @@ ___
 
 ### setInitializationVector
 
-▸ **setInitializationVector**(`iv`): [`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+▸ **setInitializationVector**(`iv`): `this`
 
 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.
@@ -132,7 +132,7 @@ one is generated for the JWE enc" (Encryption Algorithm) Header Parameter.
 
 #### Returns
 
-[`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+`this`
 
 **`Deprecated`**
 
@@ -143,7 +143,7 @@ ___
 
 ### setKeyManagementParameters
 
-▸ **setKeyManagementParameters**(`parameters`): [`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+▸ **setKeyManagementParameters**(`parameters`): `this`
 
 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
@@ -158,13 +158,13 @@ and missing.
 
 #### Returns
 
-[`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+`this`
 
 ___
 
 ### setProtectedHeader
 
-▸ **setProtectedHeader**(`protectedHeader`): [`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+▸ **setProtectedHeader**(`protectedHeader`): `this`
 
 Sets the JWE Protected Header on the FlattenedEncrypt object.
 
@@ -176,13 +176,13 @@ Sets the JWE Protected Header on the FlattenedEncrypt object.
 
 #### Returns
 
-[`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+`this`
 
 ___
 
 ### setSharedUnprotectedHeader
 
-▸ **setSharedUnprotectedHeader**(`sharedUnprotectedHeader`): [`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+▸ **setSharedUnprotectedHeader**(`sharedUnprotectedHeader`): `this`
 
 Sets the JWE Shared Unprotected Header on the FlattenedEncrypt object.
 
@@ -194,13 +194,13 @@ Sets the JWE Shared Unprotected Header on the FlattenedEncrypt object.
 
 #### Returns
 
-[`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+`this`
 
 ___
 
 ### setUnprotectedHeader
 
-▸ **setUnprotectedHeader**(`unprotectedHeader`): [`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+▸ **setUnprotectedHeader**(`unprotectedHeader`): `this`
 
 Sets the JWE Per-Recipient Unprotected Header on the FlattenedEncrypt object.
 
@@ -212,4 +212,4 @@ Sets the JWE Per-Recipient Unprotected Header on the FlattenedEncrypt object.
 
 #### Returns
 
-[`FlattenedEncrypt`](jwe_flattened_encrypt.FlattenedEncrypt.md)
+`this`
diff --git a/docs/classes/jwe_general_encrypt.GeneralEncrypt.md b/docs/classes/jwe_general_encrypt.GeneralEncrypt.md
@@ -89,7 +89,7 @@ ___
 
 ### setAdditionalAuthenticatedData
 
-▸ **setAdditionalAuthenticatedData**(`aad`): [`GeneralEncrypt`](jwe_general_encrypt.GeneralEncrypt.md)
+▸ **setAdditionalAuthenticatedData**(`aad`): `this`
 
 Sets the Additional Authenticated Data on the GeneralEncrypt object.
 
@@ -101,7 +101,7 @@ Sets the Additional Authenticated Data on the GeneralEncrypt object.
 
 #### Returns
 
-[`GeneralEncrypt`](jwe_general_encrypt.GeneralEncrypt.md)
+`this`
 
 ___
 

diff --git a/docs/classes/jws_compact_sign.CompactSign.md b/docs/classes/jws_compact_sign.CompactSign.md
@@ -51,7 +51,7 @@ console.log(jws)
 
 ### setProtectedHeader
 
-▸ **setProtectedHeader**(`protectedHeader`): [`CompactSign`](jws_compact_sign.CompactSign.md)
+▸ **setProtectedHeader**(`protectedHeader`): `this`
 
 Sets the JWS Protected Header on the Sign object.
 
@@ -63,7 +63,7 @@ Sets the JWS Protected Header on the Sign object.
 
 #### Returns
 
-[`CompactSign`](jws_compact_sign.CompactSign.md)
+`this`
 
 ___
 

diff --git a/docs/classes/jws_flattened_sign.FlattenedSign.md b/docs/classes/jws_flattened_sign.FlattenedSign.md
@@ -52,7 +52,7 @@ console.log(jws)
 
 ### setProtectedHeader
 
-▸ **setProtectedHeader**(`protectedHeader`): [`FlattenedSign`](jws_flattened_sign.FlattenedSign.md)
+▸ **setProtectedHeader**(`protectedHeader`): `this`
 
 Sets the JWS Protected Header on the FlattenedSign object.
 
@@ -64,13 +64,13 @@ Sets the JWS Protected Header on the FlattenedSign object.
 
 #### Returns
 
-[`FlattenedSign`](jws_flattened_sign.FlattenedSign.md)
+`this`
 
 ___
 
 ### setUnprotectedHeader
 
-▸ **setUnprotectedHeader**(`unprotectedHeader`): [`FlattenedSign`](jws_flattened_sign.FlattenedSign.md)
+▸ **setUnprotectedHeader**(`unprotectedHeader`): `this`
 
 Sets the JWS Unprotected Header on the FlattenedSign object.
 
@@ -82,7 +82,7 @@ Sets the JWS Unprotected Header on the FlattenedSign object.
 
 #### Returns
 
-[`FlattenedSign`](jws_flattened_sign.FlattenedSign.md)
+`this`
 
 ___