Skip to content

Document the WebSocket API #371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 21 commits into from
Oct 29, 2024
Merged

Document the WebSocket API #371

merged 21 commits into from
Oct 29, 2024

Conversation

@kettanaito
Copy link
Member

@kettanaito kettanaito commented Feb 21, 2024 •
edited
Loading

Roadmap

  • Rewrite the "Describing WebSocket APIs" page to be more usage-driven (no generic info). I've since moved the generic WS handling info to "Handling WebSocket events".
  • Stress that MSW only supports the WebSocket protocol.
  • Disambiguate between WS and duplex HTTP2
  • Document how to read the WebSocket logger added by MSW.
  • Document new open and close events of the server.
  • Document new close event of the client.

@vercel
Copy link

vercel bot commented Feb 21, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
mswjs.io ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 29, 2024 11:23am
source-mswjs-io ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 29, 2024 11:23am
website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 29, 2024 11:23am

@kettanaito kettanaito marked this pull request as ready for review October 29, 2024 11:37
@kettanaito kettanaito merged commit 4cdc259 into main Oct 29, 2024
3 checks passed
@kettanaito kettanaito deleted the docs/ws branch October 29, 2024 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@kettanaito