decorate-express

decorate-express

This is a fork of @stewartml's no longer actively maintained express-decorators package.

Decorators for easily wiring up controller classes to Express routes.

Installation

$ npm install --save decorate-express

Example

import { BasePath, Get, Use, registerRoutes } from 'decorate-express'
import myMiddlewareFunction from './middleware'
import express from 'express'

@BasePath('/test')
public class TestController {
  constructor(target) {
    this.target = target
  }

  @Get('/hello', myMiddlewareFunction)
  async sayHelloAction(request, response) {
    response.send(`Hello, ${this.target}!`)
  }

  @Use()
  async otherMiddleware(request, response, next) {
    // This middleware will be called for every action.
    next()
  }
}

let app = express()
let test = new TestController('world')
registerRoutes(app, test)

When can now go to /test/hello and get Hello, world! back.

Notes

• Actions are called with the correct context (i.e. this is an instance of the class).
• Actions can return Promise's or be async functions and errors will get handled properly.

API

@BasePath(path: string)

Class decorator to add a base path to every route defined in the class.

@Middleware(fn: Middleware)

If fn is a function, then the function is added as route-specific middleware for the action. Note that the middleware will be bound to the controller instance.

If fn is a string, then the method with that name will be exectued as route-specific middleware when the action is invoked.

@Param(param: string)

Marks the method as a handler for all routes that use the specified parameter. This can be useful if you want to do something with it before it's passed on to the actual route handler, for example converting a string to an integer:

@Param('id')
idParam(request, response, next, id) {
  request.params.id = parseInt(request.params.id)
  next()
}

@Route(method: string, path: string, middleware: Middleware[])

Marks the method as a handler for the specified path and HTTP method.

HTTP method shortcuts

Instead of passing the HTTP method into the @Route decorator you can also use one of the provided shortcuts. @Get('/path') for example is equivalent to @Route('get', '/path').

• @All
• @Delete
• @Get
• @Options
• @Patch
• @Post
• @Put
• @Use

getRoutes(target: Object): Route[]

Gets the route metadata for the target object. Paths are automatically prefixed with a base path if one was defined.

registerRoutes(router: Express.Router, target: Object)

Registers the routes found on the target object with an express Router instance.

Questions, comments?

Please feel free to start an issue or offer a pull request.