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
41
docs/sphinx/modules/verae-archive-aggregator/aggregate.md
Normal file
41
docs/sphinx/modules/verae-archive-aggregator/aggregate.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# `verae-archive-aggregator/aggregate`
|
||||
|
||||
**Package:** `verae-archive-aggregator`
|
||||
**Source:** `packages/verae-archive-aggregator/src/aggregate.js`
|
||||
**Lines:** 67
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-archive-aggregator`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
`aggregateAttached`, `mergeReceipts`
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `aggregateAttached` | `{ sha256, tenantId, kinds = ['publicMeta', 'privateMeta', 'file'], archives }` | opts: `object`, opts.sha256: `string`, opts.tenantId: `string`, opts.kinds: `string[]`, opts.timeoutMs: `number` | `{ archivesQueried: boolean, archiveReplies: number, records: object[], silent: string[] ` — } | see Call graph |
|
||||
| `mergeReceipts` | `chainReceipts, archiveRecords` | chainReceipts: `object[]`, archiveRecords: `object[]` | `unknown` | see Call graph |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
_No imports detected._
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`mock`, `aggregateAttached`, `query`, `push`, `includes`, `mergeReceipts`, `map`
|
||||
|
||||
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