docs: more ts doc

src/RouterLink.ts

@@ -188,6 +188,9 @@ export const RouterLinkImpl = defineComponent({
 
 // export the public type for h/tsx inference
 // also to avoid inline import() in generated d.ts files
+/**
+ * Component to render a link that triggers a navigation on click.
+ */
 export const RouterLink = (RouterLinkImpl as any) as {
   new (): {
     $props: AllowedComponentProps &

src/RouterView.ts

@@ -142,6 +142,9 @@ export const RouterViewImpl = defineComponent({
 
 // export the public type for h/tsx inference
 // also to avoid inline import() in generated d.ts files
+/**
+ * Component to display the current route the user is at.
+ */
 export const RouterView = (RouterViewImpl as any) as {
   new (): {
     $props: AllowedComponentProps &

src/errors.ts

@@ -24,11 +24,7 @@ const NavigationFailureSymbol = PolySymbol(
   __DEV__ ? 'navigation failure' : 'nf'
 )
 
-interface RouterErrorBase extends Error {
-  type: ErrorTypes
-}
-
-export interface MatcherError extends RouterErrorBase {
+export interface MatcherError extends Error {
   type: ErrorTypes.MATCHER_NOT_FOUND
   location: MatcherLocationRaw
   currentLocation?: MatcherLocation
@@ -59,7 +55,7 @@ export enum NavigationFailureType {
 /**
  * Extended Error that contains extra information regarding a failed navigation.
  */
-export interface NavigationFailure extends RouterErrorBase {
+export interface NavigationFailure extends Error {
   /**
    * Type of the navigation. One of {@link NavigationFailureType}
    */

src/history/html5.ts

@@ -32,7 +32,7 @@ interface StateEntry extends HistoryState {
 
 /**
  * Creates a normalized history location from a window.location object
- * @param location
+ * @param location -
  */
 function createCurrentLocation(
   base: string,
@@ -274,7 +274,7 @@ function useHistoryStateNavigation(base: string) {
 /**
  * Creates an HTML5 history. Most common history for single page applications.
  *
- * @param base
+ * @param base -
  */
 export function createWebHistory(base?: string): RouterHistory {
   base = normalizeBase(base)

src/index.ts

@@ -57,3 +57,9 @@ export { RouterView, RouterViewProps } from './RouterView'
 export * from './useApi'
 
 export * from './globalExtensions'
+
+/**
+ * The official Router for Vue 3.
+ *
+ * @packageDocumentation
+ */

src/matcher/types.ts

@@ -41,7 +41,7 @@ export interface RouteRecordNormalized {
    */
   props: Record<string, _RouteRecordProps>
   /**
-   * {@inheritDoc _RouteRecordBase.props}
+   * Registered beforeEnter guards
    */
   beforeEnter: RouteRecordMultipleViews['beforeEnter']
   /**

src/query.ts

@@ -36,6 +36,8 @@ export type LocationQueryRaw = Record<
 /**
  * Transforms a queryString into a {@link LocationQuery} object. Accept both, a
  * version with the leading `?` and without Should work as URLSearchParams
+
+ * @internal
  *
  * @param search - search string to parse
  * @returns a query object
@@ -73,6 +75,8 @@ export function parseQuery(search: string): LocationQuery {
  * Stringifies a {@link LocationQueryRaw} object. Like `URLSearchParams`, it
  * doesn't prepend a `?`
  *
+ * @internal
+ *
  * @param query - query object to stringify
  * @returns string version of the query without the leading `?`
  */

src/router.ts

@@ -84,6 +84,9 @@ export interface RouterScrollBehavior {
   ): Awaitable<ScrollPosition | false | void>
 }
 
+/**
+ * Options to initialize a {@link Router} instance.
+ */
 export interface RouterOptions extends PathParserOptions {
   /**
    * History implementation used by the router. Most web applications should use
@@ -158,6 +161,9 @@ export interface RouterOptions extends PathParserOptions {
   // linkInactiveClass?: string
 }
 
+/**
+ * Router instance
+ */
 export interface Router {
   /**
    * @internal

src/types/index.ts

@@ -220,6 +220,9 @@ export interface _RouteRecordBase extends PathParserOptions {
   meta?: RouteMeta
 }
 
+/**
+ * Interface to type `meta` fields in route records.
+ */
 export interface RouteMeta extends Record<string | number | symbol, any> {}
 
 export type RouteRecordRedirectOption =

src/useApi.ts

@@ -3,10 +3,18 @@ import { routerKey, routeLocationKey } from './injectionSymbols'
 import { Router } from './router'
 import { RouteLocationNormalizedLoaded } from './types'
 
+/**
+ * Returns the router instance. Equivalent to using `$router` inside
+ * templates.
+ */
 export function useRouter(): Router {
   return inject(routerKey)!
 }
 
+/**
+ * Returns the current route location. Equivalent to using `$route` inside
+ * templates.
+ */
 export function useRoute(): RouteLocationNormalizedLoaded {
   return inject(routeLocationKey)!
 }