Class DocumentReaderService

constructor

• new DocumentReaderService(): DocumentReaderService

  Returns DocumentReaderService

imageProcessParam

initData

isInitialized

isPrepared

isProcessing

onFinalize

recognizeListener

recognizerProcessParam

version

workerPath

initializeListener

• get initializeListener(): null | TInitializeListener

  Returns null | TInitializeListener

• set initializeListener(listener: null | TInitializeListener): void

  Parameters

  • listener: null | TInitializeListener

  Returns void

processingListener

• get processingListener(): null | TProcessingListener

  Returns null | TProcessingListener

• set processingListener(listener: null | TProcessingListener): void

  Parameters

  • listener: null | TProcessingListener

  Returns void

addDataToPackage

• addDataToPackage(data: Uint8ClampedArray, params: PackageParams): Promise<void>

  Parameters

  • data: Uint8ClampedArray
  • params: PackageParams

  Returns Promise<void>

createBackendTransaction

• createBackendTransaction(
      metadata?: Record<string, any>,
  ): Promise<NewTransaction>

  Parameters

  • Optionalmetadata: Record<string, any>

  Returns Promise<NewTransaction>

finalizePackage

• finalizePackage(): Promise<TransactionIdentifier>

  Returns Promise<TransactionIdentifier>

initialize

• initialize(initData?: { license: undefined | string }): Promise<License>

  Parameters

  • OptionalinitData: { license: undefined | string }

  Returns Promise<License>

process

• process(
      imageDataArray: ImageData[],
      params?: ProcessingRequest,
  ): Promise<Response>

  Parameters

  • imageDataArray: ImageData[]
  • Optionalparams: ProcessingRequest

  Returns Promise<Response>

processImage

• processImage(
      imageDataArray: ImageData[] | ArrayBuffer[],
      params?: ProcessingRequest,
  ): Promise<Response>

  Parameters

  • imageDataArray: ImageData[] | ArrayBuffer[]
  • Optionalparams: ProcessingRequest

  Returns Promise<Response>

processImageBase64

• processImageBase64(
      base64ImagesArray: string[],
      params: ProcessingRequest,
  ): Promise<Response>

  Parameters

  • base64ImagesArray: string[]
  • params: ProcessingRequest

  Returns Promise<Response>

shutdown

• shutdown(): void

  Returns void

startNewDocument

• startNewDocument(metadata?: Record<string, any>): Promise<NewTransaction>

  Parameters

  • Optionalmetadata: Record<string, any>

  Returns Promise<NewTransaction>

startNewPage

• startNewPage(): Promise<void>

  Returns Promise<void>