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

better error message when component is a promise (fix #3167) #3174

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from

Conversation

SimonSiefke
Copy link

@SimonSiefke SimonSiefke commented Apr 16, 2020

Closes #3167

Copy link
Member

@posva posva left a comment

Choose a reason for hiding this comment

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

I think this could help a few people, could you align with the message on vue-router-next (https://github.com/vuejs/vue-router-next/blob/master/src/navigationGuards.ts#L173) and add a unit test please?

Copy link
Member

@posva posva left a comment

Choose a reason for hiding this comment

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

There is still a need to check for components option. I think it makes more sense to check for this when trying to fetch the component like it's done at https://github.com/vuejs/vue-router-next/blob/master/src/navigationGuards.ts

if (route.component && route.component.toString) {
assert(
route.component.toString() !== '[object Promise]',
`Component "${String(name)}" in record with path "${path}" is a Promise instead of a function that returns a Promise. Did you write "import('./MyPage.vue')" instead of "() => import('./MyPage.vue')"?`
Copy link
Member

Choose a reason for hiding this comment

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

The name here is the name of the route, not the name of the view (eg default) like at https://github.com/vuejs/vue-router-next/blob/master/src/navigationGuards.ts#L168

@@ -70,6 +70,12 @@ function addRouteRecord (
path || name
)} cannot be a ` + `string id. Use an actual component instead.`
)
if (route.component && route.component.toString) {
assert(
route.component.toString() !== '[object Promise]',
Copy link
Member

Choose a reason for hiding this comment

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

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.

Better error message Component type is invalid
2 participants