[worker] add some doc

encointer · May 1, 2024 · 33600bf · 33600bf
1 parent 3ec349d
commit 33600bf
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/packages/worker-api/src/webCryptoRSA.ts b/packages/worker-api/src/webCryptoRSA.ts
@@ -1,7 +1,9 @@
 import BN from "bn.js";
 
-type CryptoKey = import("crypto").KeyObject | import("@peculiar/webcrypto").CryptoKey;
-
+/**
+ * Provides crypto in both, the browser and in the node-js environment (like our tests)
+ * via the `@peculiar/webcrypto` polyfill.
+ */
 let cryptoProvider: any;
 
 if (typeof window !== "undefined" && typeof window.crypto !== "undefined") {
@@ -11,6 +13,12 @@ if (typeof window !== "undefined" && typeof window.crypto !== "undefined") {
     cryptoProvider = new Crypto();
 }
 
+/**
+ * Type dependent on our environment browser vs. node-js.
+ */
+type CryptoKey = import("crypto").KeyObject | import("@peculiar/webcrypto").CryptoKey;
+
+
 export async function parseWebCryptoRSA(data: any): Promise<CryptoKey> {
     const keyJson = JSON.parse(data);