Document every repo in Sphinx, catalog PDFs, and verae-ops
Some checks are pending
offline / test (push) Waiting to run
Some checks are pending
offline / test (push) Waiting to run
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.
This commit is contained in:
parent
5ad3222def
commit
e401635fd6
222 changed files with 4498 additions and 123 deletions
51
docs/modules/verae-fleet/agent.md
Normal file
51
docs/modules/verae-fleet/agent.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# `verae-fleet/agent`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/agent.js`
|
||||
**Lines:** 87
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`startAgent`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `json` | `res, code, obj` | — | `unknown` | see Call graph |
|
||||
| `readBody` | `req` | — | `unknown` | see Call graph |
|
||||
| `startAgent` | `{ port = PORT, bind = BIND } = {}` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `startAgent` | `(none)` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `node:child_process`
|
||||
- `node:path`
|
||||
- `node:url`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`join`, `dirname`, `fileURLToPath`, `json`, `writeHead`, `end`, `stringify`, `readBody`, `push`, `concat`, `toString`, `parse`, `startAgent`, `createServer`, `async`, `keys`, `has`, `get`, `spawn`, `set`, `on`, `delete`, `kill`, `listen`, `write`, `close`, `values`, `clear`, `basename`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue