Class DocumentReaderService

Constructors

constructor

new DocumentReaderService(): DocumentReaderService
Returns DocumentReaderService

Properties

imageProcessParam

imageProcessParam: BaseRequest = ...

initData

initData: License | null = null

isInitialized

isInitialized: boolean = false

isPrepared

isPrepared: boolean = false

isProcessing

isProcessing: boolean = false

onFinalize

onFinalize: TOnFinalize | null = null

recognizeListener

recognizeListener: RecognizeListener | null = null

recognizerProcessParam

recognizerProcessParam: ProcessingRequest = ...

`Readonly`version

version: { component: string } = ...

workerPath

workerPath: string = DOC_WASM_BARCODE_MRZ_PATH

Accessors

initializeListener

get initializeListener(): TInitializeListener | null
Returns TInitializeListener | null
set initializeListener(listener: TInitializeListener | null): void
Parameters
- listener: TInitializeListener | null
Returns void

processingListener

get processingListener(): TProcessingListener | null
Returns TProcessingListener | null
set processingListener(listener: TProcessingListener | null): void
Parameters
- listener: TProcessingListener | null
Returns void

Methods

addDataToPackage

addDataToPackage(data: Uint8ClampedArray, params: PackageParams): Promise<void>
Parameters
- data: Uint8ClampedArray
- params: PackageParams
Returns Promise<void>

createBackendTransaction

createBackendTransaction(
metadata?: Record<string, any>,
params?: ProcessingRequest,
): Promise<NewTransaction>
Parameters
- Optionalmetadata: Record<string, any>
- Optionalparams: ProcessingRequest
Returns Promise<NewTransaction>

finalizePackage

finalizePackage(): Promise<TransactionIdentifier>
Returns Promise<TransactionIdentifier>

initialize

initialize(
initData?: { license?: string; module?: ModuleType },
): Promise<License>
Parameters
- OptionalinitData: { license?: string; module?: ModuleType }
Returns Promise<License>

process

process(
imageDataArray: ImageData[],
params?: ProcessingRequest,
): Promise<ProcessResult>
Parameters
- imageDataArray: ImageData[]
- Optionalparams: ProcessingRequest
Returns Promise<ProcessResult>

processImage

processImage(
imageDataArray: ImageData[] | ArrayBuffer[],
params?: ProcessingRequest,
): Promise<ProcessResult>
Parameters
- imageDataArray: ImageData[] | ArrayBuffer[]
- Optionalparams: ProcessingRequest
Returns Promise<ProcessResult>

processImageBase64

processImageBase64(
base64ImagesArray: string[],
params: ProcessingRequest,
): Promise<ProcessResult>
Parameters
- base64ImagesArray: string[]
- params: ProcessingRequest
Returns Promise<ProcessResult>

shutdown

shutdown(): void
Returns void

startNewDocument

startNewDocument(
metadata?: Record<string, any>,
params?: ProcessingRequest,
): Promise<NewTransaction>
Parameters
- Optionalmetadata: Record<string, any>
- Optionalparams: ProcessingRequest
Returns Promise<NewTransaction>

startNewPage

startNewPage(): Promise<void>
Returns Promise<void>