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: remove return type of promise from refresh and execute. #25568

Merged
merged 1 commit into from Feb 2, 2024

Conversation

tdekoning
Copy link
Contributor

πŸ”— Linked issue

#25558

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

The TypeScript definition didn't match the implementation. The promise chain of useAsyncData does not return a value, but updates the returned Ref values.

This solves the problem that developers expect these functions to return data.

Resolves #25558

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.

Copy link

stackblitz bot commented Feb 1, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link
Member

@danielroe danielroe left a comment

Choose a reason for hiding this comment

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

We could also consider returning the data.

@manniL
Copy link
Member

manniL commented Feb 1, 2024

@danielroe Do you think that'd be beneficial or rather result in misuse of e.g. useFetch? πŸ€”

@danielroe
Copy link
Member

The name definitely suggests not returning the data so I think probably better to merge as is.

@manniL
Copy link
Member

manniL commented Feb 2, 2024

@tdekoning could you also update the types in the docs?

@tdekoning
Copy link
Contributor Author

@manniL you mean here ? They already seem to be properly typed.

@manniL
Copy link
Member

manniL commented Feb 2, 2024

Ah, perfect! Already strange that they were out of sync then! Thanks for checking πŸ‘

@danielroe danielroe merged commit be7d430 into nuxt:main Feb 2, 2024
35 checks passed
@github-actions github-actions bot mentioned this pull request Feb 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Type-definition of refresh and execute method of useAsyncData incorrect
3 participants