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.
53 lines
2.1 KiB
Markdown
53 lines
2.1 KiB
Markdown
# `verae-zapier-middleware/store/usage`
|
||
|
||
**Package:** `verae-zapier-middleware`
|
||
**Source:** `packages/verae-zapier-middleware/src/store/usage.js`
|
||
**Lines:** 103
|
||
|
||
## What this module is
|
||
|
||
Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).
|
||
|
||
## Exports
|
||
|
||
`getUsage`, `getUsageSummary`, `incrementUsage`
|
||
|
||
## Types / interfaces / classes
|
||
|
||
_None extracted._
|
||
|
||
## Functions
|
||
|
||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||
|------|------------|---------------------|---------|-----------------------------|
|
||
| `currentPeriod` | `(none)` | — | `string` — YYYY-MM period key | see Call graph |
|
||
| `emptyUsage` | `tenantId` | tenantId: `string` | `{ period: string, timestamps: number, verifications: number, statusChecks: number, batchTimestamps: number, overage: object ` — } | see Call graph |
|
||
| `getUsage` | `tenantId` | tenantId: `string` | `ReturnType<typeof emptyUsage>` | see Call graph |
|
||
| `getUsageSummary` | `tenantId` | tenantId: `string` | `object` | see Call graph |
|
||
| `incrementUsage` | `tenantId, metric, amount = 1` | tenantId: `string`, metric: `string`, amount: `number` | `void` | see Call graph |
|
||
|
||
## Methods (class / object)
|
||
|
||
| Name | Parameters |
|
||
|------|------------|
|
||
| `getStore` | `(none)` |
|
||
| `persist` | `(none)` |
|
||
|
||
## What it imports / requires
|
||
|
||
- `./db.js`
|
||
- `./tenants.js`
|
||
- `../debug/logger.js`
|
||
|
||
## Call graph (identifiers invoked)
|
||
|
||
`createDebugger`, `currentPeriod`, `getUTCFullYear`, `getUTCMonth`, `padStart`, `emptyUsage`, `getUsage`, `getStore`, `getUsageSummary`, `getTenant`, `resolveLimits`, `incrementUsage`, `startsWith`, `slice`, `persist`, `debug`
|
||
|
||
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`.
|
||
|