Skip to content
Open
Show file tree
Hide file tree
Changes from 3 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
8 changes: 4 additions & 4 deletions docs/.vitepress/twoslash-files.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,28 @@ declare module 'vue-router/auto-routes' {
'/',
Record<never, never>,
Record<never, never>,
never
| never
>
'/users': RouteRecordInfo<
'/users',
'/users',
Record<never, never>,
Record<never, never>,
never
| never
>
'/users/[id]': RouteRecordInfo<
'/users/[id]',
'/users/:id',
{ id: ParamValue<true> },
{ id: ParamValue<false> },
'/users/[id]/edit'
| '/users/[id]/edit'
>
'/users/[id]/edit': RouteRecordInfo<
'/users/[id]/edit',
'/users/:id/edit',
{ id: ParamValue<true> },
{ id: ParamValue<false> },
never
| never
>
}
}
Expand Down
10 changes: 6 additions & 4 deletions docs/.vitepress/twoslash/code/typed-router.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
/* prettier-ignore */

declare module 'vue-router/auto-routes' {
import type {
RouteRecordInfo,
Expand All @@ -13,28 +15,28 @@ declare module 'vue-router/auto-routes' {
'/',
Record<never, never>,
Record<never, never>,
never
| never
>
'/users': RouteRecordInfo<
'/users',
'/users',
Record<never, never>,
Record<never, never>,
never
| never
>
'/users/[id]': RouteRecordInfo<
'/users/[id]',
'/users/:id',
{ id: ParamValue<true> },
{ id: ParamValue<false> },
'/users/[id]/edit'
| '/users/[id]/edit'
>
'/users/[id]/edit': RouteRecordInfo<
'/users/[id]/edit',
'/users/:id/edit',
{ id: ParamValue<true> },
{ id: ParamValue<false> },
never
| never
>
}
}
4 changes: 2 additions & 2 deletions docs/guide/typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,14 @@ declare module 'vue-router/auto-routes' {
{ path: ParamValue<false> },
// this is a union of all children route names
// if the route does not have nested routes, pass `never` or omit this generic entirely
'custom-dynamic-child-name'
| 'custom-dynamic-child-name'
>
'custom-dynamic-child-name': RouteRecordInfo<
'custom-dynamic-child-name',
'/added-during-runtime/[...path]/child',
{ path: ParamValue<true> },
{ path: ParamValue<false> },
never
| never
>
}
}
Expand Down
6 changes: 3 additions & 3 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,21 +120,21 @@ declare module 'vue-router/auto-routes' {
'/',
Record<never, never>,
Record<never, never>,
never
| never
>
'/about': RouteRecordInfo<
'/about',
'/about',
Record<never, never>,
Record<never, never>,
never
| never
>
'/users/[id]': RouteRecordInfo<
'/users/[id]',
'/users/:id',
{ id: ParamValue<true> },
{ id: ParamValue<false> },
never
| never
>
}
}
Expand Down
6 changes: 4 additions & 2 deletions playground/src/router.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ if (import.meta.hot) {
addRedirects()
}

/* prettier-ignore */

// manual extension of route types
declare module 'vue-router/auto-routes' {
export interface RouteNamedMap {
Expand All @@ -32,14 +34,14 @@ declare module 'vue-router/auto-routes' {
'/added-during-runtime/[...path]',
{ path: ParamValue<true> },
{ path: ParamValue<false> },
'custom-dynamic-child-name'
| 'custom-dynamic-child-name'
>
'custom-dynamic-child-name': RouteRecordInfo<
'custom-dynamic-child-name',
'/added-during-runtime/[...path]/child',
{ path: ParamValue<true> },
{ path: ParamValue<false> },
never
| never
>
}
}
Loading
Loading