Reference
Reference Overview
Lookup tables, status codes, type definitions, and version history. Use these when you need to verify specific behaviour rather than learn a concept.
In this section
| Page | What's in it |
|---|---|
| Exported Types | All export type definitions from the root module with full shapes |
| Request Pipeline | The five stages every request passes through, with status codes |
| Changelog | Full version history: added, changed, removed, breaking changes |
Status codes quick reference
| Code | Stage | Cause | Override? |
|---|---|---|---|
| 200 | Handler | res:Send() or implicit | Use res:Status(n):Send() |
| 400 | Router | Typed param coercion failed | app:OnParamError(fn) |
| 403 | Middleware | Middleware returned false | Can't override; use res:Error() in handler instead |
| 404 | Router | No matching route | No override |
| 429 | TokenBucket | Player's token bucket empty | Adjust max/refill/cost |
| 500 | Middleware / Handler | Unhandled Lua error | Wrap in pcall |
Module context matrix
| Module | Server | Client |
|---|---|---|
| App | ✓ | ✗ |
| Broadcast | ✓ | ✗ |
| Tamper | ✓ | ✗ |
| Port | ✓ | ✗ |
| Network | ✗ | ✓ |
| Listener | ✗ | ✓ |
| Stream | ✓ | ✓ |
| Router | ✓ | ✓ |
| Codec | ✓ | ✓ |
| Bridge | ✓ | ✓ |
| TokenBucket | ✓ | ✓ |
| Base64 | ✓ | ✓ |
See also
Guides | how-to walkthroughs · Examples | full working projects · Community | support