From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Mon, 31 Aug 2020 16:23:19 +0000 (+0200)
Subject: docs: fetching and meta
X-Git-Tag: v4.0.0-beta.8~8
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=82d6befb7295bf6a7657dbcae4e2312e8b8152ea;p=thirdparty%2Fvuejs%2Frouter.git

docs: fetching and meta
---

diff --git a/docs/guide/advanced/data-fetching.md b/docs/guide/advanced/data-fetching.md
index fef14650..def9f1df 100644
--- a/docs/guide/advanced/data-fetching.md
+++ b/docs/guide/advanced/data-fetching.md
@@ -17,13 +17,9 @@ Let's assume we have a `Post` component that needs to fetch the data for a post
 ```html
 <template>
   <div class="post">
-    <div v-if="loading" class="loading">
-      Loading...
-    </div>
+    <div v-if="loading" class="loading">Loading...</div>
 
-    <div v-if="error" class="error">
-      {{ error }}
-    </div>
+    <div v-if="error" class="error">{{ error }}</div>
 
     <div v-if="post" class="content">
       <h2>{{ post.title }}</h2>
@@ -39,7 +35,7 @@ export default {
     return {
       loading: false,
       post: null,
-      error: null
+      error: null,
     }
   },
   created() {
@@ -49,7 +45,7 @@ export default {
   },
   watch: {
     // call again the method if the route changes
-    $route: 'fetchData'
+    $route: 'fetchData',
   },
   methods: {
     fetchData() {
@@ -64,8 +60,8 @@ export default {
           this.post = post
         }
       })
-    }
-  }
+    },
+  },
 }
 ```
 
@@ -79,7 +75,7 @@ export default {
   data() {
     return {
       post: null,
-      error: null
+      error: null,
     }
   },
   beforeRouteEnter(to, from, next) {
@@ -89,27 +85,19 @@ export default {
   },
   // when route changes and this component is already rendered,
   // the logic will be slightly different.
-  beforeRouteUpdate(to, from, next) {
+  async beforeRouteUpdate(to, from) {
     this.post = null
-    getPost(to.params.id, (err, post) => {
-      this.setData(err, post)
-      next()
-    })
-  },
-  methods: {
-    setData(err, post) {
-      if (err) {
-        this.error = err.toString()
-      } else {
-        this.post = post
-      }
+    try {
+      this.post = await getPost(to.params.id)
+    } catch (error) {
+      this.error = error.toString()
     }
-  }
+  },
 }
 ```
 
 The user will stay on the previous view while the resource is being fetched for the incoming view. It is therefore recommended to display a progress bar or some kind of indicator while the data is being fetched. If the data fetch fails, it's also necessary to display some kind of global warning message.
 
-### Using Composition API
+<!-- ### Using Composition API -->
 
-TODO:
+<!-- TODO: -->
diff --git a/docs/guide/advanced/meta.md b/docs/guide/advanced/meta.md
index 6ef8d6a0..dc2170e0 100644
--- a/docs/guide/advanced/meta.md
+++ b/docs/guide/advanced/meta.md
@@ -27,30 +27,41 @@ const routes = [
 
 So how do we access this `meta` field?
 
+<!-- TODO: the explanation about route records should be explained before and things should be moved here -->
+
 First, each route object in the `routes` configuration is called a **route record**. Route records may be nested. Therefore when a route is matched, it can potentially match more than one route record.
 
 For example, with the above route config, the URL `/posts/new` will match both the parent route record (`path: '/posts'`) and the child route record (`path: 'new'`).
 
-All route records matched by a route are exposed on the `$route` object (and also route objects in navigation guards) as the `$route.matched` Array. We could loop through that array to check all `meta` fields, but Vue Router also provides you a `$route.meta` that is first-level merge of **all `meta`** fields from parent to child. Meaning you can simply write
+All route records matched by a route are exposed on the `$route` object (and also route objects in navigation guards) as the `$route.matched` Array. We could loop through that array to check all `meta` fields, but Vue Router also provides you a `$route.meta` that is a non-recursive merge of **all `meta`** fields from parent to child. Meaning you can simply write
 
 ```js
-router.beforeEach((to, from, next) => {
+router.beforeEach((to, from) => {
   // instead of having to check every route record with
   // to.matched.some(record => record.meta.requiresAuth)
-  if (to.meta.requiresAuth)) {
+  if (to.meta.requiresAuth && !auth.isLoggedIn()) {
     // this route requires auth, check if logged in
     // if not, redirect to login page.
-    if (!auth.isLoggedIn()) {
-      next({
-        path: '/login',
-        // save the location we were at to come back later
-        query: { redirect: to.fullPath }
-      })
-    } else {
-      next()
+    return {
+      path: '/login',
+      // save the location we were at to come back later
+      query: { redirect: to.fullPath },
     }
-  } else {
-    next() // make sure to always call next()!
   }
 })
 ```
+
+## TypeScript
+
+It is possible to type the meta field by extending the `RouteMeta` interface:
+
+```ts
+declare module 'vue-router' {
+  interface RouteMeta {
+    // is optional
+    isAdmin?: boolean
+    // must be declared by every route
+    requiresAuth: boolean
+  }
+}
+```