Added docs.

This commit is contained in:
M M committed 2024-07-15 14:08:17 -07:00
1 parent 19861f3253
commit 5883fa0747
1 file changed
+16
+16
View File
@@ -1,5 +1,16 @@
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 {Object} accessibility - Metrics related to accessibility category.
* @property {Object} bestPractices - Metrics related to best practices category.
* @property {Object} seo - Metrics related to SEO category.
* @property {Object} performance - Metrics related to performance category.
* @property {Date} timestamp - Timestamp when the metrics were recorded.
*/
const MetricsSchema = mongoose.Schema(
{
monitorId: {
@@ -33,4 +44,9 @@ const MetricsSchema = mongoose.Schema(
}
);
/**
* Mongoose model for storing metrics from Google Lighthouse.
* @typedef {mongoose.Model<MetricsSchema>} LighthouseMetricsModel
*/
module.exports = mongoose.model("LighthouseMetrics", MetricsSchema);