Class MrzParser

API for machine readable zone parsing.

Required licence feature(s): MrzScanner.

Index

Methods

destroy parse create

Methods

destroy

destroy(): Promise<void>
Frees up any resources associated with this object. No other methods may be called on this object after destroy has been called.

Returns Promise<void>

parse

parse(text): Promise<MrzScannerResult>
Parse the MRZ string.
Parameters
- text: string
  The MRZ string to parse. Should be formatted with newlines.@returns The recognition result.
Returns Promise<MrzScannerResult>

`Static` create

create(workerBridge, configuration?): Promise<MrzParser>
Parameters
- workerBridge: WorkerBridge
- Optional configuration: {
  incompleteResultHandling?: MrzIncompleteResultHandling;
  }
  - Optional incompleteResultHandling?: MrzIncompleteResultHandling
    Defines how to handle incomplete MRZ results (e.g. caused by failed validation).
    Default Value
    "ACCEPT";
Returns Promise<MrzParser>

Generated using TypeDoc