feat: export component prop types

See: #462 #460

Author: gruhn

.github/workflows/main.yml

@@ -25,6 +25,7 @@ jobs:
           VITEPRESS_BASE: /vue-qrcode-reader/
         run: |
           pnpm install
+          pnpm run type-check
           pnpm run build
           pnpm run docs:build
       - name: Deploy Docs

docs/api/QrcodeStream.md

@@ -223,7 +223,7 @@ When you unpause the camera is restarted so the `camera-on` event is emitted aga
 
 ### `track`
 
-- **Input Type:** `Function`
+- **Input Type:** `(codes: DetectedBarcode[], ctx: CanvasRenderingContext2D) => void`
 - **Default:** `undefined`
 
 You can visually highlight detected QR codes in real-time.
@@ -232,12 +232,13 @@ When a QR code is detected, its location is painted to the canvas.
 
 To enable this feature, pass a function to `track` that defines how this should look like.
 This function is called to produce each frame.
-It receives the location object as the first argument and a `CanvasRenderingContext2D` instance as the second argument.
+It receives an array of detected barcodes as the first argument and a `CanvasRenderingContext2D` instance as the second argument.
 
 For example check out [this demo](../demos/FullDemo.md).
 
-Note that this scanning frequency has to be increased.
-So if you want to go easy on your target device you might not want to enable tracking.
+Note that the scanning frequency is increased when you provide a track function,
+which might hurt performance perceptibly.
+So if you want to go easy on your target device you might want to keep tracking disabled.
 
 ::: danger
 Avoid access to reactive properties in this function (like stuff in `data`, `computed` or your Vuex store). The function is called several times a second and might cause memory leaks. To be safe don't access `this` at all.

package.json

@@ -58,7 +58,7 @@
     "vite-plugin-dts": "3.6.4",
     "vitepress": "1.0.0-rc.32",
     "vue": "3.3.13",
-    "vue-tsc": "1.8.25",
+    "vue-tsc": "2.1.10",
     "workbox-window": "7.0.0"
   },
   "bugs": "https://github.com/gruhn/vue-qrcode-reader/issues",