Skip to content

Commit e5dc3d7

Browse files
Refactor API documentation: update ECISegment references, change 'Formats' to 'format', remove ScaledUpBarcodeImageUnit, and enhance migration and release notes with additional guidance.
1 parent 763337a commit e5dc3d7

7 files changed

Lines changed: 51 additions & 37 deletions

File tree

programming/javascript/api-reference/barcode-reader-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This class defines common functionality in the `BarcodeReader` module. At presen
3434
* [DecodedBarcodesUnit](./interfaces/decoded-barcodes-unit.md)
3535
* [DeformationResistedBarcode](./interfaces/deformation-resisted-barcode.md)
3636
* [DeformationResistedBarcodeImageUnit](./interfaces/deformation-resisted-barcode-image-unit.md)
37-
* [ECI-segment](./interfaces/eci-segment.md)
37+
* [ECISegment](./interfaces/eci-segment.md)
3838
* [ExtendedBarcodeResult](./interfaces/extended-barcode-result.md)
3939
* [LocalizedBarcodeElement](./interfaces/localized-barcode-element.md)
4040
* [LocalizedBarcodesUnit](./interfaces/localized-barcodes-unit.md)

programming/javascript/api-reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ noTitleIndex: true
5252
* [DecodedBarcodesUnit](./interfaces/decoded-barcodes-unit.html)
5353
* [DeformationResistedBarcode](./interfaces/deformation-resisted-barcode.html)
5454
* [DeformationResistedBarcodeImageUnit](./interfaces/deformation-resisted-barcode-image-unit.html)
55+
* [ECISegment](./interfaces/eci-segment.html)
5556
* [ExtendedBarcodeResult](./interfaces/extended-barcode-result.html)
5657
* [LocalizedBarcodeElement](./interfaces/localized-barcode-element.html)
5758
* [LocalizedBarcodesUnit](./interfaces/localized-barcodes-unit.html)

programming/javascript/api-reference/interfaces/deformation-resisted-barcode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ interface DeformationResistedBarcode {
1919
}
2020
```
2121

22-
## Formats
22+
## format
2323

2424
Possible formats of the localized barcode.
2525

2626
```typescript
27-
Formats: EnumBarcodeFormat;
27+
format: EnumBarcodeFormat;
2828
```
2929

3030
**See also**

programming/javascript/api-reference/interfaces/scaled-up-barcode-image-unit.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

programming/javascript/migrate-from-v10/index.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ needAutoGenerateSidebar: true
88

99
# How to Upgrade DBR-JS from v10.x to v11.x
1010

11+
> For a full list of changes introduced in v11, see the [v11 Release Notes](../release-notes/js-11.html).
12+
1113
> [!IMPORTANT]
1214
> **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.
1315
@@ -69,6 +71,47 @@ Dynamsoft.Core.CoreModule.engineResourcePaths.rootDirectory = "https://cdn.jsdel
6971
>
7072
> Eliminate any redundant configuration of `engineResourcePaths`.
7173
74+
#### ImageIO / ImageProcessor / ImageDrawer Methods Are Now Static
75+
76+
All methods under the `ImageIO`, `ImageProcessor`, and `ImageDrawer` classes have been converted from instance methods to static methods. Update any instance-based calls accordingly:
77+
78+
```javascript
79+
// v10 - instance method
80+
const processor = new Dynamsoft.Utility.ImageProcessor();
81+
const result = await processor.convertToBinaryLocal(imageData);
82+
83+
// v11 - static method
84+
const result = await Dynamsoft.Utility.ImageProcessor.convertToBinaryLocal(imageData);
85+
```
86+
87+
#### CodeParserModule.loadSpec() Now Returns a Promise
88+
89+
`CodeParserModule.loadSpec()` previously returned `void`. In v11, it returns `Promise<ErrorInfo>`, allowing you to detect and handle spec loading failures:
90+
91+
```javascript
92+
// v10 - no return value
93+
CodeParserModule.loadSpec("AAMVA_DL_ID");
94+
95+
// v11 - handle errors
96+
const errorInfo = await CodeParserModule.loadSpec("AAMVA_DL_ID");
97+
if (errorInfo.errorCode !== 0) {
98+
console.error("Spec load failed:", errorInfo.errorMessage);
99+
}
100+
```
101+
102+
#### Parser Resource Files Changed to .data Format
103+
104+
Code parser specification files have been consolidated from `.json` into encrypted `.data` files for improved security and simplified distribution. If you self-host these resources, update your file references:
105+
106+
| Old File | New File |
107+
| --- | --- |
108+
| `AADHAAR.json` | `AADHAAR.data` |
109+
| `AAMVA_DL_ID.json` | `AAMVA_DL_ID.data` |
110+
| `GS1_AI.json` | `GS1_AI.data` |
111+
| `MRTD.json` | `MRTD.data` |
112+
| `SOUTH_AFRICA_DL.json` | `SOUTH_AFRICA_DL.data` |
113+
| `VIN.json` | `VIN.data` |
114+
72115
### Upgrade your template
73116

74117
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.

programming/javascript/release-notes/js-11.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,13 @@ keywords: release notes, javascript
66
needAutoGenerateSidebar: true
77
needGenerateH3Content: false
88
noTitleIndex: true
9+
permalink: /programming/javascript/release-notes/js-11.html
910
---
1011

1112
# Release Notes for Dynamsoft Barcode Reader JavaScript SDK
1213

14+
> Upgrading from v10? See the [v10 to v11 Migration Guide](../migrate-from-v10/index.html) for a step-by-step walkthrough of all breaking changes.
15+
1316
## 11.4.2001 (04/24/2026)
1417

1518
### Fixed

programming/javascript/user-guide/use-in-framework.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,7 @@ To complete the code, we'll include the [`CaptureVisionRouter`](https://www.dyna
316316
import "../dynamsoft.config";
317317
import { CameraEnhancer, CameraView } from "dynamsoft-camera-enhancer";
318318
import { CaptureVisionRouter } from "dynamsoft-capture-vision-router";
319+
import { MultiFrameResultCrossFilter } from "dynamsoft-utility";
319320
320321
let cameraEnhancer;
321322
let pCameraEnhancer; // promise of cameraEnhancer

0 commit comments

Comments
 (0)