@fttx/barcode-scanner - npm Package Compare versions

Comparing version 4.12.3 to 4.13.4

index.d.ts

@@ -48,2 +48,6 @@ import { IonicNativePlugin } from '@ionic-native/core';
     continuousMode?: boolean;
+    /**
+     * Enable vibration feedback when a scan is performed.
+     */
+    vibrationFeedback?: boolean;
 }
@@ -50,0 +54,0 @@ export interface BarcodeScanResult {

index.js

@@ -66,3 +66,13 @@ var __extends = (this && this.__extends) || (function () {
      */
-    BarcodeScanner.prototype.scan = function (options) {
+    /**
+       * Open the barcode scanner.
+       * @param {BarcodeScannerOptions} [options] Optional options to pass to the scanner
+       * @returns {Observable<any>} Returns an Observable that resolves with scanner data, or rejects with an error.
+       */
+    BarcodeScanner.prototype.scan = /**
+       * Open the barcode scanner.
+       * @param {BarcodeScannerOptions} [options] Optional options to pass to the scanner
+       * @returns {Observable<any>} Returns an Observable that resolves with scanner data, or rejects with an error.
+       */
+    function (options) {
         return;
@@ -77,3 +87,17 @@ };
      */
-    BarcodeScanner.prototype.encode = function (type, data) {
+    /**
+       * Encodes data into a barcode.
+       * NOTE: not well supported on Android
+       * @param {string} type Type of encoding
+       * @param {any} data Data to encode
+       * @returns {Promise<any>}
+       */
+    BarcodeScanner.prototype.encode = /**
+       * Encodes data into a barcode.
+       * NOTE: not well supported on Android
+       * @param {string} type Type of encoding
+       * @param {any} data Data to encode
+       * @returns {Promise<any>}
+       */
+    function (type, data) {
         return;
@@ -84,4 +108,2 @@ };
     ];
-    /** @nocollapse */
-    BarcodeScanner.ctorParameters = function () { return []; };
     __decorate([
@@ -102,2 +124,28 @@ Cordova({
     ], BarcodeScanner.prototype, "encode", null);
+    /**
+     * @name Barcode Scanner
+     * @description
+     * The Barcode Scanner Plugin opens a camera view and automatically scans a barcode, returning the data back to you.
+     *
+     * Requires Cordova plugin: `phonegap-plugin-barcodescanner`. For more info, please see the [BarcodeScanner plugin docs](https://github.com/phonegap/phonegap-plugin-barcodescanner).
+     *
+     * @usage
+     * ```typescript
+     * import { BarcodeScanner } from '@ionic-native/barcode-scanner';
+     *
+     * constructor(private barcodeScanner: BarcodeScanner) { }
+     *
+     * ...
+     *
+     *
+     * this.barcodeScanner.scan().then(barcodeData => {
+     *  console.log('Barcode data', barcodeData);
+     * }).catch(err => {
+     * 	console.log('Error', err);
+     * });
+     * ```
+     * @interfaces
+     * BarcodeScannerOptions
+     * BarcodeScanResult
+     */
     BarcodeScanner = __decorate([
@@ -104,0 +152,0 @@ Plugin({

index.metadata.json

@@ -1,1 +0,1 @@
-[{"__symbolic":"module","version":3,"metadata":{"BarcodeScannerOptions":{"__symbolic":"interface"},"BarcodeScanResult":{"__symbolic":"interface"},"BarcodeScanner":{"__symbolic":"class","extends":{"__symbolic":"reference","module":"@ionic-native/core","name":"IonicNativePlugin"},"decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@ionic-native/core","name":"Plugin"},"arguments":[{"pluginName":"BarcodeScanner","plugin":"phonegap-plugin-barcodescanner","pluginRef":"cordova.plugins.barcodeScanner","repo":"https://github.com/phonegap/phonegap-plugin-barcodescanner","platforms":["Android","BlackBerry 10","Browser","iOS","Windows"]}]},{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable"}}],"members":{"scan":[{"__symbolic":"method","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@ionic-native/core","name":"Cordova"},"arguments":[{"observable":true,"callbackOrder":"reverse"}]}]}],"encode":[{"__symbolic":"method","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@ionic-native/core","name":"Cordova"}}]}]}}}},{"__symbolic":"module","version":1,"metadata":{"BarcodeScannerOptions":{"__symbolic":"interface"},"BarcodeScanResult":{"__symbolic":"interface"},"BarcodeScanner":{"__symbolic":"class","extends":{"__symbolic":"reference","module":"@ionic-native/core","name":"IonicNativePlugin"},"decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@ionic-native/core","name":"Plugin"},"arguments":[{"pluginName":"BarcodeScanner","plugin":"phonegap-plugin-barcodescanner","pluginRef":"cordova.plugins.barcodeScanner","repo":"https://github.com/phonegap/phonegap-plugin-barcodescanner","platforms":["Android","BlackBerry 10","Browser","iOS","Windows"]}]},{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable"}}],"members":{"scan":[{"__symbolic":"method","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@ionic-native/core","name":"Cordova"},"arguments":[{"observable":true,"callbackOrder":"reverse"}]}]}],"encode":[{"__symbolic":"method","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@ionic-native/core","name":"Cordova"}}]}]}}}}]
+[{"__symbolic":"module","version":4,"metadata":{"BarcodeScannerOptions":{"__symbolic":"interface"},"BarcodeScanResult":{"__symbolic":"interface"},"BarcodeScanner":{"__symbolic":"class","extends":{"__symbolic":"reference","module":"@ionic-native/core","name":"IonicNativePlugin","line":122,"character":36},"decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@ionic-native/core","name":"Plugin","line":114,"character":1},"arguments":[{"pluginName":"BarcodeScanner","plugin":"phonegap-plugin-barcodescanner","pluginRef":"cordova.plugins.barcodeScanner","repo":"https://github.com/phonegap/phonegap-plugin-barcodescanner","platforms":["Android","BlackBerry 10","Browser","iOS","Windows"]}]},{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable","line":121,"character":1}}],"members":{"scan":[{"__symbolic":"method","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@ionic-native/core","name":"Cordova","line":140,"character":3},"arguments":[{"observable":true,"callbackOrder":"reverse"}]}]}],"encode":[{"__symbolic":"method","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@ionic-native/core","name":"Cordova","line":155,"character":3}}]}]}}}}]

package.json

 {
   "name": "@fttx/barcode-scanner",
-  "version": "4.12.3",
+  "version": "4.13.4",
   "description": "Ionic Native - Native plugins for ionic apps",
@@ -5,0 +5,0 @@ "module": "index.js",

No alert changes

Improved metrics

Total package byte prevSize

18006

13.87%

Number of package files

7

40%

Lines of code

263

24.64%

No dependency changes