From: Carlos Rodrigues <david-181@hotmail.com>
Date: Thu, 15 Apr 2021 11:56:01 +0000 (+0100)
Subject: docs: RouterMeta typing example (#884)
X-Git-Tag: v4.0.7~30
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b67575176fe8b2372c38621504877af6f0fe18cc;p=thirdparty%2Fvuejs%2Frouter.git

docs: RouterMeta typing example (#884)

* docs: RouterMeta typing example

* Apply suggestions from code review [skip ci]

* Apply suggestions from code review [skip ci]

Co-authored-by: Eduardo San Martin Morote <posva@users.noreply.github.com>
---

diff --git a/docs/guide/advanced/meta.md b/docs/guide/advanced/meta.md
index 17a290e7..1f55f485 100644
--- a/docs/guide/advanced/meta.md
+++ b/docs/guide/advanced/meta.md
@@ -56,6 +56,7 @@ router.beforeEach((to, from) => {
 It is possible to type the meta field by extending the `RouteMeta` interface:
 
 ```ts
+// typings.d.ts or router.ts
 import 'vue-router'
 
 declare module 'vue-router' {
diff --git a/docs/zh/guide/advanced/meta.md b/docs/zh/guide/advanced/meta.md
index 6a0bdd4b..076a505e 100644
--- a/docs/zh/guide/advanced/meta.md
+++ b/docs/zh/guide/advanced/meta.md
@@ -56,6 +56,9 @@ router.beforeEach((to, from) => {
 可以通过扩展 `RouteMeta` 接口来输入 meta 字段：
 
 ```ts
+// typings.d.ts or router.ts
+import 'vue-router'
+
 declare module 'vue-router' {
   interface RouteMeta {
     // 是可选的
diff --git a/src/types/index.ts b/src/types/index.ts
index 5a05acdf..469a0f35 100644
--- a/src/types/index.ts
+++ b/src/types/index.ts
@@ -253,6 +253,9 @@ export interface _RouteRecordBase extends PathParserOptions {
  * @example
  *
  * ```ts
+ * // typings.d.ts or router.ts
+ * import 'vue-router';
+ *
  * declare module 'vue-router' {
  *   interface RouteMeta {
  *     requiresAuth?: boolean