Skip to content

API Reference & Compatibility

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

Functions

toOtelMetricRecords

Source
toOtelMetricRecords(report: HealthReport) => OtelMetricRecord[]

Exported from: @nexload-sdk/healthcheck-otel

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

toOtelResourceAttributes

Source
toOtelResourceAttributes(report: HealthReport) => Record<string, string | number | boolean>

Exported from: @nexload-sdk/healthcheck-otel

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

Interfaces

OtelMetricRecord

Source
interface OtelMetricRecord {
  name: string
  value: HealthMetricValue
  attributes: Record<string, string | number | boolean>
  unit?: string
  type?: HealthMetric["type"]
  observedAt: string
}

Exported from: @nexload-sdk/healthcheck-otel

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


Runtime / EngineVersion RequirementVerification Status
Node.js>=20.9.0Verified on Node 20 & 22
Bun>=1.0.0Verified on Bun 1.1+
Module FormatESM onlyNative ECMAScript Modules
Side EffectsfalseFully tree-shakeable