API documentation

Package documentation is organized as one page per function, method, and type — no separate cookbook pages.

How to read a symbol page

Each API page includes:

1. Overview — what the symbol does, with Node.js context when relevant
2. Signature — the Go declaration
3. Compare — Node.js, standard library Go, and gox side by side
4. Example — runnable usage
5. Tips — when to use it and common pitfalls
6. Standard library alternative — how to do the same thing without gox

Browse packages

Open any package from the sidebar under Packages, pick a symbol, and read the full explanation on that page.

For migration from npm libraries, see the Migration guides.