Class BarcodeScannerResult

constructor

• new BarcodeScannerResult(source?): BarcodeScannerResult

• Parameters

  • Optional source: DeepPartial<BarcodeScannerResult>

  Returns BarcodeScannerResult

Readonly barcodes

Readonly success

encodeImages

• encodeImages(): Promise<void>

• Returns Promise<void>

release

• release(): void

• Returns void

serialize

• serialize(config?): Promise<{
      barcodes?: {
          dataBarStackSize?: number;
          extendedQuad?: Point[];
          extendedQuadNormalized?: Point[];
          extractedDocument?: null | {
              children?: {
                  children?: ...;
                  confidence?: ...;
                  confidenceWeight?: ...;
                  crop?: ...;
                  fields?: ...;
                  quad?: ...;
                  quadInRoot?: ...;
                  type?: ...;
                  encodeImages?(): ...;
                  release?(): ...;
                  serialize?(config?): ...;
              }[];
              confidence?: number;
              confidenceWeight?: number;
              crop?: null | {
                  buffer: ...;
                  uniqueId?: ...;
                  clear?(): ...;
                  encodeImage?(options?): ...;
                  encodeInPlace?(): ...;
                  hibernate?(): ...;
                  info?(): ...;
                  isRetained?(): ...;
                  release?(): ...;
                  retain?(): ...;
                  saveImage?(path, options?): ...;
                  serialize?(imageSerializationMode): ...;
              } & {};
              fields?: {
                  confidenceWeight?: ...;
                  image?: ...;
                  parsedData?: ...;
                  polygonInRoot?: ...;
                  type?: ...;
                  validationStatus?: ...;
                  value?: ...;
                  encodeImages?(): ...;
                  release?(): ...;
                  serialize?(config?): ...;
              }[];
              quad?: Point[];
              quadInRoot?: Point[];
              type?: {
                  fullName?: (...) | (...);
                  listIndex?: (...) | (...) | (...);
                  name?: (...) | (...);
                  normalizedName?: (...) | (...);
                  serialize?(config?): { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              };
              encodeImages?(): Promise<void>;
              release?(): void;
              serialize?(config?): Promise<{
                  children?: (...) | (...);
                  confidence?: (...) | (...);
                  confidenceWeight?: (...) | (...);
                  crop?: (...) | (...) | (...);
                  fields?: (...) | (...);
                  quad?: (...) | (...);
                  quadInRoot?: (...) | (...);
                  type?: (...) | (...);
                  encodeImages?(): Promise<(...)>;
                  release?(): void;
                  serialize?(config?): Promise<{ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 9 more ...; encodeImage...;
              }>;
          } & {};
          format?: BarcodeFormat;
          globalIndex?: number;
          isGS1CompositePart?: boolean;
          isGS1Message?: boolean;
          isUpsideDown?: boolean;
          quad?: Point[];
          quadNormalized?: Point[];
          rawBytes?: string;
          rawBytesEncodings?: {
              encoding?: CharacterEncoding;
              end?: number;
              start?: number;
              serialize?(config?): { readonly start?: number | undefined; readonly end?: number | undefined; readonly encoding?: CharacterEncoding | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          }[];
          sizeScore?: number;
          sourceImage?: null | {
              buffer: undefined | string;
              uniqueId?: string;
              clear?(): Promise<void>;
              encodeImage?(options?): Promise<null | string>;
              encodeInPlace?(): Promise<void>;
              hibernate?(): Promise<void>;
              info?(): Promise<null | ImageInfo>;
              isRetained?(): boolean;
              release?(): void;
              retain?(): void;
              saveImage?(path, options?): Promise<boolean>;
              serialize?(imageSerializationMode): Promise<null | ({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<(... & {}) | null>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {})>;
          } & {};
          structuredAppendInfo?: null | {
              count?: number;
              id?: string;
              index?: number;
              serialize?(config?): {
                  count?: number;
                  id?: string;
                  index?: number;
                  serialize?(config?): { readonly count?: number | undefined; readonly index?: number | undefined; readonly id?: string | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              };
          } & {};
          text?: string;
          upcEanExtension?: string;
          encodeImages?(): Promise<void>;
          release?(): void;
          serialize?(config?): Promise<({ readonly format?: BarcodeFormat | undefined; readonly text?: string | undefined; readonly rawBytes?: string | undefined; readonly rawBytesEncodings?: { readonly start?: number | undefined; readonly end?: number | undefined; readonly encoding?: CharacterEncoding | undefined; serialize?: ((config?: ToJsonConfigurati...)>;
      }[];
      success?: boolean;
      encodeImages?(): Promise<void>;
      release?(): void;
      serialize?(config?): Promise<{ readonly barcodes?: { readonly format?: BarcodeFormat | undefined; readonly text?: string | undefined; readonly rawBytes?: string | undefined; readonly rawBytesEncodings?: { readonly start?: number | undefined; readonly end?: number | undefined; readonly encoding?: CharacterEncoding | undefined; serialize?...;
  }>

• Parameters

  • Optional config: ToJsonConfiguration

  Returns Promise<{
      barcodes?: {
          dataBarStackSize?: number;
          extendedQuad?: Point[];
          extendedQuadNormalized?: Point[];
          extractedDocument?: null | {
              children?: {
                  children?: ...;
                  confidence?: ...;
                  confidenceWeight?: ...;
                  crop?: ...;
                  fields?: ...;
                  quad?: ...;
                  quadInRoot?: ...;
                  type?: ...;
                  encodeImages?(): ...;
                  release?(): ...;
                  serialize?(config?): ...;
              }[];
              confidence?: number;
              confidenceWeight?: number;
              crop?: null | {
                  buffer: ...;
                  uniqueId?: ...;
                  clear?(): ...;
                  encodeImage?(options?): ...;
                  encodeInPlace?(): ...;
                  hibernate?(): ...;
                  info?(): ...;
                  isRetained?(): ...;
                  release?(): ...;
                  retain?(): ...;
                  saveImage?(path, options?): ...;
                  serialize?(imageSerializationMode): ...;
              } & {};
              fields?: {
                  confidenceWeight?: ...;
                  image?: ...;
                  parsedData?: ...;
                  polygonInRoot?: ...;
                  type?: ...;
                  validationStatus?: ...;
                  value?: ...;
                  encodeImages?(): ...;
                  release?(): ...;
                  serialize?(config?): ...;
              }[];
              quad?: Point[];
              quadInRoot?: Point[];
              type?: {
                  fullName?: (...) | (...);
                  listIndex?: (...) | (...) | (...);
                  name?: (...) | (...);
                  normalizedName?: (...) | (...);
                  serialize?(config?): { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              };
              encodeImages?(): Promise<void>;
              release?(): void;
              serialize?(config?): Promise<{
                  children?: (...) | (...);
                  confidence?: (...) | (...);
                  confidenceWeight?: (...) | (...);
                  crop?: (...) | (...) | (...);
                  fields?: (...) | (...);
                  quad?: (...) | (...);
                  quadInRoot?: (...) | (...);
                  type?: (...) | (...);
                  encodeImages?(): Promise<(...)>;
                  release?(): void;
                  serialize?(config?): Promise<{ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 9 more ...; encodeImage...;
              }>;
          } & {};
          format?: BarcodeFormat;
          globalIndex?: number;
          isGS1CompositePart?: boolean;
          isGS1Message?: boolean;
          isUpsideDown?: boolean;
          quad?: Point[];
          quadNormalized?: Point[];
          rawBytes?: string;
          rawBytesEncodings?: {
              encoding?: CharacterEncoding;
              end?: number;
              start?: number;
              serialize?(config?): { readonly start?: number | undefined; readonly end?: number | undefined; readonly encoding?: CharacterEncoding | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          }[];
          sizeScore?: number;
          sourceImage?: null | {
              buffer: undefined | string;
              uniqueId?: string;
              clear?(): Promise<void>;
              encodeImage?(options?): Promise<null | string>;
              encodeInPlace?(): Promise<void>;
              hibernate?(): Promise<void>;
              info?(): Promise<null | ImageInfo>;
              isRetained?(): boolean;
              release?(): void;
              retain?(): void;
              saveImage?(path, options?): Promise<boolean>;
              serialize?(imageSerializationMode): Promise<null | ({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<(... & {}) | null>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {})>;
          } & {};
          structuredAppendInfo?: null | {
              count?: number;
              id?: string;
              index?: number;
              serialize?(config?): {
                  count?: number;
                  id?: string;
                  index?: number;
                  serialize?(config?): { readonly count?: number | undefined; readonly index?: number | undefined; readonly id?: string | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              };
          } & {};
          text?: string;
          upcEanExtension?: string;
          encodeImages?(): Promise<void>;
          release?(): void;
          serialize?(config?): Promise<({ readonly format?: BarcodeFormat | undefined; readonly text?: string | undefined; readonly rawBytes?: string | undefined; readonly rawBytesEncodings?: { readonly start?: number | undefined; readonly end?: number | undefined; readonly encoding?: CharacterEncoding | undefined; serialize?: ((config?: ToJsonConfigurati...)>;
      }[];
      success?: boolean;
      encodeImages?(): Promise<void>;
      release?(): void;
      serialize?(config?): Promise<{ readonly barcodes?: { readonly format?: BarcodeFormat | undefined; readonly text?: string | undefined; readonly rawBytes?: string | undefined; readonly rawBytesEncodings?: { readonly start?: number | undefined; readonly end?: number | undefined; readonly encoding?: CharacterEncoding | undefined; serialize?...;
  }>