flowingts / HealthOptions

Interface: HealthOptions

Definido em: src/core/health.ts:11

Propriedades

anyHost?

optional anyHost?: boolean

Definido em: src/core/health.ts:27

Responde mesmo com um Host fora do allowedHosts. Sondas de orquestradores chegam com o IP do pod no Host (Kubernetes, ECS). Um Host malformado continua recebendo 400. Padrão: true.

---

checks?

optional checks?: Record<string, HealthCheck>

Definido em: src/core/health.ts:17

Verificações do /readyz, rodadas em paralelo: { db: () => db.ping() }.

---

guards?

optional guards?: readonly Guard[]

Definido em: src/core/health.ts:22

---

live?

optional live?: string | false

Definido em: src/core/health.ts:13

Liveness. Padrão: '/livez'; false desliga.

---

middlewares?

optional middlewares?: readonly Middleware[]

Definido em: src/core/health.ts:21

Rodam antes de responder (os middlewares globais não rodam nestas rotas).

---

ready?

optional ready?: string | false

Definido em: src/core/health.ts:15

Readiness. Padrão: '/readyz'; false desliga.

---

timeoutMs?

optional timeoutMs?: number

Definido em: src/core/health.ts:19

Tempo máximo de cada verificação. Padrão: 2000 ms.