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.1 KiB

Raw Permalink Blame History

`verae-zapier-middleware/debug/logger`

Package: verae-zapier-middleware
Source: packages/verae-zapier-middleware/src/debug/logger.js
Lines: 122

What this module is

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

Exports

setDebugTestSink, formatLogLine, createDebugger

Types / interfaces / classes

None extracted.

Functions

Name	Parameters	Param types (JSDoc)	Returns	Calls (same file / helpers)
`setDebugTestSink`	`sink`	sink: `null	((line: string) => void)`	`void`
`formatLogLine`	`{ level, namespace, message, meta, traceId }`	parts: `object`, parts.level: `string`, parts.namespace: `string`, parts.message: `string`, parts.meta: `Record<string, unknown>	undefined`, parts.traceId:` string	null`
`emit`	`line, filePath`	line: `string`, filePath: `string	null`	`void`
`createDebugger`	`namespace`	namespace: `string`	`Debugger` — Logger with debug/info/warn/error methods.	see Call graph
`write`	`level, message, meta`	level: `'debug'	'info'	'warn'

What it imports / requires

node:fs
./config.js
./redact.js
./trace-context.js

Call graph (identifiers invoked)

setDebugTestSink, formatLogLine, toISOString, keys, stringify, redact, toUpperCase, emit, testSink, error, appendFileSync, createDebugger, debug, toLowerCase, write, loadDebugConfig, shouldLog, getTraceId

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.1 KiB Raw Permalink Blame History Unescape Escape

verae-zapier-middleware/debug/logger