1 files changed, 10 insertions, 12 deletions
diff --git a/app/assets/javascripts/locale/sprintf.js b/app/assets/javascripts/locale/sprintf.js
index 12df67670f9..7faf9390684 100644
--- a/app/assets/javascripts/locale/sprintf.js
+++ b/app/assets/javascripts/locale/sprintf.js
@@ -1,17 +1,15 @@
 import { escape } from 'lodash';
 
 /**
-  Very limited implementation of sprintf supporting only named parameters.
-
-  @param input (translated) text with parameters (e.g. '%{num_users} users use us')
-  @param {Object} parameters object mapping parameter names to values (e.g. { num_users: 5 })
-  @param {Boolean} escapeParameters whether parameter values should be escaped (see https://lodash.com/docs/4.17.15#escape)
-  @returns {String} the text with parameters replaces (e.g. '5 users use us')
-
-  @see https://ruby-doc.org/core-2.3.3/Kernel.html#method-i-sprintf
-  @see https://gitlab.com/gitlab-org/gitlab-foss/issues/37992
-*/
-export default (input, parameters, escapeParameters = true) => {
+ * Very limited implementation of sprintf supporting only named parameters.
+ * @param {string} input - (translated) text with parameters (e.g. '%{num_users} users use us')
+ * @param {Object.<string, string|number>} [parameters] - object mapping parameter names to values (e.g. { num_users: 5 })
+ * @param {boolean} [escapeParameters=true] - whether parameter values should be escaped (see https://lodash.com/docs/4.17.15#escape)
+ * @returns {string} the text with parameters replaces (e.g. '5 users use us')
+ * @see https://ruby-doc.org/core-2.3.3/Kernel.html#method-i-sprintf
+ * @see https://gitlab.com/gitlab-org/gitlab-foss/issues/37992
+ */
+export default function sprintf(input, parameters, escapeParameters = true) {
   let output = input;
 
   output = output.replace(/%+/g, '%');
@@ -29,4 +27,4 @@ export default (input, parameters, escapeParameters = true) => {
   }
 
   return output;
-};
+}