Package Exports
- koa-final-response
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (koa-final-response) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
koa-final-response
The very outer middleware of Koa to handle every response of every request.
Usage
Installation
yarn add koa-final-response or npm install koa-final-response --save
Example
const path = require('path');
// Error object, see https://github.com/hapijs/boom
// We recommand to use Boom as the standard object for error responses
const Boom = require('boom');
const Koa = require('koa');
const mountRoutes = require('koa-mount-routes');
const finalResp = require('koa-final-response');
const app = new Koa();
// this middleware should be added before router works
app.use(finalResp({ env: process.env.NODE_ENV || 'development' }));
// mount routes, see https://github.com/Maples7/koa-mount-routes
mountRoutes(app, path.join(__dirname, 'controllers'), {
allowedMethods: {
throw: true,
notImplemented: () => {
throw Boom.notImplemented('HTTP method for this API is not implemented');
},
methodNotAllowed: () => {
throw Boom.methodNotAllowed('HTTP method for this API is not allowed');
}
}
});
app.listen(3000);How to return results
For normal responses, you can pass your result data to
ctx.bodydirectly just following the standard Koa way;For error responses, we recommend you use Boom to pass those expected errors like
throw Boom.unauthorized('invalid password'). Besides, any unexpected errors and non-Boom errors thrown by yourself will also be catched and handled well as you want.
Responses
Normal response
{ "success": true, "data": .... // what you assign to `ctx.body` }
Error response
{ "success": false, "error": "Method Not Allowed", // HTTP error correlated to HTTP statusCode "message": "HTTP method for this API is not allowed" // error message }
404 response
{ "success": false, "error": "Not Found", "message": "API Not Found" }
API
app.use(
finalResp({
env, // String. you can pass environmental variable such as NODE_ENV to it. if it is `production`, we will not return error details to user but a vague error messege like `An internal server error occurred`. Default value: 'production'.
errStatusCodePropertie // Array. it is about where to find HTTP Status Code of response while an error is thrown. We will search a valid number from property of Error Object in order. Default value: ['statusCode', 'status', 'code']. And the default HTTP Status Code for error response is 500.
logger // Object/`false`. You can pass a logger here or let `ctx.log` point to a logger to log requests error such as `console` or any other logger with function `error` inside. If you want disable error log anyway, pass `false`. Default value: null.
})
);You are welcomed to review test.js and controllers dir in this project for more information of usage.