Routinejs, An Specific impressed blazingly quick Nodejs router

Hi there there,
I’m right here to introduce you to Routine, An Specific impressed and appropriate Nodejs router.

Documentation continues to be a piece in progress however the core framework api is steady and able to use.
Please take into account leaving a star at Routine’s Github repo

Some excessive stage options of Routine

✅ It’s 4 occasions quicker than Specific (benchmark code can be out there inside the repo)
✅ Typescript assist is built-in
✅ Helps regex as url-path
✅ International sync/async error handler
✅ Middleware and nested route assist
✅ Helps nearly all current Expressjs plugins/middlewares
✅ Constructed-in physique parser
✅ Inbuilt json responder utilizing fast-safe-stringify which is quicker than native JSON.stringify and likewise detects round objects

Benchmark evaluating Routine with Specific and Hapi, Koa was additionally examined but it surely didn’t course of so many requests and saved giving ERPIPE error, You may run these benchmarks your self as properly, merely discuss with the benchmarks folder inside the repo

Code examples beneath are additionally out there on CodeSandbox right here

Let’s begin with a easy Hi there World instance in Typescript

//Importing Routine class together with some sorts
import Routine, { Request, Response } from "@juniordev/routinejs";

//Creating a brand new occasion of Routine
const app = new Routine();

//Registering a GET route on path "https://dev.to/"
app.get(`/`, (req: Request, res: Response) => {
  res.json({
    msg: "Hi there Routine"
  });
});

//Beginning the server on PORT 8080, default port can be 8080
app.hear(8080);

This begins the server at http://localhost:8080 and once we go to this url, we obtain {"msg": "Hi there Routine"} since we now have a GET route registered at / path.

Observe: The built-in .json technique makes use of fast-safe-stringify which is quicker than native JSON.stringify and likewise detects and prevents [Circular] Object inside Response, So it’s extremely really useful to make use of this technique for sending json payload to shopper.

Let’s take a look at POST route

//Importing Routine class together with some sorts
import Routine, { Request, Response } from "@juniordev/routinejs";

//Creating a brand new occasion of Routine
const app = new Routine();

//Registering a GET route on path "https://dev.to/"
app.get(`/`, (req: Request, res: Response) => {
  res.json({
    msg: "Hi there Routine"
  });
});

//Registering a POST route additionally on path `/`
app.submit(`/`, (req: Request, res: Response) => {
  //Computerized request physique parsing with none plugin  
  //Sending the request physique again to the shopper
  res.json(req.physique);
});

//Beginning the server on PORT 8080, default port can be 8080
app.hear(8080);

This time, we obtain no matter we ship as physique to the server, if we ship {"msg": "Hi there Routine"} as JSON payload to the server, we obtain {"msg": "Hi there Routine"} again.

Routine has all main http verbs built-in, akin to
GET, POST, PUT, PATCH and DELETE

Named & Question Params

//Importing Routine class together with some sorts
import Routine, { Request, Response } from "@juniordev/routinejs";

//Creating a brand new occasion of Routine
const app = new Routine();

//Registering a GET route on path '/:title'
app.get(`/:title`, (req: Request, res: Response) => {
  res.json({
    title: req.params.title,
    question: req.question
  });
});

//Beginning the server on PORT 8080, default port can be 8080
app.hear(8080);

Visiting http://localhost:8080/routine?howdy=world would return us

{
  "title": "routine",
  "question": {
    "howdy": "world"
  }
}

Observe: You may put any legitimate regex as path and routine will attempt to match it

Utilizing middlewares

//Registering a middleware
app.use((req: Request, res: Response, subsequent: NextFunction) => {
  console.log("middleware referred to as");
  subsequent();
});

Middleware performance is identical as Specific, that’s the reason Routine is nearly totally appropriate with Specific plugins, and is examined with well-liked ones akin to Morgan, Specific Validator and many others

Lastly, let’s examine how nested routes are carried out

//src/router.ts
import { Router, Request, Response } from "@juniordev/routinejs";

const router = new Router();

router.get(`/router`, (req: Request, res: Response) => {
  res.json({
    msg: "from router"
  });
});

export default router;

//src/index.ts
import Routine, { NextFunction, Request, Response } from "@juniordev/routinejs";
import router from "./router";

//Creating a brand new occasion of Routine
const app = new Routine();

//Utilizing a nested router
app.use(`/nested`, router);

app.hear(8080)

After we go to http://localhost:8080/nested/router, server returns {"msg":"from router"}

All of the above http strategies, named or question params, middlewares may also be utilized to nested routes as properly, even a lot in order that nested routes can have extra nested routes, and it does NOT degrade route matching efficiency on account of startup/compile time route compilation

This was a primary introduction to Routine, many options akin to cancel perform, world async error dealing with and many others shouldn’t be but talked about, however shall be coated in future posts, you possibly can learn the docs for async error dealing with caveats for now although, its an excellent learn i promise 🙂