Skip to content

Latest commit

 

History

History
103 lines (84 loc) · 2.52 KB

README.md

File metadata and controls

103 lines (84 loc) · 2.52 KB
Raw

express-custom-response

Create custom response methods for express.js.

Getting Started

Install the module with: npm install https://github.com/SteffenLanger/express-custom-response.

##Quick Start

require('express-custom-response')();

Documentation

The module contains pre-defined custom responses:

res.serverError (message, extraData)

  • mixed data
  • Any data that have to be returned to the user

return response with http code 500 and body:

error: {
    message: 'The database failed to respond.',
	extraData: null or extraData
	}

res.badRequest (message, extraData)

  • string message
  • Message why the user's request could not be processed
  • mixed extraData
  • Any data that have to be returned to the user

return response with http code 400 and body:

error: {
    message: 'Validation failed',
	fields: {email: 'Email has to be unique'},
	extraData: null or extraData
}

res.forbidden (message, extraData)

  • object message
  • Message why the user's request was forbidden
  • mixed extraData
  • Any data that have to be returned to the user

return response with http code 403 and body:

error: {
    message: 'The user does not have enough permissions to access this file.',
	extraData: null or extraData
}

res.notFound (uri, extraData)

  • string uri
  • The URI the server cannot find
  • mixed extraData
  • Any data that have to be returned to the user

return response with http code 404 and body:

error: {
    message: 'User not found',
	code: 404,
	extraData: null or extraData
}

res.ok (extraData)

  • mixed extraData
  • Any data that have to be returned to the user

return response with http code 200 and body:

{} or extraData

Create your own response

If you want to add your own responses you can pass the absolute path of the directory to the module constructor:

require('express-custom-response')(__dirname+ '/api/responses');

Then each script in this directory will be available as a response method. The method's name equals the file name. Example:

/** 
 * api/responses/accepted.js
 *
 * This will be available in controllers as res.accepted(message);
 */

module.exports = function(message) {
    //"this" points to express.response
	this.status(202);
	this.send(message);
}

If you want to override existing pre-defined responses, simply add a new script to your directory with the name of the response which you want to override.