Mobile Document Scanner API Reference / ScanResult

Type Alias: ScanResult

ScanResult = SuccessfulScan | { status: "cancelled"; } | { error: ScannerError; status: "failed"; }

Defined in: src/results.ts:230

The value that scan() resolves with. A cancelled session drops every page in the document. A failed session keeps the pages, as finish() does. Thus a later scan() starts with them. reset() drops them. Only a major release adds a status.