update documenation

docs/router.md

@@ -167,6 +167,111 @@ Middleware function for your nextjs server setup.
 
 
 
+#### Router.pushRoute(name[, params, query]) 
+
+Push State helper for navigating to a route.
+**note:** This doesn't work serverside.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| name | `string`  | The route name. |   |
+| params | `Object`  | The route parameters. | *Optional* |
+| query | `Object`  | The route query parameters. | *Optional* |
+
+
+
+
+##### Examples
+
+```javascript
+router.add('/post/:slug','blog-post').as('blog-post');
+router.pushRoute('blog-post', {slug:'post-slug'}, {order:'1'});
+// resolves to /post/post-slug?order=1
+```
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+#### Router.replaceRoute(name[, params, query]) 
+
+Replace State helper for navigating to a route.
+**note:** This doesn't work serverside.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| name | `string`  | The route name. |   |
+| params | `Object`  | The route parameters. | *Optional* |
+| query | `Object`  | The route query parameters. | *Optional* |
+
+
+
+
+##### Examples
+
+```javascript
+router.add('/post/:slug','blog-post').as('blog-post');
+router.replaceRoute('blog-post', {slug:'post-slug'}, {order:'1'});
+// resolves to /post/post-slug?order=1
+```
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+#### Router.prefetchRoute(name[, params, query]) 
+
+Prefetch a route
+**note:** This doesn't work serverside.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| name | `string`  | The route name. |   |
+| params | `Object`  | The route parameters. | *Optional* |
+| query | `Object`  | The route query parameters. | *Optional* |
+
+
+
+
+##### Examples
+
+```javascript
+router.add('/post/:slug','blog-post').as('blog-post');
+router.prefetchRoute('blog-post', {slug:'post-slug'}, {order:'1'});
+// prefetches the data for /post/post-slug?order=1
+```
+
+
+##### Returns
+
+
+- `Void`
+
+
+
 #### Router._initialize()  *private method*
 
 Initialize the client url location data
@@ -216,6 +321,33 @@ Validates that nested groups are not created.
 
 
 
+##### Returns
+
+
+- `Void`
+
+
+
+#### Router._browserHistoryApply(method, name, params, query) 
+
+Helper function for browser history methods.
+Used by [router.pushRoute](https://github.com/samueljoos/next-avenues/blob/master/docs/router.md#pushroutenameparamsquery) [router.replaceRoute](https://github.com/samueljoos/next-avenues/blob/master/docs/router.md#replaceroutenameparamsquery) [router.prefetchRoute](https://github.com/samueljoos/next-avenues/blob/master/docs/router.md#prefetchroutenameparamsquery)
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| method | `string`  | Should be one of push, replace or prefetch. |   |
+| name | `string`  | The route name. |   |
+| params | `Object`  | The route Params. |   |
+| query | `Object`  | The route query. |   |
+
+
+
+
 ##### Returns
 
 

src/Router.js

@@ -231,7 +231,7 @@ class Router {
      *
      * @example
      * router.add('/post/:slug','blog-post').as('blog-post');
-     * router.pushRoute('blog-post', {slug:'post-slug'}, {order:'1'});
+     * router.replaceRoute('blog-post', {slug:'post-slug'}, {order:'1'});
      * // resolves to /post/post-slug?order=1
      */
     replaceRoute(name, params, query) {
@@ -240,7 +240,7 @@ class Router {
 
     /**
      * @description
-     * Prefetch the route.
+     * Prefetch a route
      * **note:** This doesn't work serverside.
      *
      * @param {string} name The route name.
@@ -249,8 +249,8 @@ class Router {
      *
      * @example
      * router.add('/post/:slug','blog-post').as('blog-post');
-     * router.pushRoute('blog-post', {slug:'post-slug'}, {order:'1'});
-     * // resolves to /post/post-slug?order=1
+     * router.prefetchRoute('blog-post', {slug:'post-slug'}, {order:'1'});
+     * // prefetches the data for /post/post-slug?order=1
      */
     prefetchRoute(name, params, query) {
         this._browserHistoryApply('prefetch', name, params, query);