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.

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

refactor(nuxt): replace Nuxt payload's error type with NuxtError #25398

Merged
merged 10 commits into from Jan 28, 2024
Merged

refactor(nuxt): replace Nuxt payload's error type with NuxtError #25398

merged 10 commits into from Jan 28, 2024

Conversation

DamianGlowala
Copy link
Member

@DamianGlowala DamianGlowala commented Jan 23, 2024 •
edited

🔗 Linked issue

❓ 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

Enforces a NuxtError type on the NuxtPayload's error property for consistency.

📝 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 Jan 23, 2024
@stackblitz StackBlitz
Copy link

stackblitz bot commented Jan 23, 2024

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

danielroe
danielroe reviewed Jan 25, 2024
View reviewed changes
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.

Looks great! We should also update the error handling docs where we describe the prop type in error.vue.

@nuxt-studio Nuxt Studio
Copy link

nuxt-studio bot commented Jan 25, 2024

✅ Live Preview ready!

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

@DamianGlowala
Copy link
Member Author

Added! As the nuxt-error-page.vue isn't using TypeScript, we probably need to leave it as it is:

nuxt/packages/nuxt/src/app/components/nuxt-error-page.vue

Line 9 in a995f72

error: Object

@danielroe danielroe merged commit 9eb0d21 into main Jan 28, 2024
35 of 36 checks passed
@danielroe danielroe deleted the refactor/nuxt-payload-error branch January 28, 2024 20:50
@github-actions github-actions bot mentioned this pull request Jan 28, 2024
Merged
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

Assignees

@DamianGlowala DamianGlowala

Labels
3.x
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@DamianGlowala @danielroe