Giter Club home page Giter Club logo

location-hash-stream's Introduction

location-hash-stream

Build Status npm install npm version js-standard-style License

streaming interface to the window location hash

example

Emits the location hash whenever it changes. Uses the hashchange event under the hood, so browser support is dictated therein.

const hashStream = require('location-hash-stream')

const stream = hashStream()

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

window.location.hash = 'lol'

// logs '#lol'

Writing to the stream sets the location hash.

const hashStream = require('location-hash-stream')

const stream = hashStream()

hashStream.write('hash')

// window.location.hash is now '#hash'

API

hashStream([opts]) -> stream

  • opts is an optional configuration object. Available options are:
    • stripHash a Boolean specifying whether the emitted location hash should be stripped of its leading # character. Defaults to false.
  • stream.getHash() -> Retrieve the current hash string, respects the stripHash parameter.

license

MIT

location-hash-stream's People

Contributors

jarofghosts avatar

Watchers

 avatar

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.