From 6279c79bb19e70c444cafbca928811cb40e1722c Mon Sep 17 00:00:00 2001
From: Sai Sankeerth <sanpj2292@github.com>
Date: Fri, 14 Jun 2024 19:02:46 +0530
Subject: [PATCH] chore: add method doc for unexported log method in logger.js

---
 src/logger.js | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/logger.js b/src/logger.js
index b523aff260..6cec795498 100644
--- a/src/logger.js
+++ b/src/logger.js
@@ -58,6 +58,15 @@ const getLogMetadata = (metadata) => {
   };
 };
 
+/**
+ * Perform logging operation on logMethod passed
+ *
+ * @param {*} logMethod
+ *  - instance method reference
+ *  - The logger should implement all of debug/info/warn/error methods
+ * @param {*} args
+ *  - the arguments that needs to be passed to logger instance method
+ */
 const log = (logMethod, args) => {
   const [message, logInfo, ...otherArgs] = args;
   if (logInfo) {