Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
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.
$ npm install wayfarer
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('tobi')
// => 'user is tobi'
router('/uh/oh')
// => '404 not found'
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!'
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
Initialize a router with a default route. Doesn't ignore querystrings and hashes.
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.
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.
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 trienode = trie.create(route)
- create a node at a path, and return a nodenode = trie.match(route)
- match a route on the the trie and return a nodetrie.mount(path, trie)
- mount a trie onto a node at routeE.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.
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.
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.
window.location.hash
matchingreq, res
delegationFAQs
Composable trie based router
The npm package wayfarer receives a total of 2,901 weekly downloads. As such, wayfarer popularity was classified as popular.
We found that wayfarer demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 30 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.