Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat(useWebsocket): support ref or getter as message #4116

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

Merged
merged 6 commits into from
Dec 22, 2024

Conversation

SnowGuest
Copy link
Contributor

@SnowGuest SnowGuest commented Jul 25, 2024

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

This PR allows the heartbeat message to pass in a function and execute the function. Heartbeat in some scenarios may have different values, so I have extended it to allow a function to be passed in to support more custom behaviors.

Additional context

@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. enhancement New feature or request labels Jul 25, 2024
@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. and removed size:XS This PR changes 0-9 lines, ignoring generated files. labels Jul 25, 2024
@@ -25,12 +27,12 @@ export interface UseWebSocketOptions {
*
* @default 'ping'
*/
message?: string | ArrayBuffer | Blob
message?: WebSocketHeartbeatMessage | (() => WebSocketHeartbeatMessage)
Copy link
Collaborator

Choose a reason for hiding this comment

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

you should consider MaybeRefOrGetter<WebSocketHeartbeatMessage>

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm sorry. I'll check this out function😢

@antfu antfu changed the title feat:Support incoming functions for Heartbeat Message of useWebsocket feat(useWebsocket): support ref or getter as message Dec 22, 2024
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Dec 22, 2024
@antfu antfu enabled auto-merge December 22, 2024 04:12
@antfu antfu disabled auto-merge December 22, 2024 04:23
@antfu antfu merged commit a72c02e into vueuse:main Dec 22, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants