scanbotsdk
    Preparing search index...

    Class MrzScannerResult

    Container for result of MRZ scanning attempt.

    Since the instance of the class contains objects backed by native resources (e.g. images) and implements AsyncDisposable it's highly recommended to use the await using syntax when an instance is created or is received from an API:

    await using instance = await getMrzScannerResultFromAnApi();
    

    Alternatively, one can explicitly call release method to release the native resources or use autorelease convenience function. If neither is used, the resource will be released when the instance is garbage collected which is not recommended.

    Implements

    • AsyncDisposable
    Index

    Constructors

    Properties

    document: GenericDocument | null

    Generic document containing MRZ data.

    rawMRZ: string

    Raw string value of MRZ.

    success: boolean = false

    Scanning successful.

    Default is false.

    Methods

    • Returns Promise<void>

    • Returns Promise<void>