tech-man
tech-man

Reputation: 3246

How to specify HTTP error code using Express.js?

I have tried:

app.get('/', function(req, res, next) {
    var e = new Error('error message');
    e.status = 400;
    next(e);
});

and:

app.get('/', function(req, res, next) {
    res.statusCode = 400;
    var e = new Error('error message');
    next(e);
});

but always an error code of 500 is announced.

Upvotes: 258

Views: 407448

Answers (13)

mDeram
mDeram

Reputation: 91

If you want to send the status code without its string representation you can do:

res.status(200).send();

Upvotes: 3

Rajeev Jayaswal
Rajeev Jayaswal

Reputation: 1501

Express deprecated res.send(body, status).

Use res.status(status).send(body) or res.sendStatus(status) instead

Upvotes: 8

Mr.B
Mr.B

Reputation: 3787

Async way:

  myNodeJs.processAsync(pays)
        .then((result) => {
            myLog.logger.info('API 200 OK');
            res.statusCode = 200;
            res.json(result);
            myLog.logger.response(result);
        })
        .fail((error) => {
            if (error instanceof myTypes.types.MyError) {
                log.logger.info(`My Custom Error:${error.toString()}`);
                res.statusCode = 400;
                res.json(error);
            } else {
                log.logger.error(error);
                res.statusCode = 500;
                // it seems standard errors do not go properly into json by themselves
                res.json({
                    name: error.name,
                    message: error.message
                });
            }
            log.logger.response(error);
        })
        .done();

Upvotes: 0

Tarun Rawat
Tarun Rawat

Reputation: 254

I tried

res.status(400);
res.send('message');

..but it was giving me error:

(node:208) UnhandledPromiseRejectionWarning: Error: Can't set headers after they are sent.

This work for me

res.status(400).send(yourMessage);

Upvotes: 11

JoeTidee
JoeTidee

Reputation: 26044

I would recommend handling the sending of http error codes by using the Boom package.

Upvotes: 0

Manuel Spigolon
Manuel Spigolon

Reputation: 12870

I'd like to centralize the creation of the error response in this way:

app.get('/test', function(req, res){
  throw {status: 500, message: 'detailed message'};
});

app.use(function (err, req, res, next) {
  res.status(err.status || 500).json({status: err.status, message: err.message})
});

So I have always the same error output format.

PS: of course you could create an object to extend the standard error like this:

const AppError = require('./lib/app-error');
app.get('/test', function(req, res){
  throw new AppError('Detail Message', 500)
});

'use strict';

module.exports = function AppError(message, httpStatus) {
  Error.captureStackTrace(this, this.constructor);
  this.name = this.constructor.name;
  this.message = message;
  this.status = httpStatus;
};

require('util').inherits(module.exports, Error);

Upvotes: 46

Steven Spungin
Steven Spungin

Reputation: 29081

In express 4.0 they got it right :)

res.sendStatus(statusCode)
// Sets the response HTTP status code to statusCode and send its string representation as the response body.

res.sendStatus(200); // equivalent to res.status(200).send('OK')
res.sendStatus(403); // equivalent to res.status(403).send('Forbidden')
res.sendStatus(404); // equivalent to res.status(404).send('Not Found')
res.sendStatus(500); // equivalent to res.status(500).send('Internal Server Error')

//If an unsupported status code is specified, the HTTP status is still set to statusCode and the string version of the code is sent as the response body.

res.sendStatus(2000); // equivalent to res.status(2000).send('2000')

Upvotes: 22

Mike P
Mike P

Reputation: 2877

A simple one liner;

res.status(404).send("Oh uh, something went wrong");

Upvotes: 122

Ido Ran
Ido Ran

Reputation: 11374

From what I saw in Express 4.0 this works for me. This is example of authentication required middleware.

function apiDemandLoggedIn(req, res, next) {

    // if user is authenticated in the session, carry on
    console.log('isAuth', req.isAuthenticated(), req.user);
    if (req.isAuthenticated())
        return next();

    // If not return 401 response which means unauthroized.
    var err = new Error();
    err.status = 401;
    next(err);
}

Upvotes: 13

Dan Mandle
Dan Mandle

Reputation: 5839

Per the Express (Version 4+) docs, you can use:

res.status(400);
res.send('None shall pass');

http://expressjs.com/4x/api.html#res.status

<=3.8

res.statusCode = 401;
res.send('None shall pass');

Upvotes: 430

webarnes
webarnes

Reputation: 111

Old question, but still coming up on Google. In the current version of Express (3.4.0), you can alter res.statusCode before calling next(err):

res.statusCode = 404;
next(new Error('File not found'));

Upvotes: 9

catphive
catphive

Reputation: 3541

The version of the errorHandler middleware bundled with some (perhaps older?) versions of express seems to have the status code hardcoded. The version documented here: http://www.senchalabs.org/connect/errorHandler.html on the other hand lets you do what you are trying to do. So, perhaps trying upgrading to the latest version of express/connect.

Upvotes: 11

Mustafa
Mustafa

Reputation: 10413

You can use res.send('OMG :(', 404); just res.send(404);

Upvotes: 19

Related Questions