Scanner#Stop to return Promise (#76)

mebjas · Jul 5, 2020 · 14fbc64 · 14fbc64
1 parent fabb8da
commit 14fbc64
Show file tree

Hide file tree

Showing 6 changed files with 90 additions and 70 deletions.
diff --git a/README.md b/README.md
@@ -323,48 +323,51 @@ class Html5Qrcode {
 }
 
 class Html5QrcodeScanner {
-	/**
-	 * Creates instance of this class.
-	 *
-	 * @param {String} elementId - Id of the HTML element.
-	 * @param {Object} config extra configurations to tune QR code scanner.
-	 *  Supported Fields:
-	 *      - fps: expected framerate of qr scanning. example { fps: 2 }
-	 *          means the scanning would be done every 500 ms.
-	 *      - qrbox: width of QR scanning box, this should be smaller than
-	 *          the width and height of the box. This would make the scanner
-	 *          look like this:
-	 *          ----------------------
-	 *          |********************|
-	 *          |******,,,,,,,,,*****|      <--- shaded region
-	 *          |******|       |*****|      <--- non shaded region would be
-	 *          |******|       |*****|          used for QR code scanning.
-	 *          |******|_______|*****|
-	 *          |********************|
-	 *          |********************|
-	 *          ----------------------
-	 * @param {Boolean} verbose - Optional argument, if true, all logs
-	 *                  would be printed to console. 
-	 */
-	constructor(elementId, config, verbose) {}
-
-	/**
-	 * Renders the User Interface
-	 * 
-	 * @param {Function} qrCodeSuccessCallback - callback on QR Code found.
-	 *  Example:
-	 *      function(qrCodeMessage) {}
-	 * @param {Function} qrCodeErrorCallback - callback on QR Code parse error.
-	 *  Example:
-	 *      function(errorMessage) {}
-	 * 
-	 */
-	render(qrCodeSuccessCallback, qrCodeErrorCallback) {}
-
-	/**
-	 * Removes the QR Code scanner.
-	 */
-	clear() {}
+    /**
+     * Creates instance of this class.
+     *
+     * @param {String} elementId - Id of the HTML element.
+     * @param {Object} config extra configurations to tune QR code scanner.
+     *  Supported Fields:
+     *      - fps: expected framerate of qr scanning. example { fps: 2 }
+     *          means the scanning would be done every 500 ms.
+     *      - qrbox: width of QR scanning box, this should be smaller than
+     *          the width and height of the box. This would make the scanner
+     *          look like this:
+     *          ----------------------
+     *          |********************|
+     *          |******,,,,,,,,,*****|      <--- shaded region
+     *          |******|       |*****|      <--- non shaded region would be
+     *          |******|       |*****|          used for QR code scanning.
+     *          |******|_______|*****|
+     *          |********************|
+     *          |********************|
+     *          ----------------------
+     * @param {Boolean} verbose - Optional argument, if true, all logs
+     *                  would be printed to console. 
+     */
+    constructor(elementId, config, verbose) {}
+
+    /**
+     * Renders the User Interface
+     * 
+     * @param {Function} qrCodeSuccessCallback - callback on QR Code found.
+     *  Example:
+     *      function(qrCodeMessage) {}
+     * @param {Function} qrCodeErrorCallback - callback on QR Code parse error.
+     *  Example:
+     *      function(errorMessage) {}
+     * 
+     */
+    render(qrCodeSuccessCallback, qrCodeErrorCallback) {}
+
+    /**
+     * Removes the QR Code scanner.
+     * 
+     * @returns Promise which succeeds if the cleanup is complete successfully,
+     *  fails otherwise.
+     */
+    clear() {}
 }
 ```
 

diff --git a/changelog.md b/changelog.md
@@ -1,3 +1,6 @@
+### Version 1.1.7
+ + `Html5QrcodeScanner#clear()` returns a `Promise`.
+
 ### Version 1.1.6
  + Bug fixes
    + [#74](https://github.com/mebjas/html5-qrcode/issues/74) - state errors on file based scanning.

diff --git a/html5-qrcode.js b/html5-qrcode.js
@@ -935,6 +935,9 @@ class Html5QrcodeScanner {
 
     /**
      * Removes the QR Code scanner.
+     * 
+     * @returns Promise which succeeds if the cleanup is complete successfully,
+     *  fails otherwise.
      */
     clear() {
         const $this = this;
@@ -946,21 +949,24 @@ class Html5QrcodeScanner {
         }
 
         if (this.html5Qrcode) {
-            if (this.html5Qrcode._isScanning()) {
-                this.html5Qrcode.stop().then(_ => {
-                    $this.html5Qrcode.clear();
-                    emptyHtmlContainer();
-                }).catch(error => {
-                    if ($this.verbose) {
-                        console.error("Unable to stop qrcode scanner", error);
-                    }
-                    $this.html5Qrcode.clear();
-                    emptyHtmlContainer();
-                })
-            }
+            return new Promise((resolve, reject) => {
+                if (this.html5Qrcode._isScanning()) {
+                    this.html5Qrcode.stop().then(_ => {
+                        $this.html5Qrcode.clear();
+                        emptyHtmlContainer();
+                        resolve();
+                    }).catch(error => {
+                        if ($this.verbose) {
+                            console.error("Unable to stop qrcode scanner", error);
+                        }
+                        reject(error);
+                    })
+                }
+            });
         }
     }
 
+    //#region private control methods
     __createBasicLayout(parent) {
         parent.style.position = "relative";
         parent.style.padding = "0px";
@@ -1373,6 +1379,7 @@ class Html5QrcodeScanner {
             this.__getScanRegionId());
         qrCodeScanRegion.innerHTML = "";
     }
+    //#endregion
 
     //#region state getters
     __getDashboardSectionId() {

diff --git a/minified/html5-qrcode.min.js b/minified/html5-qrcode.min.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "html5-qrcode",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "a cross platform HTML5 QR Code scanner",
   "main": "html5-qrcode.js",
   "scripts": {

diff --git a/transpiled/html5-qrcode.js b/transpiled/html5-qrcode.js
@@ -1013,6 +1013,9 @@ var Html5QrcodeScanner = /*#__PURE__*/function () {
     }
     /**
      * Removes the QR Code scanner.
+     * 
+     * @returns Promise which succeeds if the cleanup is complete successfully,
+     *  fails otherwise.
      */
 
   }, {
@@ -1031,21 +1034,24 @@ var Html5QrcodeScanner = /*#__PURE__*/function () {
       };
 
       if (this.html5Qrcode) {
-        if (this.html5Qrcode._isScanning()) {
-          this.html5Qrcode.stop().then(function (_) {
-            $this.html5Qrcode.clear();
-            emptyHtmlContainer();
-          })["catch"](function (error) {
-            if ($this.verbose) {
-              console.error("Unable to stop qrcode scanner", error);
-            }
+        return new Promise(function (resolve, reject) {
+          if (_this4.html5Qrcode._isScanning()) {
+            _this4.html5Qrcode.stop().then(function (_) {
+              $this.html5Qrcode.clear();
+              emptyHtmlContainer();
+              resolve();
+            })["catch"](function (error) {
+              if ($this.verbose) {
+                console.error("Unable to stop qrcode scanner", error);
+              }
 
-            $this.html5Qrcode.clear();
-            emptyHtmlContainer();
-          });
-        }
+              reject(error);
+            });
+          }
+        });
       }
-    }
+    } //#region private control methods
+
   }, {
     key: "__createBasicLayout",
     value: function __createBasicLayout(parent) {
@@ -1479,7 +1485,8 @@ var Html5QrcodeScanner = /*#__PURE__*/function () {
     value: function __clearScanRegion() {
       var qrCodeScanRegion = document.getElementById(this.__getScanRegionId());
       qrCodeScanRegion.innerHTML = "";
-    } //#region state getters
+    } //#endregion
+    //#region state getters
 
   }, {
     key: "__getDashboardSectionId",