bygone

bygone

Listen for navigation and stream HTML5 history

Example

const bygone = require('bygone')

const locationStream = bygone()

locationStream.on('data', console.log(data))

locationStream.write('/path') // navigates browser and emits `/path`

When you call the bygone instance's install() method, it listens for any clicks on a elements, and treats those as pushState events so long as they are in your current host; for example:

<!-- snippet: test.html -->
<a href="/one">One</a>
<a href="/two">Two</a>
<a href="http://www.google.com/">Google</a>

const bygone = require('bygone')

const locationStream = bygone().install()

locationStream.on('data', data => console.log('data'))

• User clicks on One, and /one is emitted and pushed onto the history state
• User clicks on Two, and /two is emitted and pushed onto the history state
• User clicks on Google and nothing is emmitted, and browser navigates to http://www.google.com/

Bygone also listens for popstate events, so forward/back button usage will be emitted as expected.

API

bygone([opts]) -> duplexStream

• opts: (object) an optional configuration object. can have the following properties:
  • root: (string) the root URL to watch under; if root is /base/ only urls starting with /base/ will be hooked.

Instances have the following methods:

• instance.install() -> instance: Installs the a element listeners, and returns the instance to allow chaining.
• instance.uninstall() -> instance: Remove the a element listeners.

License

MIT. See LICENSE for details.