# aurelia-history-browser

> An implementation of the Aurelia history interface based on standard browser hash change and push state mechanisms.

Latest version **1.4.0** (published 2019-05-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install aurelia-history-browser
pnpm add aurelia-history-browser
yarn add aurelia-history-browser
bun add aurelia-history-browser
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2019-05-31 |
| First published | 2015-11-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 221 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | Rob Eisenberg |
| Maintainers | aureliaeffect |
| Keywords | aurelia, history, router |

## Links

- npm: https://www.npmjs.com/package/aurelia-history-browser
- Repository: https://github.com/aurelia/history-browser
- Homepage: http://aurelia.io
- Issues: https://github.com/aurelia/history-browser/issues
- npm.io page: https://npm.io/package/aurelia-history-browser

## Dependencies (2)

- [aurelia-pal](https://npm.io/package/aurelia-pal.md) ^1.0.0
- [aurelia-history](https://npm.io/package/aurelia-history.md) ^1.0.0

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 1.4.0 (latest) — 2019-05-31
- 1.3.2 — 2019-05-02
- 1.3.1 — 2019-03-27
- 1.3.0 — 2019-01-18
- 1.2.0 — 2018-06-13
- 1.1.1 — 2018-02-24
- 1.1.0 — 2017-09-29
- 1.0.0 — 2016-07-27
- 1.0.0-rc.1.0.0 — 2016-06-22
- 1.0.0-beta.2.0.1 — 2016-06-16
- 1.0.0-beta.2.0.0 — 2016-06-13
- 1.0.0-beta.1.2.1 — 2016-05-10
- 1.0.0-beta.1.2.0 — 2016-03-23
- 1.0.0-beta.1.1.4 — 2016-03-01
- 1.0.0-beta.1.1.2 — 2016-02-08
- … 4 more at https://npm.io/package/aurelia-history-browser/versions

## README

# aurelia-history-browser

[![npm Version](https://img.shields.io/npm/v/aurelia-history-browser.svg)](https://www.npmjs.com/package/aurelia-history-browser)
[![Join the chat at https://gitter.im/aurelia/discuss](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/aurelia/discuss?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![CircleCI](https://circleci.com/gh/aurelia/history-browser.svg?style=shield)](https://circleci.com/gh/aurelia/history-browser)

This library is part of the [Aurelia](http://www.aurelia.io/) platform and contains an implementation of the Aurelia history interface based on standard browser hash change and push state mechanisms.

> To keep up to date on [Aurelia](http://www.aurelia.io/), please visit and subscribe to [the official blog](http://blog.aurelia.io/) and [our email list](http://eepurl.com/ces50j). We also invite you to [follow us on twitter](https://twitter.com/aureliaeffect). If you have questions look around our [Discourse forums](https://discourse.aurelia.io/), chat in our [community on Gitter](https://gitter.im/aurelia/discuss) or use [stack overflow](http://stackoverflow.com/search?q=aurelia). Documentation can be found [in our developer hub](http://aurelia.io/docs).

## Platform Support

This library can be used in the **browser** only.

## Building The Code

To build the code, follow these steps.

1. Ensure that [NodeJS](http://nodejs.org/) is installed. This provides the platform on which the build tooling runs.
2. From the project folder, execute the following command:

  ```shell
  npm install
  ```
3. To build the code, you can now run:

  ```shell
  npm run build
  ```
4. You will find the compiled code in the `dist` folder, available in three module formats: AMD, CommonJS and ES6.

## Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

1. You can now run the tests with this command:

  ```shell
  npm run test
  ```

2. You can run the tests in watch mode (headless Chrome):

  ```shell
  npm run test:watch
  ```
  
3. You can run the tests in watch mode (with Chrome for debugging):

  ```shell
  npm run test:debugger
  ```

---
_Source: https://npm.io/package/aurelia-history-browser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._