George Lambert 10c663cc0c 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.

2026-09-09 02:44:51 -04:00

2 KiB

Raw Blame History

`verae-zapier-middleware/store/jobWatchers`

Package: verae-zapier-middleware
Source: packages/verae-zapier-middleware/src/store/jobWatchers.js
Lines: 90

What this module is

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

Exports

enqueueJob, listPendingJobs, updateJobWatcher, removeJobWatcher

Types / interfaces / classes

None extracted.

Functions

Name	Parameters	Param types (JSDoc)	Returns	Calls (same file / helpers)
`enqueueJob`	`{ tenantId, jobId, veraeToken, traceId }`	params: `object`, params.tenantId: `string`, params.jobId: `string`, params.veraeToken: `string`, params.traceId: `string`	`JobWatcher`	see Call graph
`listPendingJobs`	`(none)`	—	`JobWatcher[]`	see Call graph
`updateJobWatcher`	`id, patch`	id: `string`, patch: `Partial<JobWatcher>`	`JobWatcher	null`
`removeJobWatcher`	`id`	id: `string`	`void`	see Call graph

Methods (class / object)

Name	Parameters
`persist`	`(none)`
`persist`	`(none)`
`persist`	`(none)`

What it imports / requires

node:crypto
./db.js
../debug/logger.js

Call graph (identifiers invoked)

queue, createDebugger, enqueueJob, randomUUID, toISOString, getStore, push, persist, debug, listPendingJobs, filter, updateJobWatcher, findIndex, removeJobWatcher

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.

2 KiB Raw Blame History Unescape Escape

verae-zapier-middleware/store/jobWatchers