Skip to content

routejs/docs

Repository files navigation

Routejs Logo

NPM Version NPM Install Size NPM Downloads

Routejs is a fast and lightweight http routing engine for Node.js

User Guide

Features

  • Fast and lightweight
  • Group routing
  • Host based routing
  • Named routing
  • Middleware support
  • Object and array based routing
  • Regular expression support

Installation

Install using npm:

$ npm i @routejs/router

Install using yarn:

$ yarn add @routejs/router

Example

const { Router } = require("@routejs/router");
const http = require("http");

const app = new Router();

app.get("/", function (req, res) {
  res.end("Ok");
});

// Create 404 page not found error
app.use(function (req, res) {
  res.writeHead(404).end("404 Page Not Found");
});

http.createServer(app.handler()).listen(3000);

Url route example

Routejs is very simple and flexible, it support both object and array based url routing.

Let's create urls.js urls file for routes:

const { path, use } = require("@routejs/router");

// Url routes
const urls = [
  path("get", "/", (req, res) => res.end("Ok")),
  // Create 404 page not found error
  use((req, res) => res.writeHead(404).end("404 Page Not Found")),
];

module.exports = urls;

Use urls in routejs app:

const { Router } = require("@routejs/router");
const http = require("http");
const urls = require("./urls");

const app = new Router();

// Use url routes
app.use(urls);

http.createServer(app.handler()).listen(3000);

License

MIT License