Class SDKWorkerBridge

Constructors

Properties

Methods

Constructors

Properties

copyArgs: {
    BarcodeDocumentParser: WorkerBarcodeDocumentParser;
    BarcodeScanner: WorkerBarcodeScanner;
    CheckScanner: WorkerCheckScanner;
    CreditCardScanner: WorkerCreditCardScanner;
    DocumentClassifier: WorkerDocumentClassifier;
    DocumentDataExtractor: WorkerDocumentDataExtractor;
    DocumentQualityAnalyzer: WorkerDocumentQualityAnalyzer;
    DocumentScanner: WorkerDocumentScanner;
    ImageManipulator: WorkerImageManipulator;
    ImageProcessor: WorkerImageProcessor;
    MrzParser: WorkerMrzParser;
    MrzScanner: WorkerMrzScanner;
    OcrEngine: WorkerOcrEngine;
    TextPatternScanner: WorkerTextPatternScanner;
    VinScanner: WorkerVinScanner;
    __callModuleFunction: ((functionName, args?) => Promise<any>);
    __hasModuleFunction: ((functionName) => Promise<any>);
    addPageToPdf: ((pdfOperation, image, binarization?) => Promise<void>);
    addPageToPdfWithOcr: ((pdfOperation, image, binarization?) => Promise<void>);
    addPageToTiff: ((tiffOperation, image, binarization) => Promise<void>);
    beginPdf: ((options) => Promise<ObjectId<"PdfGenerationContext">>);
    beginTiff: ((options) => Promise<ObjectId<"TiffGenerationContext">>);
    completePdf: ((pdfOperation) => Promise<Uint8Array>);
    completeTiff: ((tiffOperation) => Promise<Uint8Array>);
    encodeJpeg: ((image, quality?) => Promise<Uint8Array>);
    getLicenseInfo: (() => Promise<LicenseInfo>);
    initialize: ((licenseKey?, enginePath?, appId?, options?) => Promise<void>);
    releaseObject: (<T>(objectToken) => Promise<void>);
    version: (() => Promise<string>);
}

