express-routes-manager-v1

    1.1.7 • Public • Published

    Build Status Greenkeeper badge npm version

    What is it ?

    This will help to create express routes and keep it organized.

    Motivation

    I love to to keep my code splitted, and this is a nice way to manage it and to not get lost
    while making all the routes and to keep it clean !

    How to use ?

    Install the package

    npm install express-routes-manager-v1

    lets imagine you have a class with some routes :

    import BaseConstroller from 'express-routes-manager-v1'
     
    export class MainRoutes extends BaseController {
        constructor(){
            super()
        }
     
        static routes: Route[] = [
            {path: '/', action: 'index', verb: 'get'},
            {path: '/user', action: 'getUser', verb: 'get'},
            {path: '/delete', action: 'deleteUsers', verb: 'delete'},
            {path: '/update', action: 'updateUsers', verb: 'patch'},
            {path: '/comment', action: 'commentUser', verb: 'post'},
        ]
     
        private index = (req: Request, res: Response) => {
            // do something
        }
     
        private getUser = (req: Request, res: Response) => {
            // do something
        }
     
        private deleteUsers = (req: Request, res: Response) => {
            // do something
        }
     
        private updateUsers = (req: Request, res: Response) => {
            // do something
        }
     
        private commentUser = (req: Request, res: Response) => {
            // do something
        }    
    }

    Somewhere else in your code where you manage your server config :

    import { MainRoutes } from "../your/path"
    import { SomeOtherRoutes } from "../your/path"
    import { Router } from 'express'
     
    const router = Router()
     
    const mains = new MainRoutes() 
    const connectedRoutes = MainRoutes.connect(router, mains);
     
    const others = new SomeOtherRoutes() 
    const connecteOthersRoutes = SomeOtherRoutes.connect(router, others);
     
    export {
        connecteOthersRoutes,
            connectedRoutes
    }

    In another file to boot the server

    import * as express from 'express'
    import * as myRoutes from '../path/to/your/routes/'
     
    const app = express()
     
    app.use(myRoutes)
     
    app.listen(4000, () => {
        console.log('> Server listening to port ' + 4000)
    })

    CONTRIBUTING

    • ⇄ Pull requests and ★ Stars are always welcome.
    • For bugs and feature requests, please create an issue.

    Install

    npm i express-routes-manager-v1

    DownloadsWeekly Downloads

    3

    Version

    1.1.7

    License

    MIT

    Unpacked Size

    11.4 kB

    Total Files

    8

    Last publish

    Collaborators

    • jsparanoguy