Added JSDoc to slackEscape method

philliphenslee · Oct 30, 2015 · e227721 · e227721
1 parent 30b02a6
commit e227721
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/lib/common.js b/lib/common.js
@@ -1,12 +1,16 @@
 'use strict';
 var _ = require('lodash');
-
-function slackEscape(data) {
+/**
+ * Escape message text for Slack
+ * @param {string} text The slack message text
+ * @returns {string} text The escaped message text
+ */
+function slackEscape(text) {
     var char = [['&', '&amp;'], ['<', '&lt;'], ['>', '&gt;']];
     _.each(char, function (i) {
-        data = data.replace(i[0], i[1]);
+        text = text.replace(i[0], i[1]);
     });
-    return data;
+    return text;
 }
 
 module.exports = {