Skip to content

Commit 725aa86

Browse files
Merge pull request #485 from dynamsoft-docs/preview
Preview
2 parents 9e3208c + ce95603 commit 725aa86

6 files changed

Lines changed: 72 additions & 7 deletions

File tree

_includes/sidelist-programming/programming-javascript.html

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1425,8 +1425,10 @@
14251425
</li>
14261426

14271427
<li>
1428-
<a href="{{ site.js }}faq/" class="otherLinkColour">FAQ</a>
1429-
<ul>
1428+
<a target="_blank"
1429+
href="https://www.dynamsoft.com/faq/barcode-reader/web/index.html"
1430+
class="otherLinkColour">FAQ</a>
1431+
<!-- <ul>
14301432
<li>
14311433
<a href="{{ site.js }}faq/ways-to-copy-dbr-js-deployable-files.html"
14321434
>How to get a copy of Dbr JS deployable files ?</a
@@ -1646,7 +1648,7 @@
16461648
<a href="{{ site.js }}faq/adaptive-wasm-loading.html"
16471649
>What Is Adaptive WebAssembly (Wasm) Loading and How Does It Work?</a>
16481650
</li>
1649-
</ul>
1651+
</ul> -->
16501652
</li>
16511653
<li lang="javascript"><a href="{{ site.license_activation }}index.html" class="otherLinkColour">License Initialization</a></li>
16521654
<!-- <li class="category">OTHERS</li>

_includes/sidelist-programming/sidelist-parameters.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<li lang="javascript"><a href="{{ site.dcvb_parameters }}index.html" class="otherLinkColour">Parameters</a>
1+
<li lang="javascript"><a href="{{ site.dcvb_parameter_file }}index.html" class="otherLinkColour">Parameters</a>
22
<ul>
33
<li><a href="{{ site.dcvb_parameter_file }}capture-vision-template.html" class="otherLinkColour">CaptureVisionTemplate Object</a>
44
<ul>

