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

Skip to content

feat(nuxt): add clear function to async data #26259

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
Merged
merged 9 commits into from
Mar 17, 2024
Merged

feat(nuxt): add clear function to async data #26259

merged 9 commits into from
Mar 17, 2024
+45 −17

Conversation

DamianGlowala
Copy link
Member

@DamianGlowala DamianGlowala commented Mar 14, 2024 •
edited by danielroe
Loading

🔗 Linked issue

resolves #26195

❓ 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

Allows clearing Nuxt data from within the async data composable (hence removing a need for knowing and/or passing a key). Original issue describes resetting Nuxt data instead (by respecting the optional default prop rather than always setting data.value to undefined). Thought this might be better to start with though; I'm open to any suggestions!

Will update the docs knowing this is a desirable addition.

📝 Checklist

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

@DamianGlowala DamianGlowala self-assigned this Mar 14, 2024
@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

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

@DamianGlowala DamianGlowala requested a review from danielroe March 15, 2024 00:06
@TheAlexLichter
Copy link
Member

Seems like a nice DX improvement to me 👍

With regards to clear (undefined) vs. reset (set to default value) - I was wondering if we need a distinction or could rely on resetting it to the default value straight away. But if that should be consistent, clearNuxtData should behave the same way, which would be tricky at the moment 🤔

@DamianGlowala
Copy link
Member Author

I certainly agree - this raises a question whether clearNuxtData should respect the default value. We have a couple of options:

  • make clearNuxtData respect the default value (I personally prefer this behavior; would be a breaking change though)
  • add reset function to async data which would differ from clear (setting it to the default value vs undefined)
  • add optional param to clear function which would allow either reverting to the default value or not (again, some could ask why we wouldn't have the same param for clearNuxtData)

@TheAlexLichter
Copy link
Member

I think both, clear and reset, might be confusing

Maybe updating it for v4 could be nice? 🤔

@DamianGlowala DamianGlowala mentioned this pull request Mar 15, 2024
Closed
4 tasks
@DamianGlowala
Copy link
Member Author

They will be confusing, I'm sure.

Created #26269 to discuss updating it for v4.

@nuxt-studio Nuxt Studio
Copy link
Contributor

nuxt-studio bot commented Mar 16, 2024

✅ Live Preview ready!

Name Edit Preview Latest Commit
Nuxt Docs Edit on Studio ↗︎ View Live Preview 4eeaac1

DamianGlowala
DamianGlowala commented Mar 16, 2024
View reviewed changes
@danielroe danielroe merged commit 02d6838 into main Mar 17, 2024
@danielroe danielroe deleted the feat/async-data-clear-fn branch March 17, 2024 00:19
This was referenced Mar 17, 2024
Closed
Merged
@wattanx wattanx mentioned this pull request May 19, 2024
Merged
7 tasks
@BalaKadiyala BalaKadiyala mentioned this pull request Jun 22, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danielroe danielroe danielroe approved these changes

@TheAlexLichter TheAlexLichter Awaiting requested review from TheAlexLichter

Assignees

@DamianGlowala DamianGlowala

Labels
3.x enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add reset fn to data fetching composables
3 participants
@DamianGlowala @TheAlexLichter @danielroe