Documentation

Documentation / @zerotal/core / health / HealthResult

Interface: HealthResult

Defined in: health/Health.ts:27

What a health check returns to describe its own state.

Properties

status?

optional status?: HealthStatus

Defined in: health/Health.ts:29

Defaults to ok when a check returns without throwing.

message?

optional message?: string

Defined in: health/Health.ts:30

meta?

optional meta?: Record<string, unknown>

Defined in: health/Health.ts:31