@gsilber/express-ts-framework

express-ts-framework

express-ts-framework is a typescript application framework for nodejs and express

Installation

Use the package manager npm to install express-ts-framework.

npm install --save express-ts-framework

Creating a router

To create a router construct an EFCRouter instance passing in an array of Route structures.

export enum METHODS{GET,PUT,DELETE,POST};

export class Route{
    path: string;
    method: METHODS;
    middleware: [function];     // (req,res,next)=>{}
    callback:[function];        // (req,res,next)=>{}
}

There are two primary ways to use this framework.

Simple Instance

Simply create an object of EFCApp, attach 1 or more routers to it, and call startServer.

const route:Route[]=[
    {[path:'/',method:METHODS.GET,middleware:[],callback:[(r,s,n)=>s.send('root')]]},
    {[path:'/t',method:METHODS.GET,middleware:[],callback:[(r,s,n)=>s.send('t')]]}
];
//put on port 3000 and use '/api' as the root
const app:EFCApp=new EFCApp(3000,'/api');
app.AddRouter(new EFCRouter('/test',route));
app.startServer("server name");

Note: This server is now listening on port 3000 for the routes /api/test and /api/test/t.

More complex

You can override the app and router classes in your own code to get lifecycle hooks and inject default values.

    onBeforeInit():void     : Override to modify before initialization
    onSetupComplete():void  : Called when framework is fully loaded
    initCors(): void        : Default disables CORS.  Override to change behavior

License

GPL