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

feat(watchOnce): return function for manual watcher stopping #3475

Merged
merged 1 commit into from Nov 9, 2023

Conversation

valerypatorius
Copy link
Contributor

@valerypatorius valerypatorius commented Oct 15, 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

All watchers are expected to return WatchStopHandle functions, which allow to stop these watchers manually. watchOnce was the only watcher, that could not be stopped manually. Now it can.

Additional context

Although the case, when watchOnce should be stopped manually before it'll be triggered, is rare, it is better to be consistent and provide the ability to perform cleanup.


🤖 Generated by Copilot at bf72035

Return WatchStopHandle from watchOnce function. This allows users to stop the watcher manually and aligns the function with other watch utilities in vueuse.

🤖 Generated by Copilot at bf72035

  • Return WatchStopHandle from watchOnce function to allow manual stopping and align with watch signature (link, link, link)

@antfu antfu added this pull request to the merge queue Nov 9, 2023
Merged via the queue into vueuse:main with commit bb0a78e Nov 9, 2023
5 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.

None yet

2 participants