minor cleanups

[squeep-authentication-module] / lib / common.js

diff --git a/lib/common.js b/lib/common.js
index 816b65c5bea9ad23052eaf75b06961a20e999037..d69e6ad6a2131d12d975dbaaddaca70fdb3551e5 100644 (file)
--- a/lib/common.js
+++ b/lib/common.js
@@ -20,10 +20,22 @@ const freezeDeep = (o) => {
   return o;
 };
 
+/**
+ * Return a new object duplicating `o`, without the properties specified.
+ * @param {Object} o
+ * @param {String[]} props
+ * @returns {Object}
+ */
 const omit = (o, props) => {
   return Object.fromEntries(Object.entries(o).filter(([k]) => !props.includes(k)));
 };
 
+/**
+ * Helper to log mystery-box statistics.
+ * @param {ConsoleLike} logger
+ * @param {String} scope
+ * @returns {Function}
+ */
 const mysteryBoxLogger = (logger, scope) => {
   return (s) => {
     logger.debug(scope, `${s.packageName}@${s.packageVersion}:${s.method}`, omit(s, [