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 17a290e7d3fddf3a861a4bd6be916138445ed930..1f55f485ce1809c2b838015e1ba60d19bbb324f5 100644 (file)
--- 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 6a0bdd4b3ee162c55d1de8505086dfbe80ad4d32..076a505e8896a8cd24e4c6f186bb946712688bac 100644 (file)
--- 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 5a05acdf2903e9efe190809b2ed161f4636f0a78..469a0f350ad803e85fb0472dc490d3e133214292 100644 (file)
--- 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