Class MrzScannerResult

constructor

• new MrzScannerResult(source?): MrzScannerResult

• Parameters

  • Optional source: DeepPartial<MrzScannerResult>

  Returns MrzScannerResult

Readonly document

Readonly rawMRZ

Readonly success

encodeImages

• encodeImages(): Promise<void>

• Returns Promise<void>

release

• release(): void

• Returns void

serialize

• serialize(config?): Promise<{
      document?: null | {
          children?: (undefined | ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: {} | undefined; } | undefined; ... 9 more ...; encodeImages?: {} | undefined; }))[];
          confidence?: number;
          confidenceWeight?: number;
          crop?: null | {
              buffer: undefined | string;
              uniqueId?: string;
              clear?: any;
              clone?: any;
              encodeImage?: any;
              encodeInPlace?: any;
              hibernate?: any;
              info?: any;
              isRetained?: any;
              release?: any;
              retain?: any;
              saveImage?: any;
              serialize?: any;
          };
          fields?: (undefined | {
              confidenceWeight?: number;
              image?: null | {
                  buffer: (...) | (...);
                  uniqueId?: (...) | (...);
                  clear?: any;
                  clone?: any;
                  encodeImage?: any;
                  encodeInPlace?: any;
                  hibernate?: any;
                  info?: any;
                  isRetained?: any;
                  release?: any;
                  retain?: any;
                  saveImage?: any;
                  serialize?: any;
              };
              parsedData?: ((...) | (...))[];
              polygonInRoot?: ((...) | (...))[];
              type?: {
                  commonType?: (...) | (...) | (...);
                  fullName?: (...) | (...);
                  listIndex?: (...) | (...) | (...);
                  name?: (...) | (...);
                  normalizedName?: (...) | (...);
                  serialize?: any;
              };
              validationStatus?: FieldValidationStatus;
              value?: null | {
                  confidence?: (...) | (...);
                  text?: (...) | (...);
                  serialize?: any;
              };
              encodeImages?: any;
              release?: any;
              serialize?: any;
          })[];
          quad?: (undefined | {
              x?: number;
              y?: number;
          })[];
          quadInRoot?: (undefined | {
              x?: number;
              y?: number;
          })[];
          type?: {
              fullName?: string;
              listIndex?: null | number;
              name?: string;
              normalizedName?: string;
              serialize?: any;
          };
          encodeImages?: any;
          release?: any;
          serialize?: any;
      };
      rawMRZ?: string;
      success?: boolean;
      encodeImages?: any;
      release?: any;
      serialize?: any;
  }>

• Parameters

  • Optional config: ToJsonConfiguration

  Returns Promise<{
      document?: null | {
          children?: (undefined | ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: {} | undefined; } | undefined; ... 9 more ...; encodeImages?: {} | undefined; }))[];
          confidence?: number;
          confidenceWeight?: number;
          crop?: null | {
              buffer: undefined | string;
              uniqueId?: string;
              clear?: any;
              clone?: any;
              encodeImage?: any;
              encodeInPlace?: any;
              hibernate?: any;
              info?: any;
              isRetained?: any;
              release?: any;
              retain?: any;
              saveImage?: any;
              serialize?: any;
          };
          fields?: (undefined | {
              confidenceWeight?: number;
              image?: null | {
                  buffer: (...) | (...);
                  uniqueId?: (...) | (...);
                  clear?: any;
                  clone?: any;
                  encodeImage?: any;
                  encodeInPlace?: any;
                  hibernate?: any;
                  info?: any;
                  isRetained?: any;
                  release?: any;
                  retain?: any;
                  saveImage?: any;
                  serialize?: any;
              };
              parsedData?: ((...) | (...))[];
              polygonInRoot?: ((...) | (...))[];
              type?: {
                  commonType?: (...) | (...) | (...);
                  fullName?: (...) | (...);
                  listIndex?: (...) | (...) | (...);
                  name?: (...) | (...);
                  normalizedName?: (...) | (...);
                  serialize?: any;
              };
              validationStatus?: FieldValidationStatus;
              value?: null | {
                  confidence?: (...) | (...);
                  text?: (...) | (...);
                  serialize?: any;
              };
              encodeImages?: any;
              release?: any;
              serialize?: any;
          })[];
          quad?: (undefined | {
              x?: number;
              y?: number;
          })[];
          quadInRoot?: (undefined | {
              x?: number;
              y?: number;
          })[];
          type?: {
              fullName?: string;
              listIndex?: null | number;
              name?: string;
              normalizedName?: string;
              serialize?: any;
          };
          encodeImages?: any;
          release?: any;
          serialize?: any;
      };
      rawMRZ?: string;
      success?: boolean;
      encodeImages?: any;
      release?: any;
      serialize?: any;
  }>