Documentation hub
Find the task, then get back to code.
This compact route replaces the previous long-form guide. Each engineering job now has its own focused page.
Task map
Open one focused page.
Install, first listener, module choices, defaults, and project status.
Overview → CLIEvery flag, task recipe, syntax rule, output, exit, and failure.
Command guide → Library APICommonJS/ESM, instances, lifecycle, methods, requests, and hooks.
API reference → ConfigurationEvery key/default, opt-out semantics, MIME, errors, logs, and HTTPS.
Config reference → ExamplesCopyable CLI and library patterns with expected results and failures.
Examples → PlaygroundGenerate CommonJS, ESM, CLI, and serializable JSON configuration.
Generator → Testing & coverageFour focused suites, per-file gates, reports, badges, CI, and contributor steps.
Testing guide → BenchmarksReal loopback requests, public-path scenarios, options, metrics, and comparison discipline.
Benchmark guide → OperationsExposure, HTTP failures, shutdown, logs, certificates, and v8 migration.
Operations →Quick lookup
Common question → exact section.
| Question | Go here |
|---|---|
| How do I use a free local port? | CLI common tasks |
| What does false or 0 disable? | Limits and timeouts |
| How do CJS and ESM exports differ? | Library imports |
| How do I run multiple servers? | Multiple servers and shutdown |
| How do I serve an SPA? | SPA + compression example |
| How do MIME overrides and denials work? | MIME and restrictions |
| Why did a request return 403/413/415/416/421? | Failure map |
| Where are tests and coverage reports? | Testing reports and badges |
| How do I measure real server paths? | Benchmark commands and profiles |
| What changed from v8? | Migration checklist |
Repository documents