Reference
Reference is the map of the codebase. One page per module under src/, listing every exported class, function, constant, interface, and type with its signature, what it is for, and where it lives. It is written for people who read, extend, or review the gateway’s internals.
Who this section is for
Section titled “Who this section is for”- Contributors adding a feature, a plugin, or a policy.
- Reviewers checking whether an internal is used correctly elsewhere.
- Anyone integrating against the gateway as a library rather than running it as a process.
What you can do with it
Section titled “What you can do with it”- Find the exact signature of anything exported from
src/. - Follow a symbol back to its file and see what it depends on.
- Understand the module boundaries — what belongs in
core,pipeline,identity, and so on — before adding code.
How to read it
Section titled “How to read it”Each page covers one module. It opens with a one-paragraph summary of the module’s responsibility, then a table of every export, then notes on the non-obvious ones. Signatures are copied from source; if a signature here disagrees with the source, the source wins — open an issue.
Pages are ordered by dependency, not alphabetically. Entrypoints and Types are the best starting points because everything else depends on them.
Modules
Section titled “Modules”| Module | Description |
|---|---|
| Entrypoints | Gateway bootstrap and top-level exports |
| Core Engine | HTTP server, radix router, connection pools, cache |
| Pipeline | Middleware policies and execution chain |
| Plugins | Plugin lifecycle hooks and built-in handlers |
| Identity | API key crypto and consumer management |
| Config | Schema validation and auto-tuning |
| Types | Core interfaces and contract types |
| Utils | Logger, object pool, and metrics buffers |
| Profiling | V8 CPU profiler and heap snapshots |
| Monitoring | Performance monitors and alerts |
| Observability | Prometheus exposition format |
| Admin | Administrative management endpoints |
| Testing | Test suites and benchmark harnesses |