Type declaration

  • BarcodeDocumentParser: WorkerBarcodeDocumentParser
  • BarcodeScanner: WorkerBarcodeScanner
  • CheckScanner: WorkerCheckScanner
  • CreditCardScanner: WorkerCreditCardScanner
  • DocumentClassifier: WorkerDocumentClassifier
  • DocumentDataExtractor: WorkerDocumentDataExtractor
  • DocumentQualityAnalyzer: WorkerDocumentQualityAnalyzer
  • DocumentScanner: WorkerDocumentScanner
  • ImageManipulator: WorkerImageManipulator
  • ImageProcessor: WorkerImageProcessor
  • MrzParser: WorkerMrzParser
  • MrzScanner: WorkerMrzScanner
  • OcrEngine: WorkerOcrEngine
  • TextPatternScanner: WorkerTextPatternScanner
  • VinScanner: WorkerVinScanner
  • __callModuleFunction: ((functionName, args?) => Promise<any>)
      • (functionName, args?): Promise<any>
      • Parameters

        • functionName: string
        • Optional args: any[]

        Returns Promise<any>

  • __hasModuleFunction: ((functionName) => Promise<any>)
      • (functionName): Promise<any>
      • Parameters

        • functionName: string

        Returns Promise<any>

  • addPageToPdf: ((pdfOperation, image, binarization?) => Promise<void>)
      • (pdfOperation, image, binarization?): Promise<void>
      • Parameters

        Returns Promise<void>

  • addPageToPdfWithOcr: ((pdfOperation, image, binarization?) => Promise<void>)
      • (pdfOperation, image, binarization?): Promise<void>
      • Parameters

        Returns Promise<void>

  • addPageToTiff: ((tiffOperation, image, binarization) => Promise<void>)
      • (tiffOperation, image, binarization): Promise<void>
      • Parameters

        Returns Promise<void>

  • beginPdf: ((options) => Promise<ObjectId<"PdfGenerationContext">>)
      • (options): Promise<ObjectId<"PdfGenerationContext">>
      • Parameters

        • options: {
              attributes?: {
                  author?: string;
                  creator?: string;
                  keywords?: string;
                  subject?: string;
                  title?: string;
              };
              binarizationFilter?: {
                  filterType?: number;
              } & {
                  _type: "LegacyFilter";
              } | {
                  outputMode?: OutputMode;
              } & {
                  _type: "ScanbotBinarizationFilter";
              } | {
                  denoise?: number;
                  outputMode?: OutputMode;
                  preset?: BinarizationFilterPreset;
                  radius?: number;
              } & {
                  _type: "CustomBinarizationFilter";
              } | {
                  blackOutliersFraction?: number;
                  borderWidthFraction?: number;
                  colorEnhancement?: number;
                  contrastEnhancement?: number;
                  paperWhitening?: number;
                  paperWhiteningBias?: number;
                  radius?: number;
                  whiteOutliersFraction?: number;
              } & {
                  _type: "ColorDocumentFilter";
              } | {
                  brightness?: number;
              } & {
                  _type: "BrightnessFilter";
              } | {
                  contrast?: number;
              } & {
                  _type: "ContrastFilter";
              } | {
                  blackOutliersFraction?: number;
                  borderWidthFraction?: number;
                  whiteOutliersFraction?: number;
              } & {
                  _type: "GrayscaleFilter";
              } | {
                  blackPoint?: number;
                  whitePoint?: number;
              } & {
                  _type: "WhiteBlackPointFilter";
              };
              dpi?: number;
              jpegQuality?: number;
              pageDirection?: PageDirection;
              pageFit?: PageFit;
              pageSize?: PageSize;
              resamplingMethod?: ResamplingMethod;
          }
          • Optional attributes?: {
                author?: string;
                creator?: string;
                keywords?: string;
                subject?: string;
                title?: string;
            }
            • Optional author?: string
            • Optional creator?: string
            • Optional keywords?: string
            • Optional subject?: string
            • Optional title?: string
          • Optional binarizationFilter?: {
                filterType?: number;
            } & {
                _type: "LegacyFilter";
            } | {
                outputMode?: OutputMode;
            } & {
                _type: "ScanbotBinarizationFilter";
            } | {
                denoise?: number;
                outputMode?: OutputMode;
                preset?: BinarizationFilterPreset;
                radius?: number;
            } & {
                _type: "CustomBinarizationFilter";
            } | {
                blackOutliersFraction?: number;
                borderWidthFraction?: number;
                colorEnhancement?: number;
                contrastEnhancement?: number;
                paperWhitening?: number;
                paperWhiteningBias?: number;
                radius?: number;
                whiteOutliersFraction?: number;
            } & {
                _type: "ColorDocumentFilter";
            } | {
                brightness?: number;
            } & {
                _type: "BrightnessFilter";
            } | {
                contrast?: number;
            } & {
                _type: "ContrastFilter";
            } | {
                blackOutliersFraction?: number;
                borderWidthFraction?: number;
                whiteOutliersFraction?: number;
            } & {
                _type: "GrayscaleFilter";
            } | {
                blackPoint?: number;
                whitePoint?: number;
            } & {
                _type: "WhiteBlackPointFilter";
            }
          • Optional dpi?: number
          • Optional jpegQuality?: number
          • Optional pageDirection?: PageDirection
          • Optional pageFit?: PageFit
          • Optional pageSize?: PageSize
          • Optional resamplingMethod?: ResamplingMethod

        Returns Promise<ObjectId<"PdfGenerationContext">>

  • beginTiff: ((options) => Promise<ObjectId<"TiffGenerationContext">>)
      • (options): Promise<ObjectId<"TiffGenerationContext">>
      • Parameters

        • options: {
              binarizationFilter?: {
                  filterType?: number;
              } & {
                  _type: "LegacyFilter";
              } | {
                  outputMode?: OutputMode;
              } & {
                  _type: "ScanbotBinarizationFilter";
              } | {
                  denoise?: number;
                  outputMode?: OutputMode;
                  preset?: BinarizationFilterPreset;
                  radius?: number;
              } & {
                  _type: "CustomBinarizationFilter";
              } | {
                  blackOutliersFraction?: number;
                  borderWidthFraction?: number;
                  colorEnhancement?: number;
                  contrastEnhancement?: number;
                  paperWhitening?: number;
                  paperWhiteningBias?: number;
                  radius?: number;
                  whiteOutliersFraction?: number;
              } & {
                  _type: "ColorDocumentFilter";
              } | {
                  brightness?: number;
              } & {
                  _type: "BrightnessFilter";
              } | {
                  contrast?: number;
              } & {
                  _type: "ContrastFilter";
              } | {
                  blackOutliersFraction?: number;
                  borderWidthFraction?: number;
                  whiteOutliersFraction?: number;
              } & {
                  _type: "GrayscaleFilter";
              } | {
                  blackPoint?: number;
                  whitePoint?: number;
              } & {
                  _type: "WhiteBlackPointFilter";
              };
              compression?: CompressionMode;
              dpi?: number;
              jpegQuality?: number;
              userFields?: {
                  name?: string;
                  tag?: number;
                  value?: {
                      value?: number;
                  } & {
                      _type: "UserFieldDoubleValue";
                  } | {
                      value?: string;
                  } & {
                      _type: "UserFieldStringValue";
                  } | {
                      value?: number;
                  } & {
                      _type: "UserFieldIntValue";
                  };
              }[];
              zipCompressionLevel?: number;
          }
          • Optional binarizationFilter?: {
                filterType?: number;
            } & {
                _type: "LegacyFilter";
            } | {
                outputMode?: OutputMode;
            } & {
                _type: "ScanbotBinarizationFilter";
            } | {
                denoise?: number;
                outputMode?: OutputMode;
                preset?: BinarizationFilterPreset;
                radius?: number;
            } & {
                _type: "CustomBinarizationFilter";
            } | {
                blackOutliersFraction?: number;
                borderWidthFraction?: number;
                colorEnhancement?: number;
                contrastEnhancement?: number;
                paperWhitening?: number;
                paperWhiteningBias?: number;
                radius?: number;
                whiteOutliersFraction?: number;
            } & {
                _type: "ColorDocumentFilter";
            } | {
                brightness?: number;
            } & {
                _type: "BrightnessFilter";
            } | {
                contrast?: number;
            } & {
                _type: "ContrastFilter";
            } | {
                blackOutliersFraction?: number;
                borderWidthFraction?: number;
                whiteOutliersFraction?: number;
            } & {
                _type: "GrayscaleFilter";
            } | {
                blackPoint?: number;
                whitePoint?: number;
            } & {
                _type: "WhiteBlackPointFilter";
            }
          • Optional compression?: CompressionMode
          • Optional dpi?: number
          • Optional jpegQuality?: number
          • Optional userFields?: {
                name?: string;
                tag?: number;
                value?: {
                    value?: number;
                } & {
                    _type: "UserFieldDoubleValue";
                } | {
                    value?: string;
                } & {
                    _type: "UserFieldStringValue";
                } | {
                    value?: number;
                } & {
                    _type: "UserFieldIntValue";
                };
            }[]
          • Optional zipCompressionLevel?: number

        Returns Promise<ObjectId<"TiffGenerationContext">>

  • completePdf: ((pdfOperation) => Promise<Uint8Array>)
      • (pdfOperation): Promise<Uint8Array>
      • Parameters

        • pdfOperation: ObjectId<"PdfGenerationContext">

        Returns Promise<Uint8Array>

  • completeTiff: ((tiffOperation) => Promise<Uint8Array>)
      • (tiffOperation): Promise<Uint8Array>
      • Parameters

        • tiffOperation: ObjectId<"TiffGenerationContext">

        Returns Promise<Uint8Array>

  • encodeJpeg: ((image, quality?) => Promise<Uint8Array>)
      • (image, quality?): Promise<Uint8Array>
      • Parameters

        • image: Image
        • Optional quality: number

        Returns Promise<Uint8Array>

  • getLicenseInfo: (() => Promise<LicenseInfo>)
  • initialize: ((licenseKey?, enginePath?, appId?, options?) => Promise<void>)
      • (licenseKey?, enginePath?, appId?, options?): Promise<void>
      • Parameters

        • Optional licenseKey: string
        • Optional enginePath: string
        • Optional appId: string
        • Optional options: InitializeOptions

        Returns Promise<void>

  • releaseObject: (<T>(objectToken) => Promise<void>)
      • <T>(objectToken): Promise<void>
      • Type Parameters

        • T

        Parameters

        Returns Promise<void>

  • version: (() => Promise<string>)
      • (): Promise<string>
      • Returns Promise<string>

