smocket docs
TL;DR Start with the README quick start, choose the test-runner or SharedWorker workflow that matches your application, then use the scope, differences, conformance, and troubleshooting pages to answer exact questions.
This page is published at smocket-site.vercel.app/docs.
Start with Smocket
Smocket reproduces Socket.IO's in-memory delivery and routing rules so frontend and application tests can exercise rooms, namespaces, broadcasts, and acknowledgements without starting a network server. The README quick start is the shortest executable setup and remains the canonical installation example.
From there, choose the path that matches the code you have:
- Keep an application's
socket.io-clientimport with the test-runner integration guide. - Choose among the four supported imports in the package entry-point guide.
- Share one caller-owned mock server across same-origin browser tabs with the SharedWorker workflow.
- Check the scope boundary and differences from real Socket.IO before relying on an unverified surface.
- Use the troubleshooting guide when setup fails before the first application event.
Understand the guarantees
- Conformance report: behaviours compared by the dual run.
- Adapter registration: Smocket-only routing extensions.
- Glossary: Socket.IO and Smocket terms used by these guides.
- Roadmap: the boundary and release path toward v1.0.0.
- Drawing-game case study: executable compatibility evidence from one application workflow.
Maintain the project
- Contributing · 한국어
- Documentation guide
- Repository structure and script guide
- Development lenses
- Decisions index
- Public surface ledger
- Package policy
- Release candidates, npm publication, and release completion, and release remediation
- Published consumer policy
- Issue and pull request labels
- Version compatibility decision
English documentation is authoritative. Maintained Korean entry points are limited to the repository README and contribution guide so the project does not promise to synchronize every page.