multi-path-matcher

multi-path-matcher

finds and decodes best matching path in a set of routes

usage

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(compileds, "/d/value1/e/value2"); // routes[2] { att1: "value1", att2: "value2" }
matcher(macro, routes, "/");              // routes[4]

API

Table of Contents

• multi-path-matcher
• usage
• API
  • Table of Contents
  • CompiledRoutes
  • Route
    • Properties
  • Match
    • Properties
  • compile
    • Parameters
  • matcher
    • Parameters
• install
• license

CompiledRoutes

Result of the routes compilation

Type: Object

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

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