Added JS docs.

This commit is contained in:
M M committed 2024-07-15 14:42:48 -07:00
1 parent 3c2ea63fc7
commit 7736828c95
1 file changed
+15
+15
View File
@@ -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<MetricsSchema>} LighthouseMetricsModel
*/
module.exports = mongoose.model("LighthouseMetrics", MetricsSchema);