Skip to content

index.md

Latest commit

 

History

History
135 lines (94 loc) · 6.22 KB

index.md

File metadata and controls

135 lines (94 loc) · 6.22 KB
layout default-layout
title Upgrade guide for version 11 - Dynamsoft Barcode Reader JavaScript Edition
description This page shows how to upgrade Dynamsoft Barcode Reader JavaScript SDK from v10 to v11.
keywords user guide, upgrade, javascript, js
needAutoGenerateSidebar true

How to Upgrade DBR-JS from v10.x to v11.x

For a full list of changes introduced in v11, see the v11 Release Notes.

Important

We strongly recommend upgrading to v11.x. All future algorithm improvements, performance optimizations, and new features will be developed exclusively for v11 and later versions. Version 10.x and earlier will only receive critical bug fixes and will not benefit from ongoing innovation.

Why Upgrade to v11?

  • Latest Barcode Recognition Algorithms: Access to cutting-edge decoding algorithms and accuracy improvements
  • Ongoing Performance Enhancements: Faster processing speeds and better resource optimization
  • New Features & Capabilities: Future functionality will only be available in v11+
  • Active Development: Version 11 is the actively maintained branch receiving continuous updates
  • Long-term Support: Ensure your application stays current with industry standards

⚠️ Version 10.x is in maintenance mode only - no new features or algorithm updates will be backported.

Reference the latest version of the dynamsoft-barcode-reader-bundle

To use version 11, include the following script in your HTML:

<script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.2001/dist/dbr.bundle.js"></script>

APIs changes introduced in v11

BarcodeScanner API Changes

Several properties have been renamed or had their default values changed. Please review the table below and update your implementation accordingly if you rely on the previous defaults.

Property Old Default New Default Notes
removePoweredByMessage (deprecated) false — Replaced by showPoweredByDynamsoft
showPoweredByDynamsoft false true Controls whether the "Powered by Dynamsoft" label is displayed
showCloseButton false true Controls whether the close button is shown in the scannerView
showResultView false true Controls whether the result view is shown

Note

If your project depends on the previous default behavior, you must explicitly set these properties to maintain compatibility.

Foundational API Changes

loadWasm() Simplified

The loadWasm() function no longer requires any parameters. Simply call loadWasm() without arguments.

Dynamsoft.Core.CoreModule.loadWasm();

engineResourcePaths Simplified

There is no longer a need to define engineResourcePaths for different modules. Resource management has been centralized and streamlined.

// To specify the path for rootDirectory
Dynamsoft.Core.CoreModule.engineResourcePaths.rootDirectory = "https://cdn.jsdelivr.net/npm/";

Note

Remove unnecessary parameters from loadWasm() calls.

Eliminate any redundant configuration of engineResourcePaths.

ImageIO / ImageProcessor / ImageDrawer Methods Are Now Static

All methods under the ImageIO, ImageProcessor, and ImageDrawer classes have been converted from instance methods to static methods. Update any instance-based calls accordingly:

// v10 - instance method
const processor = new Dynamsoft.Utility.ImageProcessor();
const result = await processor.convertToBinaryLocal(imageData);

// v11 - static method
const result = await Dynamsoft.Utility.ImageProcessor.convertToBinaryLocal(imageData);

CodeParserModule.loadSpec() Now Returns a Promise

CodeParserModule.loadSpec() previously returned void. In v11, it returns Promise<ErrorInfo>, allowing you to detect and handle spec loading failures:

// v10 - no return value
CodeParserModule.loadSpec("AAMVA_DL_ID");

// v11 - handle errors
const errorInfo = await CodeParserModule.loadSpec("AAMVA_DL_ID");
if (errorInfo.errorCode !== 0) {
  console.error("Spec load failed:", errorInfo.errorMessage);
}

Parser Resource Files Changed to .data Format

Starting from v11.4.2000, Code parser specification files have been consolidated into .data files, one per code type, for improved security and simplified distribution. This affects both the resource files themselves and the string passed to loadSpec().

loadSpec() argument update: Sub-type strings are now merged into their parent type name. Old strings remain supported via a JavaScript-layer mapping, but updating to the new names is recommended:

v10 loadSpec() call v11 loadSpec() call
loadSpec("MRTD_TD3_PASSPORT") loadSpec("MRTD")
loadSpec("MRTD_TD1_ID") loadSpec("MRTD")
loadSpec("MRTD_TD2_ID") loadSpec("MRTD")
loadSpec("AAMVA_DL_ID") loadSpec("AAMVA_DL_ID")
loadSpec("AAMVA_DL_ID_WITH_MAG_STRIPE") loadSpec("AAMVA_DL_ID") 
// before v11.4.2000
Dynamsoft.DCP.CodeParserModule.loadSpec("MRTD_TD3_PASSPORT");
Dynamsoft.DCP.CodeParserModule.loadSpec("MRTD_TD1_ID");
Dynamsoft.DCP.CodeParserModule.loadSpec("MRTD_TD2_ID");

// now (recommended)
Dynamsoft.DCP.CodeParserModule.loadSpec("MRTD");

Self-hosted resource files: If you host these files yourself, replace the old .data & _Map.text files with the new .data equivalents.

Upgrade your template

The template system has been enhanced in v11 to support more powerful customization options and better performance. Templates from v10.x are not directly compatible with v11.

Action Required: Use the template upgrade tool to automatically convert your v10.x templates to the v11 format.

Note

The upgraded template format provides better flexibility and will support future template enhancements that are exclusive to v11+.