API Reference & Compatibility

The complete public API symbol inventory is generated automatically from package source exports:

Functions

createNextHealthRoute

Source

createNextHealthRoute(manager: HealthManager, options: NextHealthRouteOptions) => { GET: (request: Request) => Promise<Response>; HEAD: (request: Request) => Promise<Response>; }

Exported from: @nexload-sdk/healthcheck-next

Public function exported by @nexload-sdk/healthcheck-next.

createNextMetricsRoute

Source

createNextMetricsRoute(manager: HealthManager, options: NextMetricsRouteOptions) => { GET: (request: Request) => Promise<Response>; }

Exported from: @nexload-sdk/healthcheck-next

Public function exported by @nexload-sdk/healthcheck-next.

Interfaces

NextHealthRouteOptions

Source

interface NextHealthRouteOptions {
  scope: HealthScope
  format?: "json" | "summary"
  httpStatus?: HealthHttpStatusPolicy
  includeDetails?: boolean | ((request: Request) => boolean)
  protect?: NextHealthRouteProtection
  headers?: HeadersInit | ((report: HealthReport) => HeadersInit)
  cache?: "no-store"
}

Exported from: @nexload-sdk/healthcheck-next

Public interface exported by @nexload-sdk/healthcheck-next.

NextHealthRouteProtection

Source

interface NextHealthRouteProtection {
  bearerToken?: string
  basicAuth?: {
    username: string
    password: string
  }
  allowCidrs?: readonly string[]
  allowIps?: readonly string[]
  trustProxy?: boolean
  proxyHeader?: "x-forwarded-for" | "x-real-ip" | string
}

Exported from: @nexload-sdk/healthcheck-next

Public interface exported by @nexload-sdk/healthcheck-next.

NextMetricsRouteOptions

Source

interface NextMetricsRouteOptions {
  format: "prometheus" | "openmetrics" | "json"
  scope?: HealthRunScope
  protect?: NextHealthRouteProtection
  prefix?: string
  defaultLabels?: Record<string, string>
}

Exported from: @nexload-sdk/healthcheck-next

Public interface exported by @nexload-sdk/healthcheck-next.

---

Runtime Compatibility Matrix

Runtime / Engine	Version Requirement	Verification Status
Next.js	>=14.0.0	Verified on Next.js 14 & 15 App Router
Node.js	>=20.9.0	Node.js Route Handler runtime
Module Format	ESM only	Native ECMAScript Modules
Side Effects	false	Fully tree-shakeable