vue-qrcode-reader - npm Package Compare versions

Comparing version 5.3.0 to 5.3.1

dist/components/QrcodeStream.vue.d.ts

 import { type PropType } from 'vue';
 declare const _sfc_main: import("vue").DefineComponent<{
     constraints: {
-        type: ObjectConstructor;
+        type: PropType<MediaTrackConstraints>;
         default(): {
@@ -26,3 +26,3 @@ facingMode: string;
     constraints: {
-        type: ObjectConstructor;
+        type: PropType<MediaTrackConstraints>;
         default(): {
@@ -53,3 +53,5 @@ facingMode: string;
 }, {
-    constraints: Record<string, any>;
+    constraints: {
+        facingMode: string;
+    };
     formats: ("aztec" | "code_128" | "code_39" | "code_93" | "codabar" | "data_matrix" | "ean_13" | "ean_8" | "itf" | "pdf417" | "qr_code" | "upc_a" | "upc_e" | "unknown")[];
@@ -56,0 +58,0 @@ paused: boolean;

dist/misc/camera.d.ts

@@ -5,3 +5,3 @@ export declare function stop(): void;
     constraints: MediaTrackConstraints;
-    torch: string;
+    torch: boolean;
 }): Promise<MediaTrackCapabilities>;

dist/misc/scanner.d.ts

 import { type DetectedBarcode, type BarcodeFormat } from '@sec-ant/barcode-detector/pure';
 export declare const setScanningFormats: (formats: BarcodeFormat[]) => void;
+type ScanHandler = (_: DetectedBarcode[]) => void;
 /**
@@ -7,8 +8,10 @@ * Continuously extracts frames from camera stream and tries to read
  */
-export declare const keepScanning: (videoElement: HTMLVideoElement, { detectHandler, locateHandler, minDelay }: {
-    detectHandler: any;
-    locateHandler: any;
-    minDelay: any;
+export declare const keepScanning: (videoElement: HTMLVideoElement, { detectHandler, locateHandler, minDelay, formats }: {
+    detectHandler: ScanHandler;
+    locateHandler: ScanHandler;
+    minDelay: number;
+    formats: BarcodeFormat[];
 }) => Promise<void>;
 export declare const processFile: (file: File, formats?: BarcodeFormat[]) => Promise<DetectedBarcode[]>;
 export declare const processUrl: (url: string, formats?: BarcodeFormat[]) => Promise<DetectedBarcode[]>;
+export {};

dist/misc/util.d.ts

@@ -6,1 +6,24 @@ /**
 export declare const indempotent: <T>(action: (x: any) => T) => (...args: any[]) => T;
+/**
+ * Throws an error if the `condition` in the first argument is `false`.
+ * This function is useful to make assumptions explicit. For example,
+ * let's say we have a variable
+ *
+ *     const value : string | undefined = ...
+ *
+ * but from the context we know that it can actually never be `undefined`.
+ * We can access attributes of `value` with
+ *
+ *     value?.length
+ *
+ * but if the assumption is actually broken, we can a silent error.
+ * In contrast, with
+ *
+ *     assert(value !== undefined, 'reason why we assume value always defined')
+ *     value.length // no type error
+ *
+ * We make the assumption explicit and force a laud error. Also the type
+ * check can narrow the type of `value` to `string` after the `assert` and we
+ * can access properties without type error.
+ */
+export declare function assert(condition: boolean, failureMessage?: string): asserts condition;

package.json

 {
   "name": "vue-qrcode-reader",
-  "version": "5.3.0",
+  "version": "5.3.1",
   "description": "A set of Vue.js components for detecting and decoding QR codes.",
@@ -5,0 +5,0 @@ "author": {

README.md

@@ -60,9 +60,12 @@ <p align="center">
 
-A set of Vue.js components, allowing you to detect and decode QR codes, without leaving the browser.
+A set of Vue.js components for detecting QR codes and [various other barcode formats](https://developer.mozilla.org/en-US/docs/Web/API/Barcode_Detection_API#supported_barcode_formats) right in the browser:
 
-- :movie_camera: `QrcodeStream` accesses the device camera and continuously scans incoming frames.
-- :put_litter_in_its_place: `QrcodeDropZone` renders to an empty region where you can drag-and-drop images to be decoded.
+- :movie_camera: `QrcodeStream` continuously scans frames from a camera stream.
+- :put_litter_in_its_place: `QrcodeDropZone` is an empty region where you can drag-and-drop images to be decoded.
 - :open_file_folder: `QrcodeCapture` is a classic file upload field, instantly scanning all files you select.
 
-All components are responsive. Beyond that, close to zero styling. Make them fit your layout. Usage is simple and straight forward:
+All components are responsive. 
+Beyond that, close to zero styling. 
+Make them fit your layout. 
+Usage is simple and straight forward:
 
@@ -81,8 +84,7 @@ ```html
 
-### Screenshots
+### Preview
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/gruhn/vue-qrcode-reader/master/.github/screenshot1.png" height="500" alt="Screenshot 1">
-  <img src="https://raw.githubusercontent.com/gruhn/vue-qrcode-reader/master/.github/screenshot2.png" height="500" alt="Screenshot 2">
-  <img src="https://raw.githubusercontent.com/gruhn/vue-qrcode-reader/master/.github/screenshot3.png" height="500" alt="Screenshot 3">
+  <img src="https://raw.githubusercontent.com/gruhn/vue-qrcode-reader/master/.github/preview1.gif" width="280" alt="preview screencast 1" />
+  <img src="https://raw.githubusercontent.com/gruhn/vue-qrcode-reader/master/.github/preview2.gif" width="280" alt="preview screencast 2" />
 </p>
@@ -89,0 +91,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

187480

increased by1.52%

Lines of code

3362

increased by1.02%

Number of lines in readme file

180

increased by1.12%

No dependency changes