ama-express-decorator v1.1.1

Express decorator

a light-weight module to build TypeScript application with Express decorators

Install

npm install express-decorator

Features

• Use @Path to register express route for class.
• Use @GET/@DELETE/@POST/@PUT to register sub-route path for a method,
• Inject request parameters from @PathParam/@QueryParam/@FormParam/CookieParam/HeaderParam
• Inject Request,Response From express request.
• Support inject midware.

Quick Start

Create firsr restfult service.

@Path('/user', [ testMidware2 ])
export class UserService {

    @GET('/:id', [ testMidware1 ])
    list( @PathParam('id') id: string, @QueryParam('name') name: string) {
        return [id, name]
    }

    @DELETE('/:id')
    delete( @PathParam('id') id) {
        return [id];
    }

    @POST('')
    create( @FormParam('user') user) {
        return user;
    }

    @PUT('')
    update( @FormParam('user') user, @Response response, @Requst request) {
        ...
        return user;
    }

    @GET('/test/cookie')
    testCookie( @CookieParam('name') p1, @CookieParam('xx') p2) {

        return Promise.resolve([p1, p2]);
    }

    @GET('/test/header')
    testHeader( @HeaderParam('Cookie') p1, @HeaderParam('User-Agent') p2) {

        return Promise.resolve([p1, p2]);
    }
} 

// midware
function testMidware1(req, res, next) {
    req.body.test1 = "test1"
    next();
}

function testMidware2(req, res, next) {
    req.body.test2 = "test2"
    next();
}

Register your service class

var app = express();

app.get('/', function (req, res) {
    res.send('Hello World!');
});

RegisterController(app, [UserService]);

var server = app.listen(3000, function () {
    var host = server.address().address;
    var port = server.address().port;

    console.log('Example app listening at http://%s:%s', host, port);
})

API

• Path(baseUrl: string, midwares?:Funtion[])
• GET(subUrl: string, midwares?:Funtion[])
• DELETE(subUrl: string, midwares?:Funtion[])
• POST(subUrl: string, midwares?:Funtion[])
• DELETE(subUrl: string, midwares?:Funtion[])
• PathParam(paramName: string)
• QueryParam(paramName: string)
• FormParam(paramName: string)
• CookieParam(paramName: string)
• HeaderParam(paramName: string)
• Reqeust
• Response
• RegisterService(expressInstance, services:any[])