Git Product home page Git Product logo

observ-history's Introduction

observ-history Build Status Greenkeeper badge

Observable interface to the browser history API

Install

$ npm install --save observ-history

Usage

var history = require('observ-history')

history(function (path) {
  //=> (popstate)  
})

history()
//=> current path

history.set(path)
//=> pushState

API

history([listener]) -> function

Returns an unlisten function.

listener

Type: function

A function to call with the current path when the history changes and a popstate event is fired. If no function is passed, the current path is returned.

history.set(path) -> undefined

Updates the history by calling pushState.

License

MIT © Ben Drucker

observ-history's People

Contributors

bendrucker avatar greenkeeper[bot] avatar

Stargazers

André Neves avatar Chris Buttery avatar Yosh avatar Mikey avatar

Watchers

 avatar James Cloos avatar  avatar

Forkers

ajoslin

observ-history's Issues

location beyond pathname (e.g. query params)

hey @bendrucker, sweet module, probably better than observ-location i wrote a while back.

just wondering, how would one use this if they need more than just window.location.pathname, e.g. to get the query params? in my module i returned window.location.href so as to not impose an opinion and return the full location (which in my projects i would parse with url into an object and pass that down), i'm wondering what you have in mind.

cheers

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.