express-booter

Express routes booter and middlewares

Install

npm i express-booter

Usage

Boot routes

const { boot } = require('express-booter');
boot('path/to/routes', router, options);

Boot options

const options = {
  filter: f => /\.js$/.test(f),
  cb: route => console.log(route.method, route.url),
  safe: false
};

Route definition

module.exports = {
  name: '/users',
  // top level middlewares
  middlewares: [
    (req, res, next) => {
      // TODO:
    }
  ],

  list: {
    name: '/',
    method: 'get',
    // handler level middlewares
    middlewares: [
      (req, res, next) => {
        // TODO:
      }
    ],
    handler(req, res, next) {
      // TODO:
    }
  },

  get: {
    name: '/:id',
    method: 'get',
    handler(req, res, next) {
      // TODO:
    }
  },

  create: {
    name: '/',
    method: 'post',
    handler(req, res, next) {
      // TODO:
    }
  }
};

Guards

const { guards } = require('express-booter');
// Validate fielda in request body
router.use(guards.body(['name', 'type']));
router.use(guards.body({ name: '名字', type: '类型' }));
router.use(guards.body({ name: data => data.length > 5 }));
router.use(
  guards.body({
    name: { message: 'Name cannot be empty' }
  })
);
router.use(
  guards.body({
    name: { validator: data => data.length > 5, message: 'Name must contain at least 5 characters' }
  })
);
// Validate fields in request query strings
router.use(guards.queries(options));
// Validate fields in request headers
router.use(guards.headers(options));
// Validate fields in request parameters
router.use(guards.params(options));
// Success if current running NODE_ENV maches any
router.use(guards.env('development', 'test'));
// Extract user entity from request
router.use(guards.auth(expander));
// Parse pagination options from query string
router.use(guards.pagination(options));
// Parse filter options from query string
router.use(guards.filter(options));
// Parse sort options from query string
router.use(guards.sort(options));
// Parse projection options from query string
router.use(guards.projection(options));
// Check authorization header
router.use(guards.access(options));

Errors

const { errors } = require('express-booter');
// 400
throw new errors.BadRequest(message);
// 401
throw new errors.Unauthorized(message);
// 403
throw new errors.Forbidden(message);
// 404
throw new errors.NotFound(message);
// 409
throw new errors.Conflict(message);
// 410
throw new errors.Expired(message);
// 500
throw new errors.Internal(message);
// 501
throw new errors.NotImplemented(message);

Test

npm test

License

See License