express-awesome-routes v1.0.0

Expres Awesome Routes

Package for express.js framework that allow to you santadarize your routes with the flexibility as you want.

Table of Content

• Expres Awesome Routes
  • Table of Content
  • About
  • Features
  • Example
    • JavaScript
    • TypeScript
  • Documentation
    • Routes definitions
      • Route
      • ProxyRoute
      • Routes
      • ValidationOptions
      • Method
      • ContainerTypes
    • ExpressAwesomeRoutes([options])
      • Arguments (Typed)
      • Example
      • add(routes [, prefix][, middlewares])
        • Arguments (Typed)
        • Example
      • getRoutes()
        • Example
    • createRoutes(routes[,prefix][,middlewares])
      • Arguments (Typed)
      • Example
  • License

About

The motivation to use this package is provide a cleaner code and facilitate DRY (Don't repeat yourself) principle on tour routes.

Features

This library support the following features:

• Declare routes
• Add middleware(s) to routes
• Add Joi validators(@happi/joi) to routes
• Set prefix to your routes

Example

Here is an example to use express-awesome-routes in the simplest way.

JavaScript

'use strict';
const express = require('express');
const bodyParser = require('body-parser');
const { createRoutes, Method } = require('express-awesome-routes');

class Controller {
  getOne(_req, res) {
    res.json({
      message: 'ok',
    });
  }
}

app.use(bodyParser.json());

const routes = [
  {
    route: '/foo',
    method: Method.Get,
    controller: Controller,
    function: 'getOne',
  },
];

app.use(createRoutes(routes));
app.listen(3000, () => {
  console.log('Listening on port 3000');
});

TypeScript

import express, { Request, Response } from 'express';
import bodyParser from 'body-parser';
import { createRoutes, Method, Routes } from 'express-awesome-routes';

class Controller {
  public getOne(_req: Request, res: Response): void {
    res.json({
      message: 'ok',
    });
  }
}

const app: express.Express = express();
app.use(bodyParser.json());

const routes: Routes = [
  {
    route: '/foo',
    method: Method.Get,
    controller: Controller,
    function: 'getOne',
  },
];

app.use(createRoutes(routes));
app.listen(3000, () => {
  console.log('Listening on port 3000');
});

Documentation

Routes definitions

In Express Awesome Routes you can build your own routes using defined objects. This objects are defined in two types: Route and ProxyRoute.

Route

export interface Route {
  route: string;
  method: Method;
  controller: any;
  function: string;
  middlewares?: RequestHandler[];
  validators?: ValidatorOptions[];
}

ProxyRoute

export interface ProxyRoute {
  route: string;
  subRoutes: Routes;
  middlewares?: RequestHandler[];
}

Routes

type Routes = Array<Route | ProxyRoute>;

ValidationOptions

interface ValidatorOptions {
  type: ContainerTypes;
  schema: ObjectSchema;
  opts?: ExpressJoiContainerConfig;
}

Method

Object (enum in TS) that includes all HTTP methods (supported by express.js 4.x).

Method.All;
Method.Get;
Method.Post;
Method.Put;
Method.Patch;
Method.Delete;
Method.Head;
Method.Options;
Method.Trace;
Method.Copy;
Method.Lock;
Method.Mkcol;
Method.Move;
Method.Purge;
Method.Profind;
Method.Proppatch;
Method.Unlock;
Method.Report;
Method.Mkactivity;
Method.Checkout;
Method.Merge;
Method.MSearch;
Method.Notify;
Method.Subscribe;
Method.Unsubscribe;
Method.Search;
Method.Connnect;

ContainerTypes

Object (enum in TS) that includes the validation types (see express-joi-validation).

ContainerTypes.Body;
ContainerTypes.Query;
ContainerTypes.Headers;
ContainerTypes.Fields;
ContainerTypes.Params;

ExpressAwesomeRoutes(options)

Class that instance a ExpressAwesomeRoutes object allowing to you pass a set of options to configure it.

Arguments (Typed)

ExpressAwesomeRoutes();
ExpressAwesomeRoutes(options: ExpressAwesomeRoutesOptions);

Example

import { ExpressAwesomeRoutes } from 'express-awesome-routes';

// With default options
const ear: ExpressAwesomeRoutes = new ExpressAwesomeRoutes();
// With options
const ear: ExpressAwesomeRoutes = new ExpressAwesomeRoutes({ passError: true, statusCode: 500 });

add(routes , prefix)

Method that add(s) route(s) to Router object (Express.js Router), passing the following arguments:

Arguments (Typed)

add(routes: Routes): void
add(routes: Routes, prefix: string): void
add(routes: Routes, prefix: string, middlewares: any[]): void

Example

import { ExpressAwesomeRoutes, Method } from 'express-awesome-routes';
// imports...
const ear: ExpressAwesomeRoutes = new ExpressAwesomeRoutes();
const routes: Routes = [
  {
    route: 'foo',
    method: Method.Get,
    controller: ControllerClass,
    function: 'getOne',
  },
];

ear.add(routes, '/api/v1');

getRoutes()

Method that return a Router object (Express.js Router) with the routes added by add method.

Example

const router: Router = ear.getRoutes();
app.use(router);

createRoutes(routes,prefix)

Function that under the hood utilize ExpressAwesomeRoutes class to create and get routes (Router) without call the above methods.

Arguments (Typed)

add(routes: Routes): Router
add(routes: Routes, prefix: string): Router
add(routes: Routes, prefix: string, middlewares: any[]): Router

Example

import { createRoutes, Method } from 'express-awesome-routes';
// imports, express instance, etc.

const routes: Routes = [
  {
    route: 'foo',
    method: Method.Get,
    controller: ControllerClass,
    function: 'getOne',
  },
];

const router: Router = createRoutes(routes);
app.use(router);

License

MIT