Healthcheck Payload examples

import { payloadHealthCheck } from "@nexload-sdk/healthcheck-payload";

const payloadReady = payloadHealthCheck(payload, {
  collection: "settings",
  where: { key: { equals: "primary" } },
  expectedMinDocuments: 1,
  limit: 1,
  depth: 0,
  timeoutMs: 750,
});

Only use this minimum when the document is a real readiness prerequisite. Executable cases: payload.test.mjs.

The documentation example is type-checked in CI: healthcheck-payload.ts.