Documentation Issue: launch() parameter types not documented
Category: Accuracy
Severity: Warning
Found by: docs-updater review mode (2026-02-25)
SDK: MRZ Scanner JavaScript Edition
Finding ID: A4
Problem
The launch() method syntax shows launch(fileToProcess) with no type annotation. The SDK source defines the parameter as imageOrFile with a union type.
Location
- Docs file:
api/mrz-scanner.md — launch() Syntax section
Expected (from source)
launch(imageOrFile?: Blob | string | DSImageData | HTMLImageElement | HTMLVideoElement | HTMLCanvasElement): Promise<MRZResult>
Actual (in docs)
launch(fileToProcess): Promise<MRZResult>
No types, different parameter name.
Recommended Fix
Add the full parameter type and rename fileToProcess to imageOrFile to match source. Add a parameter description table.
Documentation Issue: launch() parameter types not documented
Category: Accuracy
Severity: Warning
Found by: docs-updater review mode (2026-02-25)
SDK: MRZ Scanner JavaScript Edition
Finding ID: A4
Problem
The
launch()method syntax showslaunch(fileToProcess)with no type annotation. The SDK source defines the parameter asimageOrFilewith a union type.Location
api/mrz-scanner.md— launch() Syntax sectionExpected (from source)
Actual (in docs)
No types, different parameter name.
Recommended Fix
Add the full parameter type and rename
fileToProcesstoimageOrFileto match source. Add a parameter description table.