From 7736828c95a2c20ea8f5c4a868e6d211ad79655d Mon Sep 17 00:00:00 2001 From: M M Date: Mon, 15 Jul 2024 14:42:48 -0700 Subject: [PATCH] Added JS docs. --- Server/models/Metrics.js | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/Server/models/Metrics.js b/Server/models/Metrics.js index 2d14907d7..d5cbe184b 100644 --- a/Server/models/Metrics.js +++ b/Server/models/Metrics.js @@ -1,5 +1,15 @@ const mongoose = require("mongoose"); +/** + * Mongoose schema for storing metrics from Google Lighthouse. + * @typedef {Object} MetricsSchema + * @property {mongoose.Schema.Types.ObjectId} monitorId - Reference to the Monitor model. + * @property {number} accessibility - Accessibility score. + * @property {number} bestPractices - Best practices score. + * @property {number} seo - SEO score. + * @property {number} performance - Performance score. + */ + const MetricsSchema = mongoose.Schema( { monitorId: { @@ -29,4 +39,9 @@ const MetricsSchema = mongoose.Schema( } ); +/** + * Mongoose model for storing metrics from Google Lighthouse. + * @typedef {mongoose.Model} LighthouseMetricsModel + */ + module.exports = mongoose.model("LighthouseMetrics", MetricsSchema);