# @lyo/history

A browser-compatible version of [history](https://www.npmjs.com/package/history) built automatically with [Lyo](https://github.com/bokub/lyo).

[![Version](https://flat.badgen.net/npm/v/@lyo/history)](https://www.npmjs.com/package/@lyo/history)
[![Build](https://bokub.github.io/lyo/badge-flat.svg)](https://www.npmjs.com/package/@lyo/history)
[![Hits](https://data.jsdelivr.com/v1/package/npm/@lyo/history/badge)](https://www.jsdelivr.com/package/npm/@lyo/history)

## Usage

#### In a browser
```html
<script src="https://cdn.jsdelivr.net/npm/@lyo/history"></script>

<script>
  history.createBrowserHistory();
  history.createHashHistory();
  history.createMemoryHistory();
  history.createLocation(foo, bar, baz, qux);
  history.locationsAreEqual(foo, bar);
  history.parsePath(foo);
  history.createPath(foo);
</script>
```

#### In Node.js

```sh
# Install
npm i @lyo/history
```

```js
const history = require('@lyo/history')

history.createBrowserHistory();
history.createHashHistory();
history.createMemoryHistory();
history.createLocation(foo, bar, baz, qux);
history.locationsAreEqual(foo, bar);
history.parsePath(foo);
history.createPath(foo);
```

## Disclaimer

This automated Lyo build may have not been properly tested, and is not guaranteed to work perfectly.

Use at your own risk