Skip to content

Commit a610068

Browse files
committed
Fix links in doc and add Route type
1 parent 5717225 commit a610068

File tree

6 files changed

+51
-17
lines changed

6 files changed

+51
-17
lines changed

docs/en/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,5 @@
3737
- [beforeRouteEnter](api/beforeRouteEnter.md)
3838
- [beforeRouteLeave](api/beforeRouteLeave.md)
3939
- [beforeEnter](api/beforeEnter.md)
40+
- [Types](api/types/README.md)
41+
- [Route](api/types/route.md)

docs/en/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,5 @@
3333
- [beforeRouteEnter](api/beforeRouteEnter.md)
3434
- [beforeRouteLeave](api/beforeRouteLeave.md)
3535
- [beforeEnter](api/beforeEnter.md)
36+
- [Types](api/types/README.md)
37+
- [Route](api/types/route.md)

docs/en/api/README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
# API Reference
22

3-
- [VueRouter](api/router/README.md)
4-
- [constructor](api/router/constructor.md)
5-
- [currentRoute](api/router/current-route.md)
6-
- [beforeEach](api/router/before-each.md)
7-
- [afterEach](api/router/after-each.md)
8-
- [push](api/router/push.md)
9-
- [replace](api/router/replace.md)
10-
- [go](api/router/go.md)
11-
- [back](api/router/back.md)
12-
- [forward](api/router/back.md)
13-
- [getMatchedComponents](api/router/get-matched-components.md)
14-
- [$route](api/route.md)
15-
- [router-link](api/router-link.md)
16-
- [router-view](api/router-view.md)
17-
- [beforeRouteEnter](api/beforeRouteEnter.md)
18-
- [beforeRouteLeave](api/beforeRouteLeave.md)
19-
- [beforeEnter](api/beforeEnter.md)
3+
- [VueRouter](router/README.md)
4+
- [constructor](router/constructor.md)
5+
- [currentRoute](router/current-route.md)
6+
- [beforeEach](router/before-each.md)
7+
- [afterEach](router/after-each.md)
8+
- [push](router/push.md)
9+
- [replace](router/replace.md)
10+
- [go](router/go.md)
11+
- [back](router/back.md)
12+
- [forward](router/back.md)
13+
- [getMatchedComponents](router/get-matched-components.md)
14+
- [$route](route.md)
15+
- [router-link](router-link.md)
16+
- [router-view](router-view.md)
17+
- [beforeRouteEnter](beforeRouteEnter.md)
18+
- [beforeRouteLeave](beforeRouteLeave.md)
19+
- [beforeEnter](beforeEnter.md)
20+
- [Types](types/README.md)
21+
- [Route](types/route.md)

docs/en/api/router/current-route.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# `router.currentRoute()`
2+
3+
Get router's current route.
4+
5+
Returns a [Route](../types/route.md) or `undefined` is the router doesn't have
6+
an history yet.

docs/en/api/types/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Types
2+
3+
- [Route](route.md)

docs/en/api/types/route.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Route
2+
3+
The Route type defines a route manipulated by the router. This is different from [RouteConfig](route-config.md)
4+
5+
## Flow definition
6+
7+
``` flow
8+
declare type Route = {
9+
path: string;
10+
name: ?string;
11+
hash: string;
12+
query: StringHash;
13+
params: StringHash;
14+
fullPath: string;
15+
matched: Array<RouteRecord>;
16+
redirectedFrom?: string;
17+
meta?: any;
18+
}
19+
```

0 commit comments

Comments
 (0)