From 4e9551f7770e364e6590ad088fe749748510a161 Mon Sep 17 00:00:00 2001
From: M M <cosmicray23@hotmail.com>
Date: Mon, 22 Jul 2024 19:49:33 -0700
Subject: [PATCH] Add docs.

---
 Server/service/pageSpeedService.js | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Server/service/pageSpeedService.js b/Server/service/pageSpeedService.js
index 032319977..1b7bd25e1 100644
--- a/Server/service/pageSpeedService.js
+++ b/Server/service/pageSpeedService.js
@@ -7,6 +7,11 @@ class PageSpeedService {
     this.SERVICE_NAME = "PageSpeedService";
   }
 
+  /**
+   * Runs a PageSpeed check using Google Lighthouse API.
+   * @param {string} url - The URL to check.
+   * @returns {Promise<Object>} The results from the PageSpeed API.
+   */
   async runPageSpeedCheck(url) {
     try {
       const response = await axios.get(`https://www.googleapis.com/pagespeedonline/v5/runPagespeed?url=${url}`);
@@ -20,6 +25,11 @@ class PageSpeedService {
     }
   }
 
+  /**
+   * Creates a new PageSpeedCheck document.
+   * @param {Object} data - The data for the new PageSpeedCheck.
+   * @returns {Promise<PageSpeedCheck>} The created PageSpeedCheck document.
+   */
   async createPageSpeedCheck(data) {
     const newPageSpeedCheck = new PageSpeedCheck(data);
     return await newPageSpeedCheck.save();