Giter Club home page Giter Club logo

easy-router-express's Introduction

easy-router-express

easy-router-express is writed for building a easy router for express

Support

  • Express

Installation

npm install easy-router-express
# or yarn
yarn add easy-router-express

Getting started

Use in Express

EasyRouter(app, router, options, ...params)

app

const app = new require('express')()

router

const router = new require('express').Router()

options

Attribute Description Type Default
Path Router Folder 's Path String `${__dirname}/router`
Prefix Router 's Prefix String Null
Proxy Router 's Proxy Object/Array Null

Proxy

Attribute Type Example
method String 'POST'
Func Function (req, res, next) => { next() }

Example

server.js

const Express = require('express')
const EasyRouter = require('easy-router-express')
const app = new Express()
const router = new Express.Router()
const path = __dirname + '/router'

EasyRouter(app, router, {
  path,
  prefix: '/api',
  proxy: {
    method: 'POST',
    func (req, res, next) {
      next()
    }
  }
})

app.listen(3000, () => {
  console.log('please visit http://localhost:3000')
})

router/demo.js

module.exports = (router) => {
  router.get('/test', (req, res) => {
    console.log('this is a demo')
    res.status(200).send('OK')
  })
}

easy-router-express's People

Contributors

ruofee avatar

Watchers

 avatar

easy-router-express's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.