From 519ef1404f5a3fa0b542cf3bbd2633f8bb86c483 Mon Sep 17 00:00:00 2001
From: M M <cosmicray23@hotmail.com>
Date: Tue, 16 Jul 2024 10:54:59 -0700
Subject: [PATCH] Added JS Docs.

---
 .../controllers/pageSpeedCheckController.js   | 24 +++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/Server/controllers/pageSpeedCheckController.js b/Server/controllers/pageSpeedCheckController.js
index 21fc7b09c..29cc10f95 100644
--- a/Server/controllers/pageSpeedCheckController.js
+++ b/Server/controllers/pageSpeedCheckController.js
@@ -2,6 +2,14 @@ const PageSpeedCheck = require("../models/PageSpeedCheck");
 const { successMessages } = require("../utils/messages");
 const SERVICE_NAME = "pagespeed";
 
+/**
+ * Gets all PageSpeedChecks for a monitor
+ * @async
+ * @param {Express.Request} req - The request object
+ * @param {Express.Response} res - The response object
+ * @param {Function} next - The next middleware function
+ * @returns {Promise<Express.Response>}
+ */
 const getPageSpeedChecks = async (req, res, next) => {
   try {
     return res.status(200).json({ msg: "Hit getPageSpeedChecks" });
@@ -11,6 +19,14 @@ const getPageSpeedChecks = async (req, res, next) => {
   }
 };
 
+/**
+ * Creates a new PageSpeedCheck for a monitor
+ * @async
+ * @param {Express.Request} req - The request object
+ * @param {Express.Response} res - The response object
+ * @param {Function} next - The next middleware function
+ * @returns {Promise<Express.Response>}
+ */
 const createPageSpeedCheck = async (req, res, next) => {
   try {
     return res.status(200).json({ msg: "Hit createPageSpeedCheck" });
@@ -20,6 +36,14 @@ const createPageSpeedCheck = async (req, res, next) => {
   }
 };
 
+/**
+ * Deletes all PageSpeedChecks for a monitor
+ * @async
+ * @param {Express.Request} req - The request object
+ * @param {Express.Response} res - The response object
+ * @param {Function} next - The next middleware function
+ * @returns {Promise<Express.Response>}
+ */
 const deletePageSpeedCheck = async (req, res, next) => {
   try {
     return res.status(200).json({ msg: "Hit deletePageSpeedCheck" });