🌐 AI搜索 & 代理 主页
Skip to content

fix(useAsyncState): ensure execute return the actual data #5167

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.

Sign up for GitHub

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

Jump to bottom
Open
9romise wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(useAsyncState): ensure execute return the actual data #5167

9romise wants to merge 1 commit into from

Conversation

@9romise
Copy link
Member

@9romise 9romise commented Nov 14, 2025

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

Close #5111

Additional context

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Nov 14, 2025
@9romise 9romise changed the title fix(useAsyncState): ensure execute return the actual data fix(useAsyncState)!: ensure execute return the actual data Nov 14, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented Nov 14, 2025

Open in StackBlitz

@vueuse/components

npm i https://pkg.pr.new/@vueuse/components@5167

@vueuse/core

npm i https://pkg.pr.new/@vueuse/core@5167

@vueuse/electron

npm i https://pkg.pr.new/@vueuse/electron@5167

@vueuse/firebase

npm i https://pkg.pr.new/@vueuse/firebase@5167

@vueuse/integrations

npm i https://pkg.pr.new/@vueuse/integrations@5167

@vueuse/math

npm i https://pkg.pr.new/@vueuse/math@5167

@vueuse/metadata

npm i https://pkg.pr.new/@vueuse/metadata@5167

@vueuse/nuxt

npm i https://pkg.pr.new/@vueuse/nuxt@5167

@vueuse/router

npm i https://pkg.pr.new/@vueuse/router@5167

@vueuse/rxjs

npm i https://pkg.pr.new/@vueuse/rxjs@5167

@vueuse/shared

npm i https://pkg.pr.new/@vueuse/shared@5167

commit: b064297

@codecov
Copy link

codecov bot commented Nov 14, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 63.95%. Comparing base (6f79ae1) to head (b064297).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #5167   +/-   ##
=======================================
  Coverage   63.95%   63.95%           
=======================================
  Files         343      343           
  Lines        7838     7838           
  Branches     2424     2412   -12     
=======================================
  Hits         5013     5013           
  Misses       2286     2286           
  Partials      539      539

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Nov 14, 2025
@l246804
Copy link

l246804 commented Nov 19, 2025

👍

@antfu
Copy link
Member

antfu commented Nov 27, 2025

I wonder if we could consider this as a fix rather than a breaking change

antfu
antfu reviewed Nov 27, 2025
View reviewed changes
packages/core/useAsyncState/index.ts
error: Ref<unknown>
execute: (delay?: number, ...args: Params) => Promise<Data>
executeImmediate: (...args: Params) => Promise<Data>
execute: (delay?: number, ...args: Params) => Promise<Data | undefined>
Copy link
Member

@antfu antfu Nov 27, 2025

Choose a reason for hiding this comment

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

Maybe we should alter the return data type based on throwError?

Copy link
Member Author

@9romise 9romise Dec 1, 2025

Choose a reason for hiding this comment

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

Even if throwError is set to false, the return value of execute can still be undefined, because in the error branch we don’t have a valid Data to return. Therefore, I think the return type cannot reliably be narrowed based on throwError.

@9romise
Copy link
Member Author

9romise commented Nov 27, 2025

I wonder if we could consider this as a fix rather than a breaking change

I agree. I've been on the fence about this too.

antfu
antfu reviewed Nov 27, 2025
View reviewed changes
packages/core/useAsyncState/index.ts
Comment on lines 64 to 70
/**
*
* An error is thrown when executing the execute function
*
* @default false
*/
throwError?: boolean
Copy link
Member

@antfu antfu Nov 27, 2025

Choose a reason for hiding this comment

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

Unrelated to this PR tho, but I wonder if we should consider reverting this default. Not throwing error for a manual execute function by default feels a bit conterintutive to me

Copy link

@l246804 l246804 Nov 27, 2025

Choose a reason for hiding this comment

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

Agree.

@9romise 9romise changed the title fix(useAsyncState)!: ensure execute return the actual data fix(useAsyncState): ensure execute return the actual data Nov 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@antfu antfu antfu approved these changes

@OrbisK OrbisK OrbisK approved these changes

+1 more reviewer

@l246804 l246804 l246804 left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

BUG | useAsyncState | execute() should directly return the resolved data of the current promise after execution

4 participants

@9romise @l246804 @antfu @OrbisK