Skip to content

TypeScript SDK Reference / GetHealthResult

Interface: GetHealthResult

The information of the ongoing scan, returned by the function getHealth.

See

getHealth

Extended by

Properties

error?

error?: any

The error of the scan. When an error occur, this variable is set and the stage is changed to Idle. (This version doesn't return any error, it's for future compatibility.)


health?

health?: Health

The health result of the scan.


message?

message?: string

The information of warning message of the scan. (This version doesn't return any message, it's for future compatibility.)


remainingTime

remainingTime: number

The remaining time of the current scanning stage.


stage

stage: GetHealthStage

The stage of the scanning.