simple-express-ts

Status	Branch
Master
Dev

simple-express-ts is a wrapper for express with typescript decorators, and that's all, no additional dependencies.

I wrote this to avoid using huge frameworks that allow to do the same while having billions features that sometimes I don't need at all.

Install

simple-express-ts wraps express and its types, so you only need to install this to have

Express
Express types
Express typescript decorators

Install with npm

npm install simple-express-ts

or with yarn

yarn add simple-express-ts

Usage

Controller class:

import { ExpressController, Get } from 'simple-express-ts';
import { Request, Response } from 'express';

@ExpressController('/controller')
export class Controller {

    @Get('/test')
    private async testRoute(req: Request, res: Response){
        res.sendStatus(200);
    }

}

Index file:

import { ExpressServer } from 'simple-express-ts';
import { Controller } from './controller';

const server = new ExpressServer({
    port: 7777,
    controllers: [Controller]
});
server.start();

Running your compiled index at this point, you should be able to obtain an OK response on http://localhost:3000/controller/test

Using middlewares on server

You can specify middlewares while building express server

import { ExpressServer } from 'simple-express-ts';
import { Controller } from './controller';
import bodyParser = require('body-parser');

const server = new ExpressServer({
    port: 3000,
    controllers: [Controller],
    middlewares: [bodyParser.json(), bodyParser.urlencoded({ extended: true })]
});
server.start();

Using middlewares on controllers

import { ExpressController, ExpressControllerMiddleware, Get } from 'simple-express-ts';
import { Request, Response, NextFunction } from 'express';

@ExpressController('/controller')
@ExpressControllerMiddleware((req: Request, res: Response, next: NextFunction) => {
    if (req.query.code !== '12345') res.sendStatus(401);
    else next();
})
export class Controller {

    @Get('/secret')
    private getSecret(req: Request, res: Response){
        res.send('Secret!');
    }

}

Using middlewares on routes

import { ExpressController, Get, Middleware } from 'simple-express-ts';
import { Request, Response, NextFunction } from 'express';

@ExpressController('/controller')
export class Controller {

    @Middleware((req: Request, res: Response, next: NextFunction) => {
        req.params.value = 'Ulp!';
        next();
    })
    @Get('/testMiddleware')
    private async testMiddleware(req: Request, res: Response){
        const { value } = req.params;
        res.send({ value }); // Ulp!
    }

}

Using HTTPS

import { ExpressServer } from 'simple-express-ts';
import { Controller } from './controller';

const server = new ExpressServer({
    httpPort: 3000,
    httpsPort: 3001,
    controllers: [Controller],
    httpsOptions: {
        cert: 'Your certificate here',
        key: 'Your key here'
    }
});
server.start();

tiziofittizio / simple-express-ts Goto Github PK