Documentation Issue: Missing docs for MRZScannerView, MRZResultView classes and initialize() method
Category: Completeness
Severity: Warning
Found by: docs-updater review mode (2026-02-25)
SDK: MRZ Scanner JavaScript Edition
Finding IDs: C3, C4, C11
Problem
Three exported APIs lack documentation:
-
MRZScannerView class — Exported with public methods: initialize(), openCamera(), closeCamera(), pauseCamera(), stopCapturing(), handleMRZResult(), launch(). The API index references it but provides no link.
-
MRZResultView class — Exported with public methods: launch(), initialize(), hideView(), dispose(). The API index references it but provides no link.
-
MRZScanner.initialize() method — Returns Promise<{resources: SharedResources, components: {scannerView?, resultView?}}>. Allows advanced users to access underlying resources and view components for custom workflows. Currently only launch() and dispose() are documented.
Location
- API index:
api/index.md — lists MRZScannerView and MRZResultView without links
- Source:
dist/mrz-scanner.d.ts
Recommended Fix
- Create documentation sections (or pages) for
MRZScannerView and MRZResultView with their public methods.
- Add
initialize() to the MRZScanner Methods section in api/mrz-scanner.md.
- Update
api/index.md to link to the new sections.
Documentation Issue: Missing docs for MRZScannerView, MRZResultView classes and initialize() method
Category: Completeness
Severity: Warning
Found by: docs-updater review mode (2026-02-25)
SDK: MRZ Scanner JavaScript Edition
Finding IDs: C3, C4, C11
Problem
Three exported APIs lack documentation:
MRZScannerViewclass — Exported with public methods:initialize(),openCamera(),closeCamera(),pauseCamera(),stopCapturing(),handleMRZResult(),launch(). The API index references it but provides no link.MRZResultViewclass — Exported with public methods:launch(),initialize(),hideView(),dispose(). The API index references it but provides no link.MRZScanner.initialize()method — ReturnsPromise<{resources: SharedResources, components: {scannerView?, resultView?}}>. Allows advanced users to access underlying resources and view components for custom workflows. Currently onlylaunch()anddispose()are documented.Location
api/index.md— lists MRZScannerView and MRZResultView without linksdist/mrz-scanner.d.tsRecommended Fix
MRZScannerViewandMRZResultViewwith their public methods.initialize()to the MRZScanner Methods section inapi/mrz-scanner.md.api/index.mdto link to the new sections.