Michel2/qr-scanner
1
0
Fork 0
mirror of https://github.com/nimiq/qr-scanner.git synced 2026-07-27 19:56:28 +00:00
Code Activity

Readme: add additional notes of using new api vs old

Browse Source
This commit is contained in:
Daniel
2022-06-02 00:09:38 +02:00
parent c6da93458d
commit 34bccc6b27
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -1
View File
@@ -89,7 +89,21 @@ Create a `<video>` element where the web cam video stream should get rendered:
#### 2. Create a QrScanner Instance
```js
const qrScanner = new QrScanner(videoElem, result => console.log('decoded qr code:', result), {});
// To enforce the use of the new api with detailed scan results, call the constructor with an options object, see below.
const qrScanner = new QrScanner(
videoElem,
result => console.log('decoded qr code:', result),
{ /* your options or returnDetailedScanResult: true if you're not specifying any other options */ },
);
// For backwards compatibility, omitting the options object will currently use the old api, returning scan results as
// simple strings. This old api will be removed in the next major release, by which point the options object is then
// also not required anymore to enable the new api.
const qrScanner = new QrScanner(
videoElem,
result => console.log('decoded qr code:', result),
// No options provided. This will use the old api and is deprecated in the current version until next major version.
);
```
As an optional third parameter an options object can be provided.