NewWacht Bench is live — AI-assisted development for Wacht

healthCheck()

Calls the backend health endpoint and returns a simple status object.

Usage

The following example shows a basic usage of the backend client from @wacht/nextjs/server.

import { wachtClient } from '@wacht/nextjs/server';export async function health() {  const client = await wachtClient();  return client.health.healthCheck();}

Signature

function healthCheck(): Promise<{ status: string }>

Return value

status?: string | undefined;
Backend health status string (for example `ok`).

Behavior

  • Useful for startup probes and operational readiness checks.
  • Returns a lightweight status payload and does not require resource parameters.

On this page