Class WorkerDocumentScanner

This class is used inside the JS Worker and interacts directly with the WASM.

Index

Constructors

Methods

clearResult create destroy run scan

Constructors

constructor

new WorkerDocumentScanner(getWasmModule): WorkerDocumentScanner
Parameters
- getWasmModule: (() => any)
  - - (): any
    - Returns any
Returns WorkerDocumentScanner

Methods

clearResult

clearResult(instanceId): Promise<void>
Parameters
- instanceId: ObjectId<"DocumentScanner">
Returns Promise<void>

create

create(configuration): Promise<ObjectId<"DocumentScanner">>
Parameters
- configuration: DocumentScannerConfiguration
Returns Promise<ObjectId<"DocumentScanner">>

destroy

destroy(instanceId): Promise<void>
Parameters
- instanceId: ObjectId<"DocumentScanner">
Returns Promise<void>

run

run(instanceId, image): Promise<{
originalImage: Image;
result: DocumentDetectionResult;
}>
Parameters
- instanceId: ObjectId<"DocumentScanner">
- image: Image
Returns Promise<{
originalImage: Image;
result: DocumentDetectionResult;
}>

scan

scan(instanceId, image): Promise<{
originalImage: Image;
result: DocumentScanningResult;
}>
Parameters
- instanceId: ObjectId<"DocumentScanner">
- image: Image
Returns Promise<{
originalImage: Image;
result: DocumentScanningResult;
}>

Generated using TypeDoc