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

radix-rapid

v0.0.2

Published

✨ Lightweight and fast router for JavaScript based on Radix Tree 🌱

Downloads

14

Readme

cover npm version npm downloads bundle JSDocs License

🌳 radix-rapid

✨ Lightweight and fast router for JavaScript based on Radix Tree🌱.

📝 Usage

Install:

# nyxi
nyxi radix-rapid

# pnpm
pnpm i radix-rapid

# npm
npm i radix-rapid

# yarn
yarn add radix-rapid

Import:

// ESM
import { createRouter } from 'radix-rapid'

// CJS
const { createRouter } = require('radix-rapid')

Create a router instance and insert routes:

const router = createRouter(/* options */)

router.insert('/path', { payload: 'this path' })
router.insert('/path/:name', { payload: 'named route' })
router.insert('/path/foo/**', { payload: 'wildcard route' })
router.insert('/path/foo/**:name', { payload: 'named wildcard route' })

Match route to access matched data:

router.lookup('/path')
// { payload: 'this path' }

router.lookup('/path/fooval')
// { payload: 'named route', params: { name: 'fooval' } }

router.lookup('/path/foo/bar/baz')
// { payload: 'wildcard route' }

router.lookup('/')
// null (no route matched for/)

⚡️ Methods

router.insert(path, data)

path can be static or using :placeholder or ** for wildcard paths.

The data object will be returned on matching params. It should be an object like { handler } and not containing reserved keyword params.

🔍 router.lookup(path)

Returns matched data for path with optional params key if mached route using placeholders.

router.remove(path)

Remove route matching path.

⚙️ Options

You can initialize router instance with options:

const router = createRouter({
   strictTrailingSlash: true,
   routes: {
      '/foo': {}
   }
})
  • 🛣️ routes: An object specifying initial routes to add
  • 🚦 strictTrailingSlash: By default, the router ignores trailing slashes for matching and adding routes. When set to true, matching with trailing slashes is handled differently.

🔎 Route Matcher

Creates a multi matcher from router tree that can match all routes matching path:

import { createRouter, toRouteMatcher } from 'radix-rapid'

const router = createRouter({
   routes: {
      '/foo': { m: 'foo' }, // Matches /foo only
      '/foo/**': { m: 'foo/**' }, // Matches /foo/<any>
      '/foo/bar': { m: 'foo/bar' }, // Matches /foo/bar only
      '/foo/bar/baz': { m: 'foo/bar/baz' }, // Matches /foo/bar/baz only
      '/foo/*/baz': { m: 'foo/*/baz' } // Matches /foo/<any>/baz
   }
})

const matcher = toRouteMatcher(router)

const matches = matcher.matchAll('/foo/bar/baz')

// [
//   {
//     "m": "foo/**",
//   },
//   {
//     "m": "foo/*/baz",
//   },
//   {
//     "m": "foo/bar/baz",
//   },
// ]

⚡️ Performance

See benchmark.

📜 License

MIT - Made with 💞