dynamsoft-javascript-barcode
Advanced tools
Comparing version 7.3.0-v0 to 7.3.0-v1
@@ -7,3 +7,3 @@ /** | ||
* @author Dynamsoft | ||
* @version 7.3.0 (js 20200103) | ||
* @version 7.3.0.1 (js 20200103) | ||
* @fileoverview Dynamsoft JavaScript Library for Barcode Reader | ||
@@ -521,11 +521,2 @@ * More info on DBR JS: https://www.dynamsoft.com/Products/barcode-recognition-javascript.aspx | ||
/** | ||
* The method is only supported in the full feature edition. | ||
* Returns intermediate results containing the original image, the colour clustered image, the binarized Image, contours, Lines, TextBlocks, etc. | ||
* ```js | ||
* let imResults = await reader.getIntermediateResults(); | ||
* ``` | ||
* @ignore | ||
*/ | ||
getIntermediateResults(): Promise<any>; | ||
/** | ||
* Sets the optional argument for a specified mode in Modes parameters. | ||
@@ -552,6 +543,15 @@ * ```js | ||
/** | ||
* The method is only supported in the full feature edition. | ||
* Returns intermediate results containing the original image, the colour clustered image, the binarized Image, contours, Lines, TextBlocks, etc. | ||
* ```js | ||
* let imResults = await reader.getIntermediateResults(); | ||
* ``` | ||
* @ignore | ||
*/ | ||
getIntermediateCanvas(): Promise<HTMLCanvasElement | null>; | ||
getIntermediateResults(): Promise<any>; | ||
/** | ||
* @ignore | ||
*/ | ||
getIntermediateCanvas(): Promise<HTMLCanvasElement[]>; | ||
/** | ||
* Destructor the `BarcodeReader` object. | ||
@@ -558,0 +558,0 @@ * Equivalent to the previous method `deleteInstance()`. |
@@ -7,3 +7,3 @@ /** | ||
* @author Dynamsoft | ||
* @version 7.3.0 (js 20200103) | ||
* @version 7.3.0.1 (js 20200103) | ||
* @fileoverview Dynamsoft JavaScript Library for Barcode Reader | ||
@@ -521,11 +521,2 @@ * More info on DBR JS: https://www.dynamsoft.com/Products/barcode-recognition-javascript.aspx | ||
/** | ||
* The method is only supported in the full feature edition. | ||
* Returns intermediate results containing the original image, the colour clustered image, the binarized Image, contours, Lines, TextBlocks, etc. | ||
* ```js | ||
* let imResults = await reader.getIntermediateResults(); | ||
* ``` | ||
* @ignore | ||
*/ | ||
getIntermediateResults(): Promise<any>; | ||
/** | ||
* Sets the optional argument for a specified mode in Modes parameters. | ||
@@ -552,6 +543,15 @@ * ```js | ||
/** | ||
* The method is only supported in the full feature edition. | ||
* Returns intermediate results containing the original image, the colour clustered image, the binarized Image, contours, Lines, TextBlocks, etc. | ||
* ```js | ||
* let imResults = await reader.getIntermediateResults(); | ||
* ``` | ||
* @ignore | ||
*/ | ||
getIntermediateCanvas(): Promise<HTMLCanvasElement | null>; | ||
getIntermediateResults(): Promise<any>; | ||
/** | ||
* @ignore | ||
*/ | ||
getIntermediateCanvas(): Promise<HTMLCanvasElement[]>; | ||
/** | ||
* Destructor the `BarcodeReader` object. | ||
@@ -558,0 +558,0 @@ * Equivalent to the previous method `deleteInstance()`. |
{ | ||
"name": "dynamsoft-javascript-barcode", | ||
"version": "7.3.0-v0", | ||
"version": "7.3.0-v1", | ||
"description": "Dynamsoft Barcode Reader JS is a recognition SDK which enables you to embed barcode reading functionality in your web, desktop, and mobile applications. With a few lines of JavaScript code, you can develop a robust application to scan a linear barcode, QR Code, DaraMatrix, PDF417, and Aztec Code.", | ||
@@ -5,0 +5,0 @@ "files": [ |
@@ -70,2 +70,3 @@ # Dynamsoft JavaScript Barcode SDK for Web | ||
- [Changelog](#changelog) | ||
- [How to Upgrade](#how-to-upgrade) | ||
- [API Documentation](#api-documentation) | ||
@@ -96,2 +97,12 @@ - [License Activation](#license-activation) | ||
* Unlike normal server-based applications, this library requires some advanced features which fortunately are supported by all mainstream modern browsers. These advanced features are listed below: | ||
* [MediaDevices/getUserMedia](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) | ||
* Required only for in-browser video streaming. If a browser doesn't have this API the [Single Frame Mode](https://www.dynamsoft.com/help/Barcode-Reader-wasm/classes/barcodescanner.html#singleframemode) is used automatically. If the API exists but doesn't work correctly, [Single Frame Mode](https://www.dynamsoft.com/help/Barcode-Reader-wasm/classes/barcodescanner.html#singleframemode) can be used as an alternative. | ||
* [WebAssembly](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_objects/WebAssembly), [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob), [URL/createObjectURL](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL), [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) | ||
* These four features are required for the library to work. | ||
* Combining the requirements above results in the following table of supported browsers. | ||
> **NOTE**: Apart from the browsers, the operating systems running on the target devices may also impose some limitations of their own that could restrict the use of the library. Therefore, the following table serves as a rough estimation instead of an accurate guideline. Browser compatibility ultimately depends on whether the browser on that particular operating system supports the features listed above. | ||
| Browser Name | Version | | ||
@@ -110,2 +121,4 @@ |:-:|:-:| | ||
> | ||
* Compact and Full Editions | ||
@@ -120,3 +133,5 @@ | ||
| QR | √ | √ | | ||
| Mirco QR | **X** | √ | | ||
| PDF417 | √ | √ | | ||
| Mirco PDF417 | **X** | √ | | ||
| DataMatrix | √ | √ | | ||
@@ -128,2 +143,3 @@ | Aztec | **X** | √ | | ||
| GS1 DataBar | **X** | √ | | ||
| Postal Code | **X** | √ | | ||
| DPM | **X** | √ | | ||
@@ -273,5 +289,8 @@ | getRuntimeSettings | √ | √ | | ||
```javascript | ||
Dynamsoft.BarcodeReader.loadWasm() | ||
.then(()=>{ /* success */ }, ex=>{console.error(ex.message||ex);}) | ||
```js | ||
try{ | ||
await Dynamsoft.BarcodeReader.loadWasm(); | ||
}catch(ex){ | ||
console.error(ex); | ||
} | ||
``` | ||
@@ -281,5 +300,11 @@ | ||
```javascript | ||
Dynamsoft.BarcodeReader.createInstance() | ||
.then(reader=>{ /* success */ }, ex=>{console.error(ex.message||ex);}) | ||
```js | ||
let reader = null; | ||
let scanner = null; | ||
try{ | ||
reader = await Dynamsoft.BarcodeReader.createInstance(); | ||
scanner = await Dynamsoft.BarcodeScanner.createInstance(); | ||
}catch(ex){ | ||
console.error(ex); | ||
} | ||
``` | ||
@@ -551,3 +576,3 @@ | ||
```javascript | ||
let settings = await barcodeScanner.getRuntimeSettings(); | ||
let settings = await scanner.getRuntimeSettings(); | ||
/* | ||
@@ -574,3 +599,3 @@ * 1 means true | ||
Create a directory called `dist` on your server and put the following files in there. | ||
On your server put the following files in the same directory. | ||
@@ -580,8 +605,10 @@ > [Download zip](https://www.dynamsoft.com/Downloads/Dynamic-Barcode-Reader-Download.aspx?edition=js) to get these files. | ||
``` | ||
dbr-<version>.js | ||
dbr-<version>.worker.js | ||
dbr-<version>.wasm.js | ||
dbr-<version>.wasm | ||
dbr-<version>.full.wasm.js | ||
dbr-<version>.full.wasm | ||
dbr.js // For <script> | ||
dbr.browser.mjs // For <script type="module"> | ||
dbr.scanner.html // Scanner default UI | ||
dbr-<version>.worker.js // A worker thread for decoding | ||
dbr-<version>.wasm.js // Compact Editions | ||
dbr-<version>.wasm // Compact Editions | ||
dbr-<version>.full.wasm.js // Full Editions | ||
dbr-<version>.full.wasm // Full Editions | ||
``` | ||
@@ -602,3 +629,8 @@ | ||
* **Step three**: Configure the engineResourcePath | ||
The `engineResourcePath` need to be set before `loadWasm`. | ||
```js | ||
Dynamsoft.BarcodeReader.engineResourcePath = "url/to/the/dir/"; | ||
``` | ||
@@ -609,2 +641,20 @@ ## Changelog | ||
## How to Upgrade | ||
#### From version `7.2.2-v2` to `7.3.0-v0` | ||
* If you are using a CDN, just make sure to change the version number in the URL like this | ||
```javascript | ||
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-javascript-barcode@7.3.0-v0/dist/dbr.js" data-productKeys="PRODUCT-KEYS"></script> | ||
``` | ||
* If you have deployed the library files on your own server, you'll need to replace the old files with the ones from the new version. Download the latest version [here](https://www.dynamsoft.com/Downloads/Dynamic-Barcode-Reader-Download.aspx). | ||
#### From versions prior to`7.2.2-v2` to `7.3.0-v0` | ||
Dynamsoft made quite some changes in the version `7.2.2-v2`, therefore it may take a bit more effort to upgrade the library from an older version to the version `7.2.2-v2` or a later version including the latest `7.3.0-v0` (as of January, 2020). Apart from changing the code to include the correct version of the library, you'll also need to make changes to your code related to the APIs of the library. Check out [this post](https://blog.dynamsoft.com/insights/dynamsoft-barcode-reader-sdk-for-javascript-upgrade-from-v7-1-3-to-v7-2-2/) for more information. If you need more help with the upgrade, please feel free to contact [Dynamsoft Support](#contact-us). | ||
## API Documentation | ||
@@ -611,0 +661,0 @@ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Native code
Supply chain riskContains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.
Found 3 instances in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Minified code
QualityThis package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Native code
Supply chain riskContains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.
Found 3 instances in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Minified code
QualityThis package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.
Found 1 instance in 1 package
12226645
16735
702