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

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/create-route-map.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.

`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

)
}
}

const pathToRegexpOptions: PathToRegexpOptions =
Expand Down
9 changes: 9 additions & 0 deletions test/unit/specs/create-map.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,15 @@ describe('Creating Route Map', function () {
expect(console.warn.calls.argsFor(0)[0]).toEqual('[vue-router] Non-nested routes must include a leading slash character. Fix the following routes: \n- bar')
})

it('in development, warn if a component is a promise', function () {
process.env.NODE_ENV = 'development'
expect(() => {
maps = createRouteMap([
{ path: 'bar', name: 'bar', component: Promise.resolve(Bar) }
])
}).toThrow(new Error(`[vue-router] Component "bar" in record with path "bar" is a Promise instead of a function that returns a Promise. Did you write "import('./MyPage.vue')" instead of "() => import('./MyPage.vue')"?`))
})

it('in development, it does not log the missing leading slash when routes are valid', function () {
process.env.NODE_ENV = 'development'
maps = createRouteMap([
Expand Down