Update matchPath docs (#6703)

* Update matchPath.md * Update matchPath.md * Update matchPath.md
remix-run · Apr 14, 2019 · 29155fc · 29155fc
1 parent 3ccbd19
commit 29155fc
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/packages/react-router/docs/api/matchPath.md b/packages/react-router/docs/api/matchPath.md
@@ -29,3 +29,34 @@ to the matching props `Route` accepts:
     exact; // optional, defaults to false
 }
 ```
+
+## returns
+
+It returns an object when provided pathname does match `path` prop or `null` otherwise.
+
+```
+matchPath("/users/2", {
+      path: "/users/:id",
+      exact: true,
+      strict: true
+    })
+    
+//  {
+//    isExact: true
+//    params: {
+//        id: "2"
+//    }
+//    path: "/users/:id"
+//    url: "/users/2"
+//  } 
+```
+
+```
+matchPath("/users", {
+      path: "/users/:id",
+      exact: true,
+      strict: true
+    })
+    
+//  null
+```