Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@lunjs/pathname-store

lunjs38MIT0.1.0TypeScript support: included

A fast path router, base on radix tree

path, router, radix tree, fast, pathname, store

readme

@lunjs/pathname-store

Installation

npm install @lunjs/pathname-store

Usage

import { PathnameStore } from '@lunjs/pathname-store';

const s = new PathnameStore();
s.add('/users', {});
s.add('/user/:name', {});

let r = s.find('/users');
console.log(r);
// output: { found: true, box: { store: {}, pnames: [] }, params: [] }

Pattern Rule

Syntax Description
:name named param
* match-all param
:name* named match-all param
  • Named parameters match anything until the next '/' or the path end.
  • Match-all param match anything until the path end.

Path matching order

  • Static
  • Param
  • Match all

Inspired by

License

MIT