Skip to content
This repository has been archived by the owner on Aug 21, 2022. It is now read-only.

Add exposeAdditionalProperties option #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
Expand Up @@ -30,7 +30,9 @@ app.use('/api', api);

### .use(errorHandler([options]))

Currently no options.
Options:

- `exposeAdditionalProperties` - If truthy will expose any additional properties found on client errors.

### Errors

Expand Down
10 changes: 9 additions & 1 deletion index.js
Expand Up @@ -3,7 +3,9 @@ var statuses = require('statuses');

var production = process.env.NODE_ENV === 'production';

module.exports = function () {
module.exports = function (options) {
options = options || {}

return function apiErrorHandler(err, req, res, next) {
var status = err.status || err.statusCode || 500;
if (status < 400) status = 500;
Expand Down Expand Up @@ -32,6 +34,12 @@ module.exports = function () {
if (err.name) body.name = err.name;
if (err.type) body.type = err.type;

if (options.exposeAdditionalProperties) {
for (var key in err) {
if (err.hasOwnProperty(key) && !(key in body)) body[key] = err[key]
}
}

res.json(body);
}
}
20 changes: 20 additions & 0 deletions test/test.js
Expand Up @@ -51,4 +51,24 @@ describe('API Error Handler', function () {
done();
})
})

it('exposeAdditionalProperties', function (done) {
var app = express();
app.use(function (req, res, next) {
next(error(401, { foobar: 123 }));
});
app.use(handler({ exposeAdditionalProperties: true }));

request(app.listen())
.get('/')
.expect(401)
.end(function (err, res) {
assert.ifError(err);

var body = res.body;
assert.equal(body.foobar, 123);
assert.equal(body.status, 401);
done();
})
})
})