API Reference & Compatibility

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

Functions

toOpenMetricsText

Source

toOpenMetricsText(report: HealthReport, options?: OpenMetricsExportOptions) => string

Exported from: @nexload-sdk/healthcheck-prometheus

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

toPrometheusText

Source

toPrometheusText(report: HealthReport, options?: PrometheusExportOptions) => string

Exported from: @nexload-sdk/healthcheck-prometheus

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

Interfaces

PrometheusExportOptions

Source

interface PrometheusExportOptions {
  prefix?: string
  defaultLabels?: Record<string, string>
  includeDescriptions?: boolean
}

Exported from: @nexload-sdk/healthcheck-prometheus

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

Types

OpenMetricsExportOptions

Source

type OpenMetricsExportOptions = PrometheusExportOptions;

Exported from: @nexload-sdk/healthcheck-prometheus

Public type exported by @nexload-sdk/healthcheck-prometheus.

---

Runtime Compatibility Matrix

Runtime / Engine	Version Requirement	Verification Status
Node.js	>=20.9.0	Verified on Node 20 & 22
Bun	>=1.0.0	Verified on Bun 1.1+
Module Format	ESM only	Native ECMAScript Modules
Side Effects	false	Fully tree-shakeable