transferArgs: {
    BarcodeDocumentParser: WorkerBarcodeDocumentParser;
    BarcodeScanner: WorkerBarcodeScanner;
    CheckScanner: WorkerCheckScanner;
    CreditCardScanner: WorkerCreditCardScanner;
    DocumentClassifier: WorkerDocumentClassifier;
    DocumentDataExtractor: WorkerDocumentDataExtractor;
    DocumentQualityAnalyzer: WorkerDocumentQualityAnalyzer;
    DocumentScanner: WorkerDocumentScanner;
    ImageManipulator: WorkerImageManipulator;
    ImageProcessor: WorkerImageProcessor;
    MrzParser: WorkerMrzParser;
    MrzScanner: WorkerMrzScanner;
    OcrEngine: WorkerOcrEngine;
    TextPatternScanner: WorkerTextPatternScanner;
    VinScanner: WorkerVinScanner;
    __callModuleFunction: ((functionName, args?) => Promise<any>);
    __hasModuleFunction: ((functionName) => Promise<any>);
    addPageToPdf: ((pdfOperation, image, binarization?) => Promise<void>);
    addPageToPdfWithOcr: ((pdfOperation, image, binarization?) => Promise<void>);
    addPageToTiff: ((tiffOperation, image, binarization) => Promise<void>);
    beginPdf: ((options) => Promise<ObjectId<"PdfGenerationContext">>);
    beginTiff: ((options) => Promise<ObjectId<"TiffGenerationContext">>);
    completePdf: ((pdfOperation) => Promise<Uint8Array>);
    completeTiff: ((tiffOperation) => Promise<Uint8Array>);
    encodeJpeg: ((image, quality?) => Promise<Uint8Array>);
    getLicenseInfo: (() => Promise<LicenseInfo>);
    initialize: ((licenseKey?, enginePath?, appId?, options?) => Promise<void>);
    releaseObject: (<T>(objectToken) => Promise<void>);
    version: (() => Promise<string>);
}

