updated jsdoc for handleReceiveCall

Author: fraisai

lib/src/components/VideoCall.tsx

@@ -190,19 +190,21 @@ const VideoCall = ({ URL, mediaOptions }: { URL: string, mediaOptions: { control
   };
 
   /**
-  * @desc Constructs a new RTCPeerConnection object that also adds the local client's media tracks to this object.
-  * @param {string} userID
+   * @function callUser
+    * @desc Constructs a new RTCPeerConnection object that also adds the local client's media tracks to this object.
+    * @param {string} userID
   */
   const callUser = (userID: string): void => {
     peerRef.current = createPeer(userID);
     localStream.current.getTracks().forEach((track) => senders.current.push(peerRef.current.addTrack(track, localStream.current)));
   };
 
   /**
-  * @desc Creates a new RTCPeerConnection object, which represents a WebRTC connection between the local device and a remote peer and adds event listeners to it
-  * @param {string} userID
-  * @returns {RTCPeerConnection} RTCPeerConnection object 
-  * @see https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/connectionstatechange_event and other events
+   * @function createPeer
+   * @desc Creates a new RTCPeerConnection object, which represents a WebRTC connection between the local device and a remote peer and adds event listeners to it
+   * @param {string} userID
+   * @returns {RTCPeerConnection} RTCPeerConnection object 
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/connectionstatechange_event and other events
   */
   const createPeer = (userID: string): RTCPeerConnection => {
     const peer:RTCPeerConnection = new RTCPeerConnection(configuration);
@@ -260,14 +262,47 @@ const VideoCall = ({ URL, mediaOptions }: { URL: string, mediaOptions: { control
   }
 
   /**
-  * @desc When an offer is received from the SignalingChannel, this function is invoked, creating a new RTCPeerConnection with the local client's media attached and an Answer is created that is then sent back to the original caller through the WebSocket connection.
-  * @param {RTCSessionDescriptionInit} data
-  * @see https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createAnswer 
+   * @namespace handleReceiveCall
+   * @function handleReceiveCall - When Peer A (caller) calls Peer B (callee), Peer B receives an Offer from the SignalingChannel and this function is invoked. It creates a new RTCPeerConnection with the Peer A's media attached and an Answer is created. The Answer is then sent back to Peer A through the SignalingChannel.
+   * @returns answerPayload object with ANSWER action type and the local description as the payload is sent via WebSocket.
+   * @param {Object} data payload object
+   * @property {string} data.sender is the person making the call
+   * @property { RTCSessionDescriptionInit object } data.payload object providing the session description and it consists of a string containing a SDP message indicating an Offer from Peer A. This value is an empty string ("") by default and may not be null.
+   * 
+   * @function createPeer - Creates a new RTCPeerConnection object, which represents a WebRTC connection between the local device and a remote peer and adds event listeners to it
+   * @memberof handleReceiveCall
+   * 
+   * @function RTCSessionDescription - initializes a RTCSessionDescription object, which consists of a description type indicating which part of the offer/answer negotiation process it describes and of the SDP descriptor of the session.
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/RTCSessionDescription
+   * @memberof handleReceiveCall
+   * 
+   * @function setRemoteDescription - If Peer B wants to accept the offer, setRemoteDescription() is called to set the RTCSessionDescriptionInit object's remote description to the incoming offer from Peer A. The description specifies the properties of the remote end of the connection, including the media format.
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/setRemoteDescription
+   * @memberof handleReceiveCall
+   * 
+   * @function createAnswer - Creates an Answer to the Offer received from Peer A during the offer/answer negotiation of a WebRTC connection. The Answer contains information about any media already attached to the session, codecs and options supported by the browser, and any ICE candidates already gathered. 
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createAnswer
+   * @memberof handleReceiveCall
+   * 
+   * @function setLocalDescription - WebRTC selects an appropriate local configuration by invoking setLocalDescription(), which automatically generates an appropriate Answer in response to the received Offer from Peer A. Then we send the Answer through the signaling channel back to Peer A.
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/setLocalDescription
+   * @memberof handleReceiveCall
+   * 
+   * @returns {Promise} A Promise whose fulfillment handler is called with an RTCSessionDescriptionInit object containing the SDP Answer to be delivered to Peer A.
+   * 
   */
   function handleReceiveCall(data: { sender: string, payload: RTCSessionDescriptionInit }): void {
     otherUser.current = data.sender;
     peerRef.current = createPeer(data.sender);
+
+    /**
+     * @type {RTCSessionDescriptionInit object} desc - consists of a description type indicating which part of the answer negotiation process it describes and the SDP descriptor of the session.
+     * @params {string} desc.type - description type with incoming offer
+     * @params {string} desc.sdp - string containing a SDP message, the format for describing multimedia communication sessions. SDP contains the codec, source address, and timing information of audio and video
+     * @see https://developer.mozilla.org/en-US/docs/Glossary/SDP
+     */
     const desc = new RTCSessionDescription(data.payload);
+
     peerRef.current.setRemoteDescription(desc)
     .then(() => {
       localStream.current?.getTracks().forEach((track) => peerRef.current?.addTrack(track, localStream.current));

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "rtconnect",
-  "version": "0.0.53",
+  "name": "rtc-test-run",
+  "version": "0.0.59",
   "description": "A lightweight React library to set up live streaming and real-time video calls with peers.",
   "main": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",