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

fix(useWebSocket): ssr support #3370

Merged
merged 1 commit into from Oct 7, 2023
Merged

Conversation

huangyan321
Copy link
Contributor

@huangyan321 huangyan321 commented Sep 3, 2023

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.


Description

Additional context


🤖 Generated by Copilot at a4bc9c6

Improved useWebSocket compatibility and code quality. Added guards for non-browser contexts and simplified event listener logic.

🤖 Generated by Copilot at a4bc9c6

  • Import isClient utility function to check for browser environment (link)
  • Guard close and open functions with isClient to prevent errors with WebSocket API in non-browser contexts (link, link)
  • Simplify useEventListener call to use default window target for beforeunload event (link)

@antfu antfu merged commit c3a69ee into vueuse:main Oct 7, 2023
5 checks passed
@hpeevmb
Copy link

hpeevmb commented Oct 11, 2023

Hello, I just experienced problems with those changes.
I use useWebSocket in a web worker.
When open() is called it does not initiate ws connection, because the worker is not identified as client (isClient is false).

What would be the correct way to use useWebSocket in a web worker?

@antfu
Copy link
Member

antfu commented Oct 11, 2023

@hpeevmb we could introduce a isWorker flag and add that condition to this function. PR welcome

@binary-signal
Copy link
Contributor

Hi @antfu, you can have a look at the PR #3469
credits to @hpeevmb

@hpeevmb we could introduce a isWorker flag and add that condition to this function. PR welcome

@laterdayi
Copy link

This PR causes the webWorker environment to fail to run

@hpeevmb
Copy link

hpeevmb commented Oct 31, 2023

@laterdayi , PR that addresses the issue is already submitted. Have a look at #3469

@laterdayi
Copy link

Yes, but the PR didn't merge, so now many projects can only roll back versions

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.

None yet

5 participants