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 🙏

© 2020 – Pkg Stats / Ryan Hefner

@arve.knudsen/wayfarer

v6.5.0

Published

Composable trie based router

Downloads

84

Readme

wayfarer stability

npm version build status test coverage downloads js-standard-style

Composable trie based router. It's faster than traditional, linear, regular expression-matching routers, although insignficantly, and scales with the number of routes.

If you're looking for a client-side router check out sheet-router. If you're looking for a server router check out server-router.

features

  • works with any framework
  • built for speed
  • minimal dependencies
  • extensible

Installation

$ npm install wayfarer

Usage

const wayfarer = require('wayfarer')

const router = wayfarer('/404')

router.on('/', () => console.log('/'))
router.on('/404', () => console.log('404 not found'))
router.on('/:user', (params) => console.log('user is %s', params.user))
router.on('/wildcard/*', (params) => console.log('wildcard path is %s', params.wildcard))

router('tobi')
// => 'user is tobi'

router('/uh/oh')
// => '404 not found'

router('/wildcard/example/path')
// => 'wildcard path is example/path'

Subrouting

Routers can be infinitely nested, allowing routing to be scoped per view. Matched params are passed into subrouters. Nested routes will call their parent's default handler if no path matches.

const r1 = wayfarer()
const r2 = wayfarer()

r2.on('/child', () => console.log('subrouter trix!'))
r1.on('/:parent', r2)

r1('/dada/child')
// => 'subrouter trix!'

Walk

Sometimes it's necessary to walk the trie to apply transformations.

const walk = require('wayfarer/walk')
const wayfarer = require('wayfarer')

const router = wayfarer()
router.on('/multiply', (x, y) => x * y)
router.on('/divide', (x, y) => x / y)

walk(router, (route, cb) => {
  const y = 2
  return function (params, x) {
    return cb(x, y)
  }
})

router('/multiply', 4)
// => 8
router('/divide', 8)
// => 4

API

router = wayfarer(default)

Initialize a router with a default route. Doesn't ignore querystrings and hashes.

router.on(route, cb(params, arg1, ...))

Register a new route. The order in which routes are registered does not matter. Routes can register multiple callbacks. The callback can return values when called.

val = router(route, arg1, ...)

Match a route and execute the corresponding callback. Alias: router.emit(). Returns a values from the matched route (e.g. useful for streams). Any additional values will be passed to the matched route.

Internals

Wayfarer is built on an internal trie structure. If you want to build a router using this trie structure it can be accessed through require('wayfarer/trie'). It exposes the following methods:

  • trie = Trie() - create a new trie
  • node = trie.create(route) - create a node at a path, and return a node
  • node = trie.match(route) - match a route on the the trie and return a node
  • trie.mount(path, trie) - mount a trie onto a node at route

Known issues

multiple nested partials don't match

E.g. /:foo/:bar/:baz won't work. This is due Trie.mount() overriding child partial paths when mounted. I'll get around to fixing this at some point in the future, but if anyone wants to contribute a patch it'd most appreciated.

FAQ

Why did you build this?

Routers like react-router are complicated solutions for a simple problem. In reality all that's needed is a methodless router that can define + match paths and can mount other routers to delegate requests.

Why isn't my route matching?

Wayfarer only compares strings. Before you pass in an url you probably want to strip it of querystrings and hashes using the pathname-match module.

See Also

License

MIT