chore: format comments

posva · posva · commit 74addd854bd3 · 2022-08-22T15:13:58.000+02:00
diff --git a/types/router.d.ts b/types/router.d.ts
@@ -52,9 +52,8 @@ export declare class VueRouter {
    */
   beforeEach(guard: NavigationGuard): () => void
   /**
-   * Add a navigation guard that executes before navigation is about to be
-   * resolved. At this state all component have been fetched and other
-   * navigation guards have been successful.
+   * Add a navigation guard that executes before navigation is about to be resolved. At this state all component have
+   * been fetched and other navigation guards have been successful.
    *
    * @param guard - navigation guard to add
    * @returns a function that removes the registered guard
@@ -68,8 +67,7 @@ export declare class VueRouter {
    */
   beforeResolve(guard: NavigationGuard): () => void
   /**
-   * Add a navigation hook that is executed after every navigation. Returns a
-   * function that removes the registered hook.
+   * Add a navigation hook that is executed after every navigation. Returns a function that removes the registered hook.
    *
    * @param hook - navigation hook to add
    * @returns a function that removes the registered guard
@@ -101,15 +99,13 @@ export declare class VueRouter {
     onAbort?: ErrorHandler
   ): void
   /**
-   * Programmatically navigate to a new URL by replacing the current entry in
-   * the history stack.
+   * Programmatically navigate to a new URL by replacing the current entry in the history stack.
    *
    * @param to Route location to navigate to
    */
   replace(to: RawLocation): Promise<Route>
   /**
-   * Programmatically navigate to a new URL by replacing the current entry in
-   * the history stack.
+   * Programmatically navigate to a new URL by replacing the current entry in the history stack.
    *
    * @param to Route location to navigate to
    * @param onComplete Navigation success callback
@@ -121,39 +117,35 @@ export declare class VueRouter {
     onAbort?: ErrorHandler
   ): void
   /**
-   * Allows you to move forward or backward through the history. Calls
-   * `history.go()`.
+   * Allows you to move forward or backward through the history. Calls `history.go()`.
    *
-   * @param delta The position in the history to which you want to move,
-   * relative to the current page
+   * @param delta The position in the history to which you want to move, relative to the current page
    */
   go(n: number): void
   /**
-   * Go back in history if possible by calling `history.back()`. Equivalent to
-   * `router.go(-1)`.
+   * Go back in history if possible by calling `history.back()`. Equivalent to `router.go(-1)`.
    */
   back(): void
   /**
-   * Go forward in history if possible by calling `history.forward()`.
-   * Equivalent to `router.go(1)`.
+   * Go forward in history if possible by calling `history.forward()`. Equivalent to `router.go(1)`.
    */
   forward(): void
   match (raw: RawLocation, current?: Route, redirectedFrom?: Location): Route
   getMatchedComponents(to?: RawLocation | Route): Component[]
   /**
-   * This method queues a callback to be called when the router has completed the initial navigation, which means it has resolved all async enter hooks and async components that are associated with the initial route.
+   * This method queues a callback to be called when the router has completed the initial navigation, which means it has
+   * resolved all async enter hooks and async components that are associated with the initial route.
    *
    * This is useful in server-side rendering to ensure consistent output on both the server and the client.
    * @param cb onReady callback.
-   * @param errorCb errorCb will be called when the initial route resolution runs into an error (e.g. failed to resolve an async component).
+   * @param errorCb errorCb will be called when the initial route resolution runs into an error (e.g. failed to resolve
+   * an async component).
    */
   onReady(cb: () => void, errorCb?: ErrorHandler): void
   /**
-   * Adds an error handler that is called every time a non caught error happens
-   * during navigation. This includes errors thrown synchronously and
-   * asynchronously, errors returned or passed to `next` in any navigation
-   * guard, and errors occurred when trying to resolve an async component that
-   * is required to render a route.
+   * Adds an error handler that is called every time a non caught error happens during navigation. This includes errors
+   * thrown synchronously and asynchronously, errors returned or passed to `next` in any navigation guard, and errors
+   * occurred when trying to resolve an async component that is required to render a route.
    *
    * @param handler - error handler to register
    */
@@ -163,14 +155,16 @@ export declare class VueRouter {
    */
   addRoutes(routes: RouteConfig[]): void
   /**
-   * Add a new {@link RouteConfig | route record} as the child of an existing route. If the route has a `name` and there is already an existing one with the same one, it overwrites it.
+   * Add a new {@link RouteConfig | route record} as the child of an existing route. If the route has a `name` and there
+   * is already an existing one with the same one, it overwrites it.
    *
    * @param parentName - Parent Route Record where `route` should be appended at
    * @param route - Route Record to add
    */
   addRoute(parentName: string, route: RouteConfig): void
   /**
-   * Add a new {@link RouteConfig | route} to the router. If the route has a `name` and there is already an existing one with the same one, it overwrites it.
+   * Add a new {@link RouteConfig | route} to the router. If the route has a `name` and there is already an existing one
+   * with the same one, it overwrites it.
    * @param route - Route Record to add
    */
   addRoute(route: RouteConfig): void
@@ -227,18 +221,18 @@ export enum NavigationFailureType {
    */
   redirected = 2,
   /**
-   * An aborted navigation is a navigation that failed because a navigation
-   * guard returned `false` or called `next(false)`
+   * An aborted navigation is a navigation that failed because a navigation guard returned `false` or called
+   * `next(false)`
    */
   aborted = 4,
   /**
-   * A cancelled navigation is a navigation that failed because a more recent
-   * navigation finished started (not necessarily finished).
+   * A cancelled navigation is a navigation that failed because a more recent navigation finished started (not
+   * necessarily finished).
    */
   cancelled = 8,
   /**
-   * A duplicated navigation is a navigation that failed because it was
-   * initiated while already being at the exact same location.
+   * A duplicated navigation is a navigation that failed because it was initiated while already being at the exact same
+   * location.
    */
   duplicated = 16
 }
@@ -281,9 +275,11 @@ export interface RouterOptions {
    * default: `"hash"` (in browser) | `"abstract"` (in Node.js)
    *
    * available values: `"hash" | "history" | "abstract"`
-   * - `"hash"`: uses the URL hash for routing. Works in all Vue-supported browsers, including those that do not support HTML5 History API.
+   * - `"hash"`: uses the URL hash for routing. Works in all Vue-supported browsers, including those that do not support
+   *   HTML5 History API.
    * - `"history"`: requires HTML5 History API and server config. See HTML5 History Mode.
-   * - `"abstract"`: works in all JavaScript environments, e.g. server-side with Node.js. **The router will automatically be forced into this mode if no browser API is present.**
+   * - `"abstract"`: works in all JavaScript environments, e.g. server-side with Node.js. **The router will
+   *   automatically be forced into this mode if no browser API is present.**
    */
   mode?: RouterMode
   fallback?: boolean
@@ -293,15 +289,17 @@ export interface RouterOptions {
    */
   linkActiveClass?: string
   /**
-   * Default class applied to active {@link RouterLink}. If none is provided, `router-link-exact-active` will be applied.
+   * Default class applied to active {@link RouterLink}. If none is provided, `router-link-exact-active` will be
+   * applied.
    */
   linkExactActiveClass?: string
   /**
    * Custom implementation to parse a query. See its counterpart, {@link stringifyQuery}.
    */
   parseQuery?: (query: string) => Object
   /**
-   * Custom implementation to stringify a query object. Should not prepend a leading `?`. {@link parseQuery} counterpart to handle query parsing.
+   * Custom implementation to stringify a query object. Should not prepend a leading `?`. {@link parseQuery} counterpart
+   * to handle query parsing.
    */
   stringifyQuery?: (query: Object) => string
   /**
@@ -416,35 +414,42 @@ export interface RouteMeta extends Record<string | number | symbol, any> {}
 
 export interface RouterLinkProps {
   /**
-   * Denotes the target route of the link. When clicked, the value of the `to` prop will be passed to `router.push()` internally, so the value can be either a string or a location descriptor object.
+   * Denotes the target route of the link. When clicked, the value of the `to` prop will be passed to `router.push()`
+   * internally, so the value can be either a string or a location descriptor object.
    */
   to: string | Location
   /**
-   * Setting `replace` prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will not leave a history record.
+   * Setting `replace` prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will
+   * not leave a history record.
    *
    * @default false
    */
   replace?: boolean
   /**
-   * Setting `append` prop always appends the relative path to the current path. For example, assuming we are navigating from `/a` to a relative link `b`, without `append` we will end up at `/b`, but with append we will end up at `/a/b`.
+   * Setting `append` prop always appends the relative path to the current path. For example, assuming we are navigating
+   * from `/a` to a relative link `b`, without `append` we will end up at `/b`, but with append we will end up at
+   * `/a/b`.
    *
    * @default false
    */
   append?: boolean
   /**
-   * Sometimes we want <RouterLink> to render as another tag, e.g <li>. Then we can use tag prop to specify which tag to render to, and it will still listen to click events for navigation.
+   * Sometimes we want <RouterLink> to render as another tag, e.g <li>. Then we can use tag prop to specify which tag to
+   * render to, and it will still listen to click events for navigation.
    *
    * @default "a"
    */
   tag?: string
   /**
-   * Configure the active CSS class applied when the link is active. Note the default value can also be configured globally via the `linkActiveClass` router constructor option.
+   * Configure the active CSS class applied when the link is active. Note the default value can also be configured
+   * globally via the `linkActiveClass` router constructor option.
    *
    * @default "router-link-active"
    */
   activeClass?: string
   /**
-   * The default active class matching behavior is **inclusive match**. For example, `<RouterLink to="/a">` will get this class applied as long as the current path starts with `/a/` or is `/a`.
+   * The default active class matching behavior is **inclusive match**. For example, `<RouterLink to="/a">` will get
+   * this class applied as long as the current path starts with `/a/` or is `/a`.
    *
    * @default false
    */
@@ -456,7 +461,8 @@ export interface RouterLinkProps {
    */
   exactPath?: boolean
   /**
-   * Configure the active CSS class applied when the link is active with exact path match. Note the default value can also be configured globally via the `linkExactPathActiveClass` router constructor option.
+   * Configure the active CSS class applied when the link is active with exact path match. Note the default value can
+   * also be configured globally via the `linkExactPathActiveClass` router constructor option.
    *
    * @default "router-link-exact-path-active"
    */
@@ -469,13 +475,16 @@ export interface RouterLinkProps {
    */
   event?: string | ReadonlyArray<string>
   /**
-   * Configure the active CSS class applied when the link is active with exact match. Note the default value can also be configured globally via the `linkExactActiveClass` router constructor option.
+   * Configure the active CSS class applied when the link is active with exact match. Note the default value can also be
+   * configured globally via the `linkExactActiveClass` router constructor option.
    *
    * @default "router-link-exact-active"
    */
   exactActiveClass?: string
   /**
-   * Configure the value of `aria-current` when the link is active with exact match. It must be one of the allowed values for [aria-current](https://www.w3.org/TR/wai-aria-1.2/#aria-current) in the ARIA spec. In most cases, the default of page should be the best fit.
+   * Configure the value of `aria-current` when the link is active with exact match. It must be one of the allowed
+   * values for [aria-current](https://www.w3.org/TR/wai-aria-1.2/#aria-current) in the ARIA spec. In most cases, the
+   * default of page should be the best fit.
    *
    * @default "page"
    */
@@ -499,15 +508,18 @@ export interface RouterLinkSlotArgument {
    */
   route: Route
   /**
-   * function to trigger the navigation. It will automatically prevent events when necessary, the same way `RouterLink` does
+   * function to trigger the navigation. It will automatically prevent events when necessary, the same way `RouterLink`
+   * does
    */
   navigate: (e?: MouseEvent) => Promise<undefined | NavigationFailure>
   /**
-   * `true` if the [active class](https://v3.router.vuejs.org/api/#active-class) should be applied. Allows to apply an arbitrary class
+   * `true` if the [active class](https://v3.router.vuejs.org/api/#active-class) should be applied. Allows to apply an
+   * arbitrary class
    */
   isActive: boolean
   /**
-   * `true` if the [exact active class](https://v3.router.vuejs.org/api/#exact-active-class) should be applied. Allows to apply an arbitrary class
+   * `true` if the [exact active class](https://v3.router.vuejs.org/api/#exact-active-class) should be applied. Allows
+   * to apply an arbitrary class
    */
   isExactActive: boolean
 }
@@ -530,7 +542,9 @@ export declare const RouterLink: new () => {
 
 export interface RouterViewProps {
   /**
-   * When a {@link RouterView | `<RouterView />`} has a name, it will render the component with the corresponding name in the matched route record's components option. See [Named Views](https://v3.router.vuejs.org/guide/essentials/named-views.html) for an example.
+   * When a {@link RouterView | `<RouterView />`} has a name, it will render the component with the corresponding name
+   * in the matched route record's components option. See [Named
+   * Views](https://v3.router.vuejs.org/guide/essentials/named-views.html) for an example.
    *
    * @default "default"
    */
