API Reference & Compatibility

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

Functions

payloadHealthCheck

Source

payloadHealthCheck(payload: PayloadLike, options: PayloadHealthCheckOptions) => HealthCheckDefinition<"payload">

Exported from: @nexload-sdk/healthcheck-payload

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

Interfaces

PayloadHealthCheckOptions

Source

interface PayloadHealthCheckOptions {
  collection: string
  limit?: number
  timeoutMs?: number
  where?: Record<string, unknown>
  depth?: number
  expectedMinDocuments?: number
  scopes?: readonly HealthScope[]
}

Exported from: @nexload-sdk/healthcheck-payload

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

---

Runtime Compatibility Matrix

Runtime / Engine	Version Requirement	Verification Status
Node.js	>=20.9.0	Verified on Node 20 & 22
Payload CMS	>=3.85.0 <4.0.0	Verified on Payload 3.86.0
Module Format	ESM only	Native ECMAScript Modules
Side Effects	false	Fully tree-shakeable