Skip to content

Commit fd49bbd

Browse files
committed
docs(types): add notes about breaking typis
Close #264
1 parent 40cbc49 commit fd49bbd

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,16 @@ Check the [playground](https://github.com/vuejs/vue-router-next/tree/master/play
4040
})
4141
```
4242

43+
### Typings
44+
45+
To make typings more consistent and expressive, some types have been renamed. Keep in mind these can change until stable release to ensure consistency. Some types might have changed as well.
46+
47+
| `vue-router@3` | `vue-router@4` |
48+
| -------------- | ----------------------- |
49+
| RouteConfig | RouteRecordRaw |
50+
| Location | RouteLocation |
51+
| Route | RouteLocationNormalized |
52+
4353
#### Improvements
4454

4555
These are technically breaking changes but they fix an inconsistent behavior.

0 commit comments

Comments
 (0)