Class BarcodeScannerResult

constructor

• new BarcodeScannerResult(
      source?: DeepPartial<BarcodeScannerResult>,
  ): BarcodeScannerResult

  Parameters

  • Optionalsource: DeepPartial<BarcodeScannerResult>

  Returns BarcodeScannerResult

Readonlybarcodes

Readonlysuccess

encodeImages

• encodeImages(): Promise<void>

  Returns Promise<void>

release

• release(): void

  Returns void

serialize

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

  Parameters

  • Optionalconfig: ToJsonConfiguration

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