ed

express-derouter

help you use Decorators to define express routes

Showing:

Popularity

Downloads/wk

0

GitHub Stars

3

Maintenance

Last Commit

4yrs ago

Contributors

0

Package

Dependencies

2

Size (min+gzip)

230.0KB

License

MIT

Type Definitions

Tree-Shakeable

Yes?

Categories

Readme

express-derouter

Help you use Decorators to define express routes

An achieve package of my blog —— 关于express路由管理的几种自动化方法

Travis

Usage

Install

$ npm install express-derouter --save
or
$ yarn add express-derouter

Register App

require('babel-register')
const express = require('express')
const path = require('path')
const app = express()

require('express-derouter').register({
  app,
  routesDir: path.join(__dirname, 'routes')
})

The register method receive a object contain 2 fields:

  • app {express.Application} - the express app object
  • routesDir {string|Array<string>} - the router's dir need scan (only need the root route dir, and express-derouter will require all the js file)

the register method only need to call once!

Use Decorators

You can use express-derouter's derotators in your router files.

const {Router, Get, Post, Put, Delete, All, Custom} = require('express-derouter')

@Router('/', ...middleawares)
class IndexController {
  @Get('/', ...middleawares)
  get (req, res, next) {
    res.send('get /')
  }

  @Post('/', ...middleawares)
  post (req, res, next) {
    res.send('post /')
  }

  @Put('/', ...middleawares)
  put (req, res, next) {
    res.send('put /')
  }

  @Delete('/', ...middleawares)
  delete (req, res, next) {
    res.send('delete /')
  }

  @All('/all', ...middleawares)
  all (req, res, next) {
    res.send('all /all')
  }

  @Custom('options', '/custom', ...middleawares)
  custom (req, res, next) {
    res.send('options /custom')
  }
}

module.exports = IndexController

Router

The Router decorators is used on class,and receive the first argument as the router path.

Get, Post, Put, Delete, All

Equals to the express method get, post, put, delete, all, use them to decide the class method should be access by which http method and what path.

Custom

Use Custom decorators, you can use the custom http method which express support on your class methods.

All the decorators can receive custom quantity of function as the front middleware of the class method handler or the class router.

Tests

To run the test suite, first install the dependencies, then run npm test:

$ git clone https://github.com/kainstar/express-derouter.git ./express-derouter
$ cd ./express-derouter
$ npm install
$ npm test

License

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100