Type declaration

  • BarcodeDocumentParser: WorkerBarcodeDocumentParser
  • BarcodeScanner: WorkerBarcodeScanner
  • CheckScanner: WorkerCheckScanner
  • CreditCardScanner: WorkerCreditCardScanner
  • DocumentClassifier: WorkerDocumentClassifier
  • DocumentDataExtractor: WorkerDocumentDataExtractor
  • DocumentQualityAnalyzer: WorkerDocumentQualityAnalyzer
  • DocumentScanner: WorkerDocumentScanner
  • ImageManipulator: WorkerImageManipulator
  • ImageProcessor: WorkerImageProcessor
  • MrzParser: WorkerMrzParser
  • MrzScanner: WorkerMrzScanner
  • OcrEngine: WorkerOcrEngine
  • TextPatternScanner: WorkerTextPatternScanner
  • VinScanner: WorkerVinScanner
  • __callModuleFunction: ((functionName, args?) => Promise<any>)
      • (functionName, args?): Promise<any>
      • Parameters

        • functionName: string
        • Optional args: any[]

        Returns Promise<any>

  • __hasModuleFunction: ((functionName) => Promise<any>)
      • (functionName): Promise<any>
      • Parameters

        • functionName: string

        Returns Promise<any>

  • addPageToPdf: ((pdfOperation, image, binarization?) => Promise<void>)
      • (pdfOperation, image, binarization?): Promise<void>
      • Parameters

        Returns Promise<void>

  • addPageToPdfWithOcr: ((pdfOperation, image, binarization?) => Promise<void>)
      • (pdfOperation, image, binarization?): Promise<void>
      • Parameters

        Returns Promise<void>

  • addPageToTiff: ((tiffOperation, image, binarization) => Promise<void>)
      • (tiffOperation, image, binarization): Promise<void>
      • Parameters

        Returns Promise<void>

  • beginPdf: ((options) => Promise<ObjectId<"PdfGenerationContext">>)
      • (options): Promise<ObjectId<"PdfGenerationContext">>
      • Parameters

        • options: {
              attributes?: {
                  author?: string;
                  creator?: string;
                  keywords?: string;
                  subject?: string;
                  title?: string;
              };
              binarizationFilter?: {
                  filterType?: number;
              } & {
                  _type: "LegacyFilter";
              } | {
                  outputMode?: OutputMode;
              } & {
                  _type: "ScanbotBinarizationFilter";
              } | {
                  denoise?: number;
                  outputMode?: OutputMode;
                  preset?: BinarizationFilterPreset;
                  radius?: number;
              } & {
                  _type: "CustomBinarizationFilter";
              } | {
                  blackOutliersFraction?: number;
                  borderWidthFraction?: number;
                  colorEnhancement?: number;
                  contrastEnhancement?: number;
                  paperWhitening?: number;
                  paperWhiteningBias?: number;
                  radius?: number;
                  whiteOutliersFraction?: number;
              } & {
                  _type: "ColorDocumentFilter";
              } | {
                  brightness?: number;
              } & {
                  _type: "BrightnessFilter";
              } | {
                  contrast?: number;
              } & {
                  _type: "ContrastFilter";
              } | {
                  blackOutliersFraction?: number;
                  borderWidthFraction?: number;
                  whiteOutliersFraction?: number;
              } & {
                  _type: "GrayscaleFilter";
              } | {
                  blackPoint?: number;
                  whitePoint?: number;
              } & {
                  _type: "WhiteBlackPointFilter";
              };
              dpi?: number;
              jpegQuality?: number;
              pageDirection?: PageDirection;
              pageFit?: PageFit;
              pageSize?: PageSize;
              resamplingMethod?: ResamplingMethod;
          }
          • Optional attributes?: {
                author?: string;
                creator?: string;
                keywords?: string;
                subject?: string;
                title?: string;
            }
            • Optional author?: string
            • Optional creator?: string
            • Optional keywords?: string
            • Optional subject?: string
            • Optional title?: string
          • Optional binarizationFilter?: {
                filterType?: number;
            } & {
                _type: "LegacyFilter";
            } | {
                outputMode?: OutputMode;
            } & {
                _type: "ScanbotBinarizationFilter";
            } | {
                denoise?: number;
                outputMode?: OutputMode;
                preset?: BinarizationFilterPreset;
                radius?: number;
            } & {
                _type: "CustomBinarizationFilter";
            } | {
                blackOutliersFraction?: number;
                borderWidthFraction?: number;
                colorEnhancement?: number;
                contrastEnhancement?: number;
                paperWhitening?: number;
                paperWhiteningBias?: number;
                radius?: number;
                whiteOutliersFraction?: number;
            } & {
                _type: "ColorDocumentFilter";
            } | {
                brightness?: number;
            } & {
                _type: "BrightnessFilter";
            } | {
                contrast?: number;
            } & {
                _type: "ContrastFilter";
            } | {
                blackOutliersFraction?: number;
                borderWidthFraction?: number;
                whiteOutliersFraction?: number;
            } & {
                _type: "GrayscaleFilter";
            } | {
                blackPoint?: number;
                whitePoint?: number;
            } & {
                _type: "WhiteBlackPointFilter";
            }
          • Optional dpi?: number
          • Optional jpegQuality?: number
          • Optional pageDirection?: PageDirection
          • Optional pageFit?: PageFit
          • Optional pageSize?: PageSize
          • Optional resamplingMethod?: ResamplingMethod

        Returns Promise<ObjectId<"PdfGenerationContext">>

  • beginTiff: ((options) => Promise<ObjectId<"TiffGenerationContext">>)
      • (options): Promise<ObjectId<"TiffGenerationContext">>
      • Parameters

        • options: {
              binarizationFilter?: {
                  filterType?: number;
              } & {
                  _type: "LegacyFilter";
              } | {
                  outputMode?: OutputMode;
              } & {
                  _type: "ScanbotBinarizationFilter";
              } | {
                  denoise?: number;
                  outputMode?: OutputMode;
                  preset?: BinarizationFilterPreset;
                  radius?: number;
              } & {
                  _type: "CustomBinarizationFilter";
              } | {
                  blackOutliersFraction?: number;
                  borderWidthFraction?: number;
                  colorEnhancement?: number;
                  contrastEnhancement?: number;
                  paperWhitening?: number;
                  paperWhiteningBias?: number;
                  radius?: number;
                  whiteOutliersFraction?: number;
              } & {
                  _type: "ColorDocumentFilter";
              } | {
                  brightness?: number;
              } & {
                  _type: "BrightnessFilter";
              } | {
                  contrast?: number;
              } & {
                  _type: "ContrastFilter";
              } | {
                  blackOutliersFraction?: number;
                  borderWidthFraction?: number;
                  whiteOutliersFraction?: number;
              } & {
                  _type: "GrayscaleFilter";
              } | {
                  blackPoint?: number;
                  whitePoint?: number;
              } & {
                  _type: "WhiteBlackPointFilter";
              };
              compression?: CompressionMode;
              dpi?: number;
              jpegQuality?: number;
              userFields?: {
                  name?: string;
                  tag?: number;
                  value?: {
                      value?: number;
                  } & {
                      _type: "UserFieldDoubleValue";
                  } | {
                      value?: string;
                  } & {
                      _type: "UserFieldStringValue";
                  } | {
                      value?: number;
                  } & {
                      _type: "UserFieldIntValue";
                  };
              }[];
              zipCompressionLevel?: number;
          }
          • Optional binarizationFilter?: {
                filterType?: number;
            } & {
                _type: "LegacyFilter";
            } | {
                outputMode?: OutputMode;
            } & {
                _type: "ScanbotBinarizationFilter";
            } | {
                denoise?: number;
                outputMode?: OutputMode;
                preset?: BinarizationFilterPreset;
                radius?: number;
            } & {
                _type: "CustomBinarizationFilter";
            } | {
                blackOutliersFraction?: number;
                borderWidthFraction?: number;
                colorEnhancement?: number;
                contrastEnhancement?: number;
                paperWhitening?: number;
                paperWhiteningBias?: number;
                radius?: number;
                whiteOutliersFraction?: number;
            } & {
                _type: "ColorDocumentFilter";
            } | {
                brightness?: number;
            } & {
                _type: "BrightnessFilter";
            } | {
                contrast?: number;
            } & {
                _type: "ContrastFilter";
            } | {
                blackOutliersFraction?: number;
                borderWidthFraction?: number;
                whiteOutliersFraction?: number;
            } & {
                _type: "GrayscaleFilter";
            } | {
                blackPoint?: number;
                whitePoint?: number;
            } & {
                _type: "WhiteBlackPointFilter";
            }
          • Optional compression?: CompressionMode
          • Optional dpi?: number
          • Optional jpegQuality?: number
          • Optional userFields?: {
                name?: string;
                tag?: number;
                value?: {
                    value?: number;
                } & {
                    _type: "UserFieldDoubleValue";
                } | {
                    value?: string;
                } & {
                    _type: "UserFieldStringValue";
                } | {
                    value?: number;
                } & {
                    _type: "UserFieldIntValue";
                };
            }[]
          • Optional zipCompressionLevel?: number

        Returns Promise<ObjectId<"TiffGenerationContext">>

  • completePdf: ((pdfOperation) => Promise<Uint8Array>)
      • (pdfOperation): Promise<Uint8Array>
      • Parameters

        • pdfOperation: ObjectId<"PdfGenerationContext">

        Returns Promise<Uint8Array>

  • completeTiff: ((tiffOperation) => Promise<Uint8Array>)
      • (tiffOperation): Promise<Uint8Array>
      • Parameters

        • tiffOperation: ObjectId<"TiffGenerationContext">

        Returns Promise<Uint8Array>

  • encodeJpeg: ((image, quality?) => Promise<Uint8Array>)
      • (image, quality?): Promise<Uint8Array>
      • Parameters

        • image: Image
        • Optional quality: number

        Returns Promise<Uint8Array>

  • getLicenseInfo: (() => Promise<LicenseInfo>)
  • initialize: ((licenseKey?, enginePath?, appId?, options?) => Promise<void>)
      • (licenseKey?, enginePath?, appId?, options?): Promise<void>
      • Parameters

        • Optional licenseKey: string
        • Optional enginePath: string
        • Optional appId: string
        • Optional options: InitializeOptions

        Returns Promise<void>

  • releaseObject: (<T>(objectToken) => Promise<void>)
      • <T>(objectToken): Promise<void>
      • Type Parameters

        • T

        Parameters

        Returns Promise<void>

  • version: (() => Promise<string>)
      • (): Promise<string>
      • Returns Promise<string>

Methods

  • Returns Promise<void>

Generated using TypeDoc