programming/javascript/api-reference/barcode-scanner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ interface BarcodeScannerConfig {
146146
| `license` | `string` | `N/A` | The license key to activate the barcode scanner. |
147147
| `scanMode`(optional) | [`EnumScanMode`](#enumscanmode) | `SM_SINGLE` | Defines the scan mode of the BarcodeScanner|
148148
| `templateFilePath`(optional) | `string` | `N/A` | Path to a CaptureVisionTemplate file used for barcode reading. |
149-
| `utilizedTemplateNames`(optional) | `UtilizedTemplateNames` | `{"single": "ReadSingleBarcode", "multi_unique": "ReadBarcodes_SpeedFirst", "image": "ReadBarcodes_ReadRateFirst"}` | Defines template names mapped to scanning modes. |
149+
| `utilizedTemplateNames`(optional) | `UtilizedTemplateNames` | `{"single": "ReadBarcodes_SpeedFirst", "multi_unique": "ReadBarcodes_SpeedFirst", "image": "ReadBarcodes_ReadRateFirst"}` | Defines template names mapped to scanning modes. |
150150
| `engineResourcePaths`(optional) | `EngineResourcePaths` | `N/A` | Paths to engine resources like WASM or workers. See [EngineResourcePaths](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/core-module-class.html?product=dbr&lang=javascript#engineresourcepaths) for details. |
151151
| `uiPath` (optional) | `string` | `N/A` | Path to the custom UI (`.xml` template file) for the ScannerView.|
152152
| `barcodeFormats`(optional) | `EnumBarcodeFormat` \| `Array<EnumBarcodeFormat>` | `N/A` | [EnumBarcodeFormat](https://www.dynamsoft.com/capture-vision/docs/core/enums/barcode-reader/barcode-format.html?lang=js&product=dbr) or an array of `EnumBarcodeFormat` specifying the formats to recognize. |
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
layout: default-layout
3+
title: What's in the dist Folder of dynamsoft-barcode-reader-bundle?
4+
keywords: Dynamsoft Barcode Reader, FAQ, JavaScript, tech basic, wasm, dist, files
5+
description: How to enable -SIMD-Pthread Wasm for accelerated deep learning computation?
6+
needAutoGenerateSidebar: false
7+
---
8+
9+
# What's in the dist Folder of dynamsoft-barcode-reader-bundle?
10+
11+
When you install or extract the `dynamsoft-barcode-reader-bundle` package (from npm, CDN or zip installer), the `dist/` directory contains all the compiled, ready-to-use JavaScript/WebAssembly assets necessary to run the barcode reader in a browser or web app.
12+
13+
Below are the common files you'll find and their purposes.
14+
15+
16+
## 1. dbr.bundle.js
17+
18+
- The main bundled JavaScript file for the barcode reader SDK
19+
- Include this in your web page to use the SDK without separate imports
20+
21+
22+
## 2. dbr.bundle.mjs (ES Module)
23+
24+
- An ES Module version of the bundled SDK
25+
- Useful when using modern build tools like Webpack, Vite, or Rollup
26+
27+
## 3. dbr.bundle.d.ts
28+
29+
- Type definitions for TypeScript support
30+
- Provides autocompletion and improves developer experience in TypeScript projects
31+
32+
33+
## 4. dbr.bundle.worker.js
34+
35+
- Used for handling CPU-intensive barcode scanning and recognition tasks. Runs in a background thread without blocking the main thread UI
36+
37+
- Communicates with the main thread through message passing
38+
39+
## 5. WebAssembly Engine Files
40+
41+
`dynamsoft-barcode-reader-bundle` requires WASM and Worker scripts to work together in order to achieve highly efficient decoding capabilities.
42+
43+
| File | Purpose |
44+
|------|---------|
45+
| `*.wasm` | Core barcode reading logic compiled to WebAssembly |
46+
| `*.wasm.js` | JavaScript loader/bootstrap for the `.wasm` file |
47+
| `*.worker.js` | Offloads processing to a background thread |
48+
49+
> [!IMPORTANT]
50+
> The dbr-bundle dynamically selects the most suitable WebAssembly variant based on the current browser environment, in order to maximize browser performance as much as possible. This means that in most cases, only one set of `*.wasm` + `*.wasm.js` files will actually be used at runtime.
51+
> For details about the different WASM variants, please refer to [What Is Adaptive WebAssembly (Wasm) Loading and How Does It Work?](adaptive-wasm-loading.md).
52+
53+
54+
## 6. Other Auxiliary Resources
55+
56+
These folders collectively compose the runtime environment for a JavaScript-based barcode scanner application, providing all necessary assets for ML-based scanning, data parsing, result rendering, and user interaction.
57+
58+
| Folder | Purpose |
59+
|------|---------|
60+
| `models/` | Contains pre-trained machine learning models used for barcode detection and recognition. These models enable the scanner to identify and decode various barcode formats from images and video streams in real-time. |
61+
| `parser-resources/` | Stores resources required for data parsing and interpretation. |
62+
| `templates/` | Contains preset CaptureVisionTemplates used for different barcode scanning scenarios. |
63+
| `ui/` | Preset ui in `.html` files. |

programming/javascript/user-guide/barcode-scanner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ new Dynamsoft.BarcodeScanner().launch().then(result=>alert(result.barcodeResults
5252
- Camera access
5353

5454
> [!TIP]
55-
> Please refer to [system requirements](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/faq/system-requirement.html) for more details.
55+
> Please refer to [system requirements](https://www.dynamsoft.com/faq/barcode-reader/web/capabilities/system-requirement.html) for more details.
5656
5757
## License
5858

programming/javascript/user-guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Let's start with the "Hello World" example of the DBR-JS SDK which demonstrates
9090
- A supported browser
9191
- Camera access
9292

93-
> Please refer to [system requirements](https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/faq/system-requirement.html) for more details.
93+
> Please refer to [system requirements](https://www.dynamsoft.com/faq/barcode-reader/web/capabilities/system-requirement.html) for more details.
9494
9595
### Understand the code
9696

0 commit comments

Comments
 (0)