Mobile Document Scanner API Reference / DocumentResult

Interface: DocumentResult

Defined in: src/views/utils/types.ts:168

Represents the complete output of a document scanning operation.

Remarks

Optional properties present only on successful scans.

Example

const result = await scanner.scan();
if (result.status.code === EnumResultStatus.RS_SUCCESS) {
  const correctedImage = result.correctedImageResult;
  const originalImage = result.originalImageResult;
  const boundaries = result.detectedQuadrilateral;
}

Properties

correctedImageResult?

optional correctedImageResult?: DeskewedImageResultItem

Defined in: src/views/utils/types.ts:178

Perspective-corrected and enhanced image.

---

detectedQuadrilateral?

optional detectedQuadrilateral?: Quadrilateral

Defined in: src/views/utils/types.ts:188

Detected document boundaries (quadrilateral).

---

originalImageResult?

optional originalImageResult?: DSImageData

Defined in: src/views/utils/types.ts:183

Original captured image before processing.

---

status

status: ResultStatus

Defined in: src/views/utils/types.ts:173

Status of the scan operation.