Healthcheck Payload API

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.

payloadHealthCheck(payload, options) returns HealthCheckDefinition<"payload">.

PayloadHealthCheckOptions requires collection and supports limit, timeoutMs, where, depth, expectedMinDocuments, and scopes. Defaults are limit: 1, depth: 0, and scopes: ["readiness"].

Source: src/index.ts.