npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hermes-conrad

v1.0.2

Published

simple pushstate based client routing

Downloads

11

Readme

Sweet three-toed sloth of the ice planet Hoth!

about hermes

Hermes is Backbone inspired client router for pushstate clients. Hermes was built to support hybrid web applications.

  • Hermes is a simple object - I don't need no stinking constructors
  • Hermes uses Backbone style route definitions
  • Hermes always triggers a handler if a route is matched unless told otherwise - no more passing trigger for every single navigate
  • Hermes accepts a state object
  • Hermes sets the document title if one is passed when navigating and updates the title on popstate
  • Hermes will optionally store references state objects in an internal cache (always stored in the history object)
  • Hermes does not require Backbone, but will trigger Backbone events if a reference to Backbone is passed as an option on start

API

When a route handler is called it is passed three arguments:

  • pathname
  • parameters object (contains named path parameters and the values from window.location.search [given precedence over path parameters])
  • state object

hermes.start(options)

Binds popstate handler and processes options.

hermes.start({
  routeOnHashChange: true, // execute matched route when hash changes; defaults to false
   routes: {}, // routes table
   title: '', // title for current page
   state: {}, // state object for the current page
   cache: false, // keep cache of state objects in addition to those stored in the history (stores page title regardless)
   routeNotMatched: function (routePathName) {
      // do something if a route is not matched, e.g., render 404 page
   }
}

});

hermes.stop()

Unbinds popstate handler.

hermes.route(route, name, callback)

Adds a route handler to Hermes.

hermes.destroyRoutes()

Deletes route handlers.

hermes.navigate(url, options)

Calls matching route handler if one is defined.

hermes.navigate(url, {
    title: '', // page title to associate to url
    state: {}, // state object to associate to url
    trigger: true // execute route handler; default is true
});

hermes.getItem(url)

Gets cached object for url.

hermes.updateState(state, title, [url])

Updates the state object for the current url or the url specified. Url = window.location.pathname + window.location.search.

hermes.clearCache()

Deletes cache object.

herems.getPreviousUrl()

Gets the previous Url. Useful for looking up the previous page's cache item.