Interface: CheckResult

Defined in: src/types.ts:210

Check execution result

Returned by checkFreshness, checkVolumeAnomaly, and checkSchemaChanges. Inspect status to decide whether to alert.

Example

const result: CheckResult = await checkFreshness(connector, rule);

if (result.status === 'alert') {
  console.log(`Stale by ${result.lagMinutes} minutes`);
}

Properties

baselineAverage?

optional baselineAverage: number

Defined in: src/types.ts:216

---

debug?

optional debug: DebugInfo

Defined in: src/types.ts:226

---

debugId?

optional debugId: string

Defined in: src/types.ts:225

---

deviation?

optional deviation: number

Defined in: src/types.ts:215

---

error?

optional error: string

Defined in: src/types.ts:218

---

executedAt

executedAt: Date

Defined in: src/types.ts:221

---

executionDurationMs?

optional executionDurationMs: number

Defined in: src/types.ts:220

---

lagMinutes?

optional lagMinutes: number

Defined in: src/types.ts:214

---

lastUpdate?

optional lastUpdate: Date

Defined in: src/types.ts:213

---

nextCheckAt?

optional nextCheckAt: Date

Defined in: src/types.ts:222

---

queryExecuted?

optional queryExecuted: string

Defined in: src/types.ts:219

---

rowCount?

optional rowCount: number

Defined in: src/types.ts:212

---

schemaChanges?

optional schemaChanges: SchemaChanges

Defined in: src/types.ts:217

---

status

status: CheckStatus

Defined in: src/types.ts:211