Variable commandsConst

Type declaration

• BarcodeDocumentParser: Config

• BarcodeScanner: Config

• CheckScanner: Config

• CreditCardScanner: Config

• DocumentClassifier: Config

• DocumentDataExtractor: Config

• DocumentQualityAnalyzer: Config

• DocumentScanner: Config

• ImageManipulator: Config

• ImageProcessor: Config

• MrzParser: Config

• MrzScanner: Config

• OcrEngine: Config

• TextPatternScanner: Config

• VinScanner: Config

• __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

      • pdfOperation: ObjectId<"PdfGenerationContext">

      • image: Image

      • Optional binarization: PageBinarization

      Returns Promise<void>

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

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

    • Parameters

      • pdfOperation: ObjectId<"PdfGenerationContext">

      • image: Image

      • Optional binarization: PageBinarization

      Returns Promise<void>

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

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

    • Parameters

      • tiffOperation: ObjectId<"TiffGenerationContext">

      • image: Image

      • binarization: PageBinarization

      Returns Promise<void>

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

  • • (options): Promise<ObjectId<"PdfGenerationContext">>

    • Parameters

      • options: DeepPartial<PdfConfiguration>

      Returns Promise<ObjectId<"PdfGenerationContext">>

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

  • • (options): Promise<ObjectId<"TiffGenerationContext">>

    • Parameters

      • options: DeepPartial<TiffGeneratorParameters>

      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

        The quality of the JPEG image, from 0 to 100, where larger numbers mean better quality but also larger file size.

      Returns Promise<Uint8Array>

• getLicenseInfo: (() => Promise<LicenseInfo>)

  • • (): Promise<LicenseInfo>

    • Returns 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

      • objectToken: ObjectId<T>

      Returns Promise<void>

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

  • • (): Promise<string>

    • Returns Promise<string>