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

milkman

v0.5.0

Published

Routing framework

Downloads

32

Readme

Milkman

Routing framework

Milkman manages the application route. Through it, you may navigate the application, and have your application's components respond to route changes. The route may be represented by URL hash, pushstate, or an internal static global. Milkman is built on top of troop for OOP, sntls for data structures, and evan for eventing.

Wiki

Reference

Npm package

Getting started

Configuration

Right after milkman has been loaded (required), you may specify whether you want to use hash or pushstate-based routing, by setting the flag milkman.usePushState. The flag has no effect under node.

milkman.usePushState = true;

Navigation

Navigating to a route is quite simple. Convert a route string to a Route instance, which offers an API that includes navigation.

  • Synchronous navigation changes the route immediately. By the time execution comes to the next line, the route will have changed. Example: 'user/joe'.toRoute().navigateTo().
  • Asynchronous navigation lets the current thread finish before the route will change. Async navigation returns a Q promise, giving you the opportunity to specify some follow-up. Example: 'user/joe'.toRoute().navigateToAsync().
  • Debounced navigation allows you to skip routes would they be overridden by subsequent navigation commands within a specified time frame (100ms by default). This is useful when re-routing due to some condition not being met by the application's state. Example: 'user/joe'.toRoute().navigateToDebounced().

Alternatively, if you don't want the route to be reflected in the URL (hash or state), silent navigation is also possible.

'user/joe'.toRoute().navigateToSilent();

Responding to routing events

Milkman triggers routing events in a special event space, whenever the application route changes, either through the hash, or pushstate. To capture such events, eg. for all 'user' routes, use the following expression known from evan.

'user'.toRoute().subscribeTo(milkman.Router.EVENT_ROUTE_CHANGE, function (event) {
    console.log(event.beforeRoute.toString());
    console.log(event.afterRoute.toString());
});

To listen to all routing events, you'll need to subscribe to en empty route.

[].toRoute().subscribeTo(...);

Sample code

To see milkman in action, check out Hills.