feat(types): expose RouterLinkProps typed

posva · Apr 27, 2023 · 04031b4 · 04031b4
1 parent f0fcc07
commit 04031b4
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/src/codegen/generateDTS.ts b/src/codegen/generateDTS.ts
@@ -34,6 +34,7 @@ import type {
   // vue-router extensions
   _RouterTyped,
   RouterLinkTyped,
+  RouterLinkPropsTyped,
   NavigationGuard,
   UseLinkFnTyped,
 
@@ -100,6 +101,7 @@ declare module '${vueRouterModule}' {
   export function onBeforeRouteUpdate(guard: NavigationGuard<RouteNamedMap>): void
 
   export const RouterLink: RouterLinkTyped<RouteNamedMap>
+  export const RouterLinkProps: RouterLinkPropsTyped<RouteNamedMap>
 
   // Experimental Data Fetching
 

diff --git a/src/typeExtensions/RouterLink.ts b/src/typeExtensions/RouterLink.ts
@@ -26,11 +26,10 @@ import type {
   RouteLocationResolvedTypedList,
 } from './routeLocation'
 
-// TODO: rename to RouterLinkPropsTyped and re export from typed-router.d.ts as RouterLinkProps
 /**
  * Typed version of `RouterLinkProps`.
  */
-export interface RouterLinkProps<
+export interface RouterLinkPropsTyped<
   RouteMap extends _RouteMapGeneric,
   Name extends keyof RouteMap = keyof RouteMap
 > extends Omit<_RouterLinkProps, 'to'> {
@@ -48,7 +47,7 @@ export interface RouterLinkTyped<RouteMap extends _RouteMapGeneric> {
     $props: AllowedComponentProps &
       ComponentCustomProps &
       VNodeProps &
-      RouterLinkProps<RouteMap>
+      RouterLinkPropsTyped<RouteMap>
 
     $slots: {
       default: (arg: UnwrapRef<_UseLinkReturnTyped<RouteMap>>) => VNode[]

diff --git a/src/types.ts b/src/types.ts
@@ -32,6 +32,7 @@ export type {
   RouterLinkTyped,
   UseLinkFnTyped,
   _UseLinkReturnTyped,
+  RouterLinkPropsTyped,
 } from './typeExtensions/RouterLink'
 export type {
   ParamValue,