refactor: added file level comment

push-protocol · Sep 15, 2023 · 8b4fed0 · 8b4fed0
1 parent d82e1e5
commit 8b4fed0
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/packages/restapi/src/lib/spaceV2/connect.ts b/packages/restapi/src/lib/spaceV2/connect.ts
@@ -1,3 +1,10 @@
+/**
+ * connect.ts
+ *
+ * The 'connect' function is responsible for establishing peer connections
+ * 
+ * @param {IConnectOptions} options - An object containing signal data and a peer address.
+ */
 import { produce } from "immer";
 
 import { SpaceV2 } from "./SpaceV2";
@@ -7,7 +14,7 @@ import getIncomingIndexFromAddress from "../video/helpers/getIncomingIndexFromAd
 
 export interface IConnectOptions {
     signalData: any;
-    peerAddress?: string;
+    peerAddress: string;
 }
 
 export async function connect(