5
5
// It's recommended to commit this file.
6
6
// Make sure to add this file to your tsconfig.json file as an "includes" or "files" entry.
7
7
8
- /// <reference types="unplugin-vue-router/client" />
9
-
10
- import type {
11
- // type safe route locations
12
- RouteLocationTypedList ,
13
- RouteLocationResolvedTypedList ,
14
- RouteLocationNormalizedTypedList ,
15
- RouteLocationNormalizedLoadedTypedList ,
16
- RouteLocationAsString ,
17
- RouteLocationAsRelativeTypedList ,
18
- RouteLocationAsPathTypedList ,
19
-
20
- // helper types
21
- // route definitions
22
- RouteRecordInfo ,
23
- ParamValue ,
24
- ParamValueOneOrMore ,
25
- ParamValueZeroOrMore ,
26
- ParamValueZeroOrOne ,
27
-
28
- // vue-router extensions
29
- _RouterTyped ,
30
- RouterLinkTyped ,
31
- RouterLinkPropsTyped ,
32
- NavigationGuard ,
33
- UseLinkFnTyped ,
34
-
35
- // data fetching
36
- _DataLoader ,
37
- _DefineLoaderOptions ,
38
- } from 'unplugin-vue-router/types'
39
-
40
8
declare module 'vue-router/auto-routes' {
9
+ import type {
10
+ RouteRecordInfo ,
11
+ ParamValue ,
12
+ ParamValueOneOrMore ,
13
+ ParamValueZeroOrMore ,
14
+ ParamValueZeroOrOne ,
15
+ } from 'unplugin-vue-router/types'
16
+
17
+ /**
18
+ * Route name map generated by unplugin-vue-router
19
+ */
41
20
export interface RouteNamedMap {
42
21
'/' : RouteRecordInfo < '/' , '/' , Record < never , never > , Record < never , never > > ,
43
22
'/[...all]' : RouteRecordInfo < '/[...all]' , '/:all(.*)' , { all : ParamValue < true > } , { all : ParamValue < false > } > ,
@@ -64,105 +43,19 @@ declare module 'vue-router/auto-routes' {
64
43
'/dashboard/settings/services' : RouteRecordInfo < '/dashboard/settings/services' , '/dashboard/settings/services' , Record < never , never > , Record < never , never > > ,
65
44
'/dashboard/settings/storage' : RouteRecordInfo < '/dashboard/settings/storage' , '/dashboard/settings/storage' , Record < never , never > , Record < never , never > > ,
66
45
'/dashboard/teams/[id]' : RouteRecordInfo < '/dashboard/teams/[id]' , '/dashboard/teams/:id' , { id : ParamValue < true > } , { id : ParamValue < false > } > ,
46
+ '/errors/400' : RouteRecordInfo < '/errors/400' , '/errors/400' , Record < never , never > , Record < never , never > > ,
47
+ '/errors/403' : RouteRecordInfo < '/errors/403' , '/errors/403' , Record < never , never > , Record < never , never > > ,
48
+ '/errors/404' : RouteRecordInfo < '/errors/404' , '/errors/404' , Record < never , never > , Record < never , never > > ,
49
+ '/errors/405' : RouteRecordInfo < '/errors/405' , '/errors/405' , Record < never , never > , Record < never , never > > ,
50
+ '/errors/414' : RouteRecordInfo < '/errors/414' , '/errors/414' , Record < never , never > , Record < never , never > > ,
51
+ '/errors/416' : RouteRecordInfo < '/errors/416' , '/errors/416' , Record < never , never > , Record < never , never > > ,
52
+ '/errors/500' : RouteRecordInfo < '/errors/500' , '/errors/500' , Record < never , never > , Record < never , never > > ,
53
+ '/errors/501' : RouteRecordInfo < '/errors/501' , '/errors/501' , Record < never , never > , Record < never , never > > ,
54
+ '/errors/502' : RouteRecordInfo < '/errors/502' , '/errors/502' , Record < never , never > , Record < never , never > > ,
55
+ '/errors/503' : RouteRecordInfo < '/errors/503' , '/errors/503' , Record < never , never > , Record < never , never > > ,
56
+ '/errors/504' : RouteRecordInfo < '/errors/504' , '/errors/504' , Record < never , never > , Record < never , never > > ,
67
57
'/hello-world/[name]' : RouteRecordInfo < '/hello-world/[name]' , '/hello-world/:name' , { name : ParamValue < true > } , { name : ParamValue < false > } > ,
68
58
'/README' : RouteRecordInfo < '/README' , '/README' , Record < never , never > , Record < never , never > > ,
69
59
'/system-tray/' : RouteRecordInfo < '/system-tray/' , '/system-tray' , Record < never , never > , Record < never , never > > ,
70
60
}
71
61
}
72
-
73
- declare module 'vue-router/auto' {
74
- import type { RouteNamedMap } from 'vue-router/auto-routes'
75
-
76
- export type RouterTyped = _RouterTyped < RouteNamedMap >
77
-
78
- /**
79
- * Type safe version of `RouteLocationNormalized` (the type of `to` and `from` in navigation guards).
80
- * Allows passing the name of the route to be passed as a generic.
81
- */
82
- export type RouteLocationNormalized < Name extends keyof RouteNamedMap = keyof RouteNamedMap > = RouteLocationNormalizedTypedList < RouteNamedMap > [ Name ]
83
-
84
- /**
85
- * Type safe version of `RouteLocationNormalizedLoaded` (the return type of `useRoute()`).
86
- * Allows passing the name of the route to be passed as a generic.
87
- */
88
- export type RouteLocationNormalizedLoaded < Name extends keyof RouteNamedMap = keyof RouteNamedMap > = RouteLocationNormalizedLoadedTypedList < RouteNamedMap > [ Name ]
89
-
90
- /**
91
- * Type safe version of `RouteLocationResolved` (the returned route of `router.resolve()`).
92
- * Allows passing the name of the route to be passed as a generic.
93
- */
94
- export type RouteLocationResolved < Name extends keyof RouteNamedMap = keyof RouteNamedMap > = RouteLocationResolvedTypedList < RouteNamedMap > [ Name ]
95
-
96
- /**
97
- * Type safe version of `RouteLocation` . Allows passing the name of the route to be passed as a generic.
98
- */
99
- export type RouteLocation < Name extends keyof RouteNamedMap = keyof RouteNamedMap > = RouteLocationTypedList < RouteNamedMap > [ Name ]
100
-
101
- /**
102
- * Type safe version of `RouteLocationRaw` . Allows passing the name of the route to be passed as a generic.
103
- */
104
- export type RouteLocationRaw < Name extends keyof RouteNamedMap = keyof RouteNamedMap > =
105
- | RouteLocationAsString < RouteNamedMap >
106
- | RouteLocationAsRelativeTypedList < RouteNamedMap > [ Name ]
107
- | RouteLocationAsPathTypedList < RouteNamedMap > [ Name ]
108
-
109
- /**
110
- * Generate a type safe params for a route location. Requires the name of the route to be passed as a generic.
111
- */
112
- export type RouteParams < Name extends keyof RouteNamedMap > = RouteNamedMap [ Name ] [ 'params' ]
113
- /**
114
- * Generate a type safe raw params for a route location. Requires the name of the route to be passed as a generic.
115
- */
116
- export type RouteParamsRaw < Name extends keyof RouteNamedMap > = RouteNamedMap [ Name ] [ 'paramsRaw' ]
117
-
118
- export function useRouter ( ) : RouterTyped
119
- export function useRoute < Name extends keyof RouteNamedMap = keyof RouteNamedMap > ( name ?: Name ) : RouteLocationNormalizedLoadedTypedList < RouteNamedMap > [ Name ]
120
-
121
- export const useLink : UseLinkFnTyped < RouteNamedMap >
122
-
123
- export function onBeforeRouteLeave ( guard : NavigationGuard < RouteNamedMap > ) : void
124
- export function onBeforeRouteUpdate ( guard : NavigationGuard < RouteNamedMap > ) : void
125
-
126
- export const RouterLink : RouterLinkTyped < RouteNamedMap >
127
- export const RouterLinkProps : RouterLinkPropsTyped < RouteNamedMap >
128
-
129
- // Experimental Data Fetching
130
-
131
- export function defineLoader <
132
- P extends Promise < any > ,
133
- Name extends keyof RouteNamedMap = keyof RouteNamedMap ,
134
- isLazy extends boolean = false ,
135
- > (
136
- name : Name ,
137
- loader : ( route : RouteLocationNormalizedLoaded < Name > ) => P ,
138
- options ?: _DefineLoaderOptions < isLazy > ,
139
- ) : _DataLoader < Awaited < P > , isLazy >
140
- export function defineLoader <
141
- P extends Promise < any > ,
142
- isLazy extends boolean = false ,
143
- > (
144
- loader : ( route : RouteLocationNormalizedLoaded ) => P ,
145
- options ?: _DefineLoaderOptions < isLazy > ,
146
- ) : _DataLoader < Awaited < P > , isLazy >
147
-
148
- export {
149
- _definePage as definePage ,
150
- _HasDataLoaderMeta as HasDataLoaderMeta ,
151
- _setupDataFetchingGuard as setupDataFetchingGuard ,
152
- _stopDataFetchingScope as stopDataFetchingScope ,
153
- } from 'unplugin-vue-router/runtime'
154
- }
155
-
156
- declare module 'vue-router' {
157
- import type { RouteNamedMap } from 'vue-router/auto-routes'
158
-
159
- export interface TypesConfig {
160
- beforeRouteUpdate : NavigationGuard < RouteNamedMap >
161
- beforeRouteLeave : NavigationGuard < RouteNamedMap >
162
-
163
- $route : RouteLocationNormalizedLoadedTypedList < RouteNamedMap > [ keyof RouteNamedMap ]
164
- $router : _RouterTyped < RouteNamedMap >
165
-
166
- RouterLink : RouterLinkTyped < RouteNamedMap >
167
- }
168
- }
0 commit comments