chore: add method doc for unexported log method in logger.js

rudderlabs · Jun 14, 2024 · 6279c79 · 6279c79
1 parent 710746f
commit 6279c79
Showing 1 changed file with 9 additions and 0 deletions.
diff --git 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) {