TypeScript SDK Reference / ScanResult

Interface: ScanResult

Defines the result of a vital sign scan. This extends GetHealthResult and contains the final health analysis data.

Extends

• GetHealthResult

Properties

error?

optional error: any

Error that occurred during scanning, if any (reserved for future use).

Inherited from

GetHealthResult.error

---

health?

optional health: Health

The final health analysis results, available when scanning is complete.

Inherited from

GetHealthResult.health

---

message?

optional message: string

Warning message about the scan (reserved for future use).

Inherited from

GetHealthResult.message

---

remainingTime

remainingTime: number

Time remaining in the current stage in seconds.

Inherited from

GetHealthResult.remainingTime

---

stage

stage: GetHealthStage

The current stage of the scanning process.

Inherited from

GetHealthResult.stage

---

totalTime

totalTime: number | undefined

Total duration of the current stage in seconds, undefined if not known.

Inherited from

GetHealthResult.totalTime