Skip to main content

Router

A high-performance basic router works anywhere.

tag Build Status license

Features

  • Based on radix tree: Compared with routers based on regular expressions, we have better performance in most of the cases, which can significantly increase the speed of your project, and as the project scale increases, the performance will also increase exponentially.

  • Stupid rules: We will always match according to the rules of “Static > Param > Any”. For static routes, we always match strictly equal strings.

Usage

Deno

See zhmushan/abc

Nodejs

Installation:

npm i zhmushan/router#v1.0.0

Create index.js:

import { createServer } from "http";
import { Node } from "router";

const root = new Node();

root.add("/:user", (p) => {
  return p.get("user");
});

createServer((req, res) => {
  const [h, p] = root.find(req.url);

  if (h) {
    const result = h(p);
    res.end(result);
  } else {
    res.end("Not Found");
  }
}).listen(8080);

console.log("server listening on http://localhost:8080");

Make sure you have set type: module in package.json, then run:

node index.js

Browse to http://localhost:8080/your_name and you should see “your_name” on the page.

Browser

<body>
  <button id="change_path">Change Path</button>
  <button id="home">Home</button>
  <script type="module">
    import { Node } from "https://deno.land/x/router@v1.0.0/mod.js";

    const root = new Node();
    root.add("/:random_string", (c) => {
      console.log(c.get("random_string"));
    });

    change_path.onclick = () => {
      const path = `/${randomStr()}`;
      const [func, params] = root.find(path);
      if (func) {
        func(params);
        history.replaceState(undefined, "", path);
      }
    };

    home.onclick = () => {
      history.replaceState(undefined, "", "/");
    };

    function randomStr() {
      return Math.random().toString(32).split(".")[1];
    }
  </script>
</body>

React

Coming soon…