George Lambert
10c663cc0c
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.
55 lines
2.1 KiB
Markdown
55 lines
2.1 KiB
Markdown
# `verae-zapier-middleware/workers/webhookWorker`
|
||
|
||
**Package:** `verae-zapier-middleware`
|
||
**Source:** `packages/verae-zapier-middleware/src/workers/webhookWorker.js`
|
||
**Lines:** 139
|
||
|
||
## What this module is
|
||
|
||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||
|
||
## Exports
|
||
|
||
`startWebhookWorker`, `stopWebhookWorker`
|
||
|
||
## Types / interfaces / classes
|
||
|
||
_None extracted._
|
||
|
||
## Functions
|
||
|
||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||
|------|------------|---------------------|---------|-----------------------------|
|
||
| `handleDeliver` | `data, ctrl` | data: `object` | `unknown` | see Call graph |
|
||
| `startWebhookWorker` | `(none)` | — | `Promise<{ stop: () => Promise<void> ` — >} | see Call graph |
|
||
| `stopWebhookWorker` | `(none)` | — | `Promise<void>` | see Call graph |
|
||
| `runConsumer` | `stream, durable` | — | `unknown` | see Call graph |
|
||
|
||
## Methods (class / object)
|
||
|
||
| Name | Parameters |
|
||
|------|------------|
|
||
| `runConsumer` | `STREAMS.ZAPIER_EVENTS, CONSUMERS.EVENT_WEBHOOK_ROUTER` |
|
||
| `runConsumer` | `STREAMS.ZAPIER_WEBHOOKS, CONSUMERS.WEBHOOK_DELIVER` |
|
||
|
||
## What it imports / requires
|
||
|
||
- `../debug/logger.js`
|
||
- `../nats/subjects.js`
|
||
- `../nats/connection.js`
|
||
- `../services/webhookService.js`
|
||
- `../store/webhooks.js`
|
||
- `../debug/trace.js`
|
||
|
||
## Call graph (identifiers invoked)
|
||
|
||
`createDebugger`, `messages`, `handleDeliver`, `withTrace`, `async`, `getActiveWebhooks`, `deliverWebhook`, `ack`, `warn`, `keys`, `debug`, `nak`, `worker`, `startWebhookWorker`, `stopWebhookWorker`, `connectNats`, `ensureStreams`, `add`, `info`, `get`, `consume`, `parse`, `string`, `error`, `runConsumer`, `abort`
|
||
|
||
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`.
|
||
|