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
58
docs/sphinx/modules/verae-zapier-simulator/pipeline.md
Normal file
58
docs/sphinx/modules/verae-zapier-simulator/pipeline.md
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
# `verae-zapier-simulator/pipeline`
|
||||
|
||||
**Package:** `verae-zapier-simulator`
|
||||
**Source:** `packages/verae-zapier-simulator/src/pipeline.js`
|
||||
**Lines:** 883
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-zapier-simulator`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`ACTIONS`, `Simulator`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
| Kind | Name |
|
||||
|------|------|
|
||||
| class | `Simulator` |
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `redact` | `obj` | — | `unknown` | see Call graph |
|
||||
| `sleep` | `ms` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `constructor` | `(none)` |
|
||||
| `reset` | `(none)` |
|
||||
| `snapshot` | `(none)` |
|
||||
| `run` | `req` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:crypto`
|
||||
- `../../verae-request-splitter/src/splitRequest.js`
|
||||
- `../../verae-archive-worm/src/archive.js`
|
||||
- `../../verae-archive-aggregator/src/aggregate.js`
|
||||
- `../../verae-tree-node/src/merkle.js`
|
||||
- `./trace.js`
|
||||
- `./monitors.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`setTimeout`, `up`, `app`, `constructor`, `reset`, `snapshot`, `map`, `keys`, `values`, `run`, `emit`, `redact`, `perform`, `signup`, `finish`, `connect`, `edgeAuth`, `meter`, `timestamp`, `lookup`, `batch`, `verify`, `assign`, `analyze`, `randomUUID`, `replace`, `slice`, `push`, `authentication`, `at`, `find`, `splitRequest`, `archivePuts`, `get`, `net`, `maybeDelay`, `seal`, `toISOString`, `queryArchives`, `mergeReceipts`, `filter`, `sha256Hex`, `toLowerCase`, `test`, `verifyProof`, `isArray`, `split`, `trim`, `buildMerkle`, `shardIndex`, `merkleProof`, `put`, `endsWith`, `query`, `includes`, `aggregateAttached`, `set`, `now`, `sleep`
|
||||
|
||||
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