Class MrzScanner

API for machine readable zone scanning.

*

  • Required licence feature(s): MrzScanner.

Example

Since the class is backed by native resources and implements AsyncDisposable it's highly recommended to use the await using syntax when an instance is created to ensure the resource is disposed automatically:

await using instance = await MrzScanner.create(...);

Alternatively, one can explicitly call dispose method to release the native resource. If neither is used, the resource will be released when the instance is garbage collected which is not recommended.

Implements

  • AsyncDisposable

Methods

[asyncDispose] clearResult dispose run create

Methods

[asyncDispose]

  • [asyncDispose](): Promise<void>

  • Returns Promise<void>

clearResult

  • clearResult(): Promise<void>

  • Clears the accumulated results. Should be called after a document has been recognized to the customers

    • satisfaction to prevent a poisoned cache.

    Returns Promise<void>

dispose

  • dispose(): Promise<void>

  • As the instance is backed by a native resource, it should be disposed when it is no longer needed. This method will release the native resource. As a recommended alternative since the class implements AsyncDisposable one can use 'await using' syntax to ensure the resource is disposed of automatically. If neither is used, the resource will be released when the instance is garbage collected which is not recommended.

    Returns Promise<void>

    A promise that resolves when the instance is disposed.

run

Static create

  • create(configuration?): Promise<MrzScanner>

  • Initialize the MRZ scanner.

    Parameters

    Returns Promise<MrzScanner>

    Instance of MrzScanner.

Settings

Member Visibility

Theme

On This Page

[asyncDispose]clearResultdisposeruncreate