Skip to content
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.

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

docs(websocket): Add guide on using the native WebSocket client. #7535

Merged
merged 3 commits into from
Mar 5, 2025

Conversation

callezenwaka
Copy link
Contributor

@callezenwaka callezenwaka commented Mar 3, 2025

Description

This PR adds documentation for the new Node.js v22 native WebSocket client. It provides a guide on how to use the client, including code examples and explanations. The documentation clarifies that server-side WebSocket functionality still requires external libraries.

Validation

Screen.Recording.2025-03-04.at.10.51.24.mov
Screenshot 2025-03-04 at 10 54 50 Screenshot 2025-03-04 at 10 54 37 Screenshot 2025-03-04 at 10 54 06

Related Issues

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run npm run format to ensure the code follows the style guide.
  • I have run npm run test to check if all tests are passing.
  • I have run npx turbo build to check if the website builds without errors.
  • I've covered new added functionality with unit tests if necessary.

@callezenwaka callezenwaka requested a review from a team as a code owner March 3, 2025 16:09
Copy link

vercel bot commented Mar 3, 2025

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

Name Status Preview Updated (UTC)
nodejs-org ✅ Ready (Inspect) Visit Preview Mar 4, 2025 10:59am

@callezenwaka
Copy link
Contributor Author

Cc: @RafaelGSS

Copy link
Member

@RafaelGSS RafaelGSS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a small nit. Rest LGTM!

Copy link

@bjohansebas bjohansebas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, incredible to see that Node.js allows this.

@callezenwaka
Copy link
Contributor Author

Hi @RafaelGSS,
I Included to the guide, the WebSocket client commit and PR timeline.

Do take a look and let me know.

@callezenwaka callezenwaka requested a review from RafaelGSS March 3, 2025 19:07
@callezenwaka
Copy link
Contributor Author

Hi @AugustinMauroy,

I made edits from your feedback. Do let me know what you think.

Cheers

Copy link
Contributor

github-actions bot commented Mar 5, 2025

Lighthouse Results

URL Performance Accessibility Best Practices SEO Report
/en 🟢 100 🟢 100 🟢 100 🟢 91 🔗
/en/about 🟢 100 🟢 100 🟢 100 🟢 91 🔗
/en/about/previous-releases 🟢 99 🟢 100 🟢 100 🟢 92 🔗
/en/download 🟢 90 🟢 100 🟢 100 🟢 91 🔗
/en/blog 🟢 100 🟢 100 🟢 96 🟢 92 🔗

Copy link
Contributor

github-actions bot commented Mar 5, 2025

Unit Test Coverage Report

Lines Statements Branches Functions
Coverage: 90%
88.75% (742/836) 76.1% (242/318) 87.65% (142/162)

Unit Test Report

Tests Skipped Failures Errors Time
182 0 💤 0 ❌ 0 🔥 5.864s ⏱️

@RafaelGSS RafaelGSS added this pull request to the merge queue Mar 5, 2025
Merged via the queue into nodejs:main with commit f33bf00 Mar 5, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants