Milestone 2: module/model docs (MD, Sphinx RST, PDF) and work log

74 source modules documented with extracted signatures, JSDoc params,
imports, and call graphs. 10 first-class models (PriceRule through
StatusResponse) have their own MD/RST/PDF. Sphinx HTML builds from
docs/sphinx. Per-module PDFs in docs/modules-pdf and docs/models-pdf.

Middleware gates 2–6 and 10 pass on MOCK_VERAE without NATS.

Learned: RST includes are relative to the RST file; keep one PDF per
module; Add Numbers remains the only push required tomorrow.
This commit is contained in:
George Lambert 2026-09-09 02:44:51 -04:00
parent b814501441
commit 10c663cc0c
347 changed files with 17200 additions and 14 deletions

View file

@ -0,0 +1,57 @@
# `verae-zapier-middleware/workers/inProcessJobPoller`
**Package:** `verae-zapier-middleware`
**Source:** `packages/verae-zapier-middleware/src/workers/inProcessJobPoller.js`
**Lines:** 109
## What this module is
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`startInProcessJobPoller`, `stopInProcessJobPoller`
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `processJob` | `job` | job: `import('../store/jobWatchers.js').JobWatcher` | `unknown` | see Call graph |
| `tick` | `(none)` | — | `unknown` | see Call graph |
| `startInProcessJobPoller` | `(none)` | — | `void` | see Call graph |
| `stopInProcessJobPoller` | `(none)` | — | `void` | see Call graph |
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `updateJobWatcher` | `job.id, { attempts }` |
| `updateJobWatcher` | `job.id, { status: status.status }` |
| `removeJobWatcher` | `job.id` |
| `clearInterval` | `timer` |
## What it imports / requires
- `../config.js`
- `../clients/veraeClient.js`
- `../store/jobWatchers.js`
- `../store/webhooks.js`
- `../services/webhookService.js`
- `../debug/logger.js`
## Call graph (identifiers invoked)
`createDebugger`, `import`, `processJob`, `updateJobWatcher`, `removeJobWatcher`, `warn`, `getStatus`, `debug`, `getActiveWebhooks`, `deliverWebhook`, `error`, `tick`, `listPendingJobs`, `all`, `map`, `poller`, `startInProcessJobPoller`, `info`, `skipped`, `setInterval`, `stopInProcessJobPoller`, `clearInterval`
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`.