From ba00e9afffe2660da19d3b0c1a299597983e7fb0 Mon Sep 17 00:00:00 2001 From: Owaise Imdad Date: Sat, 21 Jun 2025 00:25:30 +0530 Subject: [PATCH] Added JSDocs in module file. --- server/db/mongo/modules/networkCheckModule.js | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/server/db/mongo/modules/networkCheckModule.js b/server/db/mongo/modules/networkCheckModule.js index 608113a73..8d44af96f 100644 --- a/server/db/mongo/modules/networkCheckModule.js +++ b/server/db/mongo/modules/networkCheckModule.js @@ -1,8 +1,15 @@ import NetworkCheck from "../../models/NetworkCheck.js"; -import logger from "../../../utils/logger.js"; const SERVICE_NAME = "networkCheckModule"; +/** + * Creates and saves a new network check document to the database. + * @async + * @param {object} networkCheckData - The data for the new network check. This should conform to the NetworkCheckSchema. + * @param {string} networkCheckData.monitorId - The ID of the monitor associated with this check. + * @returns {Promise} A promise that resolves to the newly created network check document. + * @throws {Error} Throws an error if the database operation fails. + */ const createNetworkCheck = async (networkCheckData) => { try { const networkCheck = await new NetworkCheck(networkCheckData);