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(useFetch): introduce updateDataOnError option #3092

Merged
merged 11 commits into from Aug 25, 2023

Conversation

climba03003
Copy link
Contributor

@climba03003 climba03003 commented May 12, 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

Revert the behavior introduced in #2711, since it is a breaking change. I don't mind the default changed to false in next release, but it shouldn't be v10.
Introduce new configuration allowFetchErrorReturnData to configure the behavior of onFetchError. If anyone don't like the data being replaced by this hook, just set it to false or return data as null.

Additional context


🤖 Generated by Copilot at a3bf42f

This pull request adds a new feature to the useFetch function, which enables the onFetchError hook to return data in case of a fetch error. It updates the UseFetchOptions interface, the useFetch and createFetch functions, and the corresponding tests and documentation in packages/core/useFetch.

🤖 Generated by Copilot at a3bf42f

  • Add a new feature to allow onFetchError hook to return data for useFetch function (link, link, link, link)
  • Update the documentation of useFetch to illustrate the new feature with a console.log statement (link)
  • Update the tests of useFetch and createFetch to check the new feature with expect statements and ctx.data assignments (link, link, link, link, link, link, link, link, link, link, link, link, link)

@stale
Copy link

stale bot commented Jul 16, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jul 16, 2023
@antfu antfu removed the stale label Jul 16, 2023
@antfu antfu changed the title feat(useFetch): allow return data on fetch error feat(useFetch): introduce updateDataOnFetchError option Aug 25, 2023
@antfu antfu changed the title feat(useFetch): introduce updateDataOnFetchError option feat(useFetch): introduce updateDataOnError option Aug 25, 2023
@antfu
Copy link
Member

antfu commented Aug 25, 2023

Made a few updates:

  • Renamed to updateDataOnError
  • Flip the default to false to avoid breaking changes
  • Update the doc descriptions

@antfu antfu enabled auto-merge August 25, 2023 16:53
@antfu antfu added this pull request to the merge queue Aug 25, 2023
Merged via the queue into vueuse:main with commit 945ca16 Aug 25, 2023
4 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

3 participants