docs: add more code comments

index.js

@@ -13,10 +13,15 @@ export default {
       return;
     }
 
+    // hook into `http.Server.prototype.onSocket` in order to get
+    // access to the `http.ClientRequest` instance of every request
+    // sent using the `http(s)` modules.
     origOnSocket = http.ClientRequest.prototype.onSocket;
     http.ClientRequest.prototype.onSocket = function (socket) {
       const interceptedRequest = this;
 
+      // read the request body as an array of Buffer chuncks
+      // by hooking into the `request.write` method.
       const requestBodyChunks = [];
       const originalRequestWrite = interceptedRequest.write;
       interceptedRequest.write = function (chunk) {
@@ -25,11 +30,13 @@ export default {
       };
 
       interceptedRequest.on("response", async (response) => {
+        // read the response body as an array of Buffer chuncks
         const responseBodyChunks = [];
         for await (const chunk of response) {
           responseBodyChunks.push(Buffer.from(chunk));
         }
 
+        // emit the `request` event with the request and response body
         emitter.emit("record", {
           request: interceptedRequest,
           requestBody: requestBodyChunks,
@@ -38,6 +45,8 @@ export default {
         });
       });
 
+      // run the original `http.Server.prototype.onSocket` method
+      // and return its value
       return origOnSocket.call(this, socket);
     };