Skip to content

Commit 05e37d4

Browse files
committed
Update API.md
1 parent 4f8f950 commit 05e37d4

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/API.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -648,6 +648,13 @@ Returns a new `createHistory` function that may be used to create history object
648648
- isActive(pathname, query, indexOnly=false)
649649

650650

651+
## `match(location, cb)`
652+
653+
This function is to be used for server-side rendering. It matches a set of routes to a location, without rendering, and calls a `callback(error, redirectLocation, renderProps)` when it's done.
654+
655+
*Note: You probably don't want to use this in a browser. Use the [`history.listen`](https://github.com/rackt/history/blob/master/docs/GettingStarted.md#getting-started) API instead.*
656+
657+
651658

652659
## `createRoutes(routes)`
653660

0 commit comments

Comments
 (0)