master-zapier-plan-draft/docs/sphinx/modules/verae-fleet/health.md
George Lambert e401635fd6
Some checks are pending
offline / test (push) Waiting to run
Document every repo in Sphinx, catalog PDFs, and verae-ops
Add missing package READMEs, expand Sphinx to all runtime modules,
publish a LaTeX/PDF README book, and add verae-ops for Docker,
Proxmox, VMs, dedicated hardware, and service linking. Catalog
defaults to public PDF links for each module README and samples.
2026-09-11 14:36:17 -04:00

1.8 KiB
Raw Blame History

verae-fleet/health

Package: verae-fleet
Source: packages/verae-fleet/src/health.js
Lines: 119

What this module is

Implementation module in verae-fleet. The tables below are extracted from the source (signatures + JSDoc).

Exports

httpProbe, tcpProbe, postControl, heartbeatFresh

Types / interfaces / classes

None extracted.

Functions

Name Parameters Param types (JSDoc) Returns Calls (same file / helpers)
httpProbe portOrOpts, pathname = '/health', timeoutMs = 800 unknown see Call graph
tcpProbe host, port, timeoutMs = 400 unknown see Call graph
postControl portOrOpts, pathname = '/' pathname: string unknown see Call graph
heartbeatFresh stateDir, maxAgeMs unknown see Call graph
done ok, error unknown see Call graph

What it imports / requires

  • node:http
  • node:net
  • node:fs
  • node:path

Call graph (identifiers invoked)

httpProbe, get, on, push, parse, concat, toString, resolve, destroy, tcpProbe, connect, setTimeout, done, postControl, stringify, request, byteLength, write, end, heartbeatFresh, join, statSync, readFileSync, now

Each identifier is a call site in this file. Follow the import list to see the defining module; open that modules MD for parameter and return types.

Return values (how to read this)

  • HTTP route handlers return Express res.json(...) bodies (see route docs).
  • Zapier perform functions return a single object (creates) or an array (triggers/searches).
  • Pricing functions return integer cents on Quote.totalCents.