[![CircleCI](https://circleci.com/gh/graforlock/cycle-router-driver.svg?style=svg)](https://circleci.com/gh/graforlock/cycle-router-driver)

Cycle.js routing solution based on awesome `universal-router`. Works out-of-the-box both server and client side.

#### Example usage:

Check out example in the repository for the complete, SSR/isomorphic routing [example](https://github.com/graforlock/cycle-router-driver/tree/master/example).

***

### [makeRouterDriver(routes, [options])](https://github.com/graforlock/cycle-router-driver/blob/master/src/index.js#L43)

Creates a router driver that should eventually return virtual dom (or any) component given route matches the current context. There is an optional `options` argument object to the function. It may be used for additional history config or passing request url in other non-browser environment (using `createMemoryHistory`).


 #### [routes](https://github.com/graforlock/cycle-router-driver/blob/master/src/index.js#L44)

Routes is an object compatible with `universal-router` API.


#### [options](https://github.com/graforlock/cycle-router-driver/blob/master/src/index.js#L45)

Options is an additional object of options that may include the following properties:

- *[url](https://github.com/graforlock/cycle-router-driver/blob/master/src/index.js#L45)* : It's the initial router url. Helpful for `nodejs` environment while rendering the app as a result of receiving `req.url`.
- *[historyOptions](https://github.com/graforlock/cycle-router-driver/blob/master/src/index.js#L45)* : Initial configuration object passed to history object. It matches `history` library API for `createBrowserHistory` and `createMemoryHistory`.

***

### [go(n)](https://github.com/graforlock/cycle-router-driver/blob/master/src/index.js#L37)

Accepts a `number` of steps to go from this point in the history. Internally, this returns `{ type: intent.GO, payload }` where payload is the `n` argument.

***

### [goBack()](https://github.com/graforlock/cycle-router-driver/blob/master/src/index.js#L38)

Goes back in history, doesn't require an argument. Internally, this returns `{ type: intent.GO_BACK }` with no payload.

***

### [goForward()](https://github.com/graforlock/cycle-router-driver/blob/master/src/index.js#L39)

Goes forward in history, doesn't require an argument. Internally, this returns `{ type: intent.GO_FORWARD }` with no payload.

***

### [push(...any)](https://github.com/graforlock/cycle-router-driver/blob/master/src/index.js#L40)

Accepts an object of the next, desirable route state to push. Matches `history` API.Internally, this returns `{ type: intent.PUSH, payload }` where payload is the `...any` argument. Heplful for manual, controlled tinkering with history API.

***

### [redirect(url)](https://github.com/graforlock/cycle-router-driver/blob/master/src/index.js#L41)

Accepts a string of the new location. Under the hood, it would perform a regular history `push`. Returns `{ type: intent.REDIRECT, payload }`. 

***

### [replace(...any)](https://github.com/graforlock/cycle-router-driver/blob/master/src/index.js#L41)

Accepts an object of the next, desirable route state to replace. Matches `history` API.Internally, this returns `{ type: intent.REPLACE, payload }` where payload is the `...any` argument. Just as `push`, it allows for manual, configurable sense of changes.