multi-path-matcher

multi-path-matcher

finds and decodes best matching path in a set of routes

usage

With paramus

import { compile, matcher } from "multi-path-matcher";

const routes = [
  { path: "/a/b/c" },
  { path: "/a/b" },
  { path: "/d/:att1/e/:att2" },
  { path: "/d/:att1/e" },
  { path: "/" }
];

const compiled = compile(routes);

matcher(compiled "/a");                   // undefined
matcher(compiled, "/a/b");                // routes[1]
matcher(compiled, "/a/b/c");              // routes[0]
matcher(compiled, "/d/value1/e");         // routes[3] { att1: "value1" }
matcher(compiled, "/d/value1/e/value2");  // routes[2] { att1: "value1", att2: "value2" }
matcher(compiled, "/");                   // routes[4]

With wildcards

import { compile, matcher } from "multi-path-matcher";

const routes = [
  { path: "/" },
  { path: "/*" },
  { path: "/about"},
  { path: "/login" }
];

const compiled = compile(routes);

matcher(compiled "/");                   // routes[0]
matcher(compiled "/index.html");         // routes[1]
matcher(compiled "/about");              // routes[2]
matcher(compiled "/login");              // routes[3]

API

Table of Contents

• CompiledRoutes
  • Parameters
• Route
  • Properties
• Match
  • Properties
• compile
  • Parameters
• CompiledRoute
  • Properties
• pathToRegexp
  • Parameters
• matcher
  • Parameters

CompiledRoutes

Result of the routes compilation

Type: Object

Parameters

• priority number
• keys Array<string>
• regex RegEx

Route

One single route

Type: Object

Properties

• path string

Match

result of a match

Type: Object

Properties

• route Route as given to the compiler
• params Object extracted from the path

compile

Compile a set of routes

Parameters

• routes Array<Route>

Returns CompiledRoutes

CompiledRoute

Result of a path compilation priorities for each path component

• :param -> 0
• match * or ? -> 1
• plain -> 2

Type: Object

Properties

• regex RegExp for later checking and params extration
• keys Set<string> all keys found in the route
• priority number order in which to check

pathToRegexp

Generate regex with priority

Parameters

• path string

Returns CompiledRoute

matcher

Find best match for a given path

Parameters

• compiled CompiledRoutes
• path string

Returns Match match

install

With npm do:

npm install multi-path-matcher

license

BSD-2-Clause