Added JSDoc TS definition

Author: WebReflection

cjs/index.js

@@ -36,6 +36,12 @@ const esca = {
 };
 const pe = m => esca[m];
 
+/**
+ * Safely escape HTML entities such as `&`, `<`, `>`, `"`, and `'`.
+ * @param {string|number|boolean} es the input to safely escape
+ * @returns {string} the escaped input, and it throws an error if
+ *  the input type is unexpected
+ */
 const escape = es => replace.call(es, ca, pe);
 exports.escape = escape;
 
@@ -55,5 +61,12 @@ const unes = {
 };
 const cape = m => unes[m];
 
+/**
+ * Safely unescape previously escaped entities such as `&`, `<`, `>`, `"`,
+ * and `'`.
+ * @param {string} un a previously escaped string
+ * @returns {string} the unescaped input, and it throws an error if
+ *  the input type is unexpected
+ */
 const unescape = un => replace.call(un, es, cape);
 exports.unescape = unescape;

esm/index.js

@@ -35,6 +35,12 @@ const esca = {
 };
 const pe = m => esca[m];
 
+/**
+ * Safely escape HTML entities such as `&`, `<`, `>`, `"`, and `'`.
+ * @param {string|number|boolean} es the input to safely escape
+ * @returns {string} the escaped input, and it throws an error if
+ *  the input type is unexpected
+ */
 export const escape = es => replace.call(es, ca, pe);
 
 
@@ -53,4 +59,11 @@ const unes = {
 };
 const cape = m => unes[m];
 
+/**
+ * Safely unescape previously escaped entities such as `&`, `<`, `>`, `"`,
+ * and `'`.
+ * @param {string} un a previously escaped string
+ * @returns {string} the unescaped input, and it throws an error if
+ *  the input type is unexpected
+ */
 export const unescape = un => replace.call(un, es, cape);

index.js

@@ -38,6 +38,12 @@ var html = (function (exports) {
   };
   const pe = m => esca[m];
 
+  /**
+   * Safely escape HTML entities such as `&`, `<`, `>`, `"`, and `'`.
+   * @param {string|number|boolean} es the input to safely escape
+   * @returns {string} the escaped input, and it throws an error if
+   *  the input type is unexpected
+   */
   const escape = es => replace.call(es, ca, pe);
 
 
@@ -56,6 +62,13 @@ var html = (function (exports) {
   };
   const cape = m => unes[m];
 
+  /**
+   * Safely unescape previously escaped entities such as `&`, `<`, `>`, `"`,
+   * and `'`.
+   * @param {string} un a previously escaped string
+   * @returns {string} the unescaped input, and it throws an error if
+   *  the input type is unexpected
+   */
   const unescape = un => replace.call(un, es, cape);
 
   exports.escape = escape;

package.json

@@ -7,11 +7,11 @@
   "scripts": {
     "build": "npm run cjs && npm run rollup && npm run minify && npm test && npm run size",
     "cjs": "ascjs esm cjs",
-    "coveralls": "cat ./coverage/lcov.info | coveralls",
+    "coveralls": "c8 report --reporter=text-lcov | coveralls",
     "minify": "uglifyjs index.js --comments=/^!/ --compress --mangle -o min.js",
     "rollup": "rollup --config rollup.config.js",
     "size": "cat index.js | wc -c;cat min.js | wc -c;gzip -c min.js | wc -c",
-    "test": "istanbul cover ./test/index.js"
+    "test": "c8 node ./test/index.js"
   },
   "module": "./esm/index.js",
   "type": "module",
@@ -38,10 +38,10 @@
   },
   "homepage": "https://github.com/WebReflection/html-escaper",
   "devDependencies": {
-    "ascjs": "^3.1.2",
-    "coveralls": "^3.0.11",
-    "istanbul": "^0.4.5",
-    "rollup": "^2.2.0",
+    "ascjs": "^5.0.1",
+    "c8": "^7.6.0",
+    "coveralls": "^3.1.0",
+    "rollup": "^2.39.0",
     "uglify-es": "^3.3.9"
   }
 }

rollup.config.js

@@ -1,6 +1,7 @@
 export default {
   input: 'esm/index.js',
   output: {
+    esModule: false,
     exports: 'named',
     file: 'index.js',
     format: 'iife',