How to specify HTTP error code using Express.js?

Question

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.

My answer to a related question could help: http://stackoverflow.com/questions/10170857/can-i-reuse-the-express-js-error-view/10556093#10556093 — Pickels, May 12 '12 at 19:36
Does this answer your question? [How to programmatically send a 404 response with Express/Node?](https://stackoverflow.com/questions/8393275/how-to-programmatically-send-a-404-response-with-express-node) — Henke, Jun 29 '21 at 12:55

Dan Mandle · Accepted Answer · 2014-10-14T22:05:11.300

415

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');

edited Oct 14 '14 at 22:05

answered Apr 30 '14 at 17:19

Dan Mandle

5,608
3
23
26

63

+1 for using the latest version of the API. If you want to send more down the wire, just chain: `res.status(400).json({ error: 'message' })` – TyMayn Sep 23 '14 at 04:15
What about if I don't have a response variable? In a mongoose validation I have to rise an error `done(new Error('My error text'))` – Mikel Jun 06 '17 at 14:09
1

@Mikel if you don't have a response variable, then you can't sent a response. – Dan Mandle Jun 06 '17 at 17:32
5

This is all deprecated now, you should use `res.sendStatus(401);`. – Cipi Jun 16 '17 at 16:50
1

This response would be a lot more complete if it ended with `res.send('Then you shall die')`. – goodvibration Jun 22 '18 at 08:46
1

@Cipi Do you have a source for that? The documentation doesn't indicate `.status()` is deprecated. `.sendStatus()` is just a shorthand for `.status(code).send(codeName)` where the `codeName` is the standard HTTP response text for the given `code`. – James Coyle May 20 '19 at 10:03
@JamesCoyle My comment was related for a relevant version of Express for year 2017. – Cipi May 22 '19 at 16:24
I was surprised that `res.status(400).json(new Error('message'))` did not work. The result was an empty JSON object `{}`. Instead, use TyMayn's comment of `res.status(400).json({ error: 'message' })` – PatS Jan 30 '22 at 15:10

score 118 · Answer 2 · answered Feb 16 '15 at 18:18

118

A simple one liner;

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

answered Feb 16 '15 at 18:18

Mike P

2,797
2
21
25

score 44 · Answer 3 · answered Sep 24 '17 at 11:38

44

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);

answered Sep 24 '17 at 11:38

Manuel Spigolon

11,003
5
50
73

great solution but this gives me UnhandledPromiseRejectionWarning error. How to make sure the errors are handled in our error middleware – Rahul Purohit Dec 14 '21 at 23:36
async/await is not supported out of the box by express, try this https://github.com/fastify/fastify – Manuel Spigolon Dec 15 '21 at 07:59
`throw` works only if the route is synchronous. If it's an async route, you have to manually call `next()`. I suppose (but haven't tried) you could just pass the same object you show in `throw` but to `next()`. – Mitya Jul 02 '23 at 14:04

score 21 · Answer 4 · answered Feb 21 '17 at 14:27

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')

score 19 · Answer 5 · answered May 12 '12 at 13:42

19

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

answered May 12 '12 at 13:42

Mustafa

10,013
10
70
116

1

But I want the error code to be sent to eventHandler middleware, so express's custom error page be displayed. – tech-man May 12 '12 at 14:05
18

For anyone reading this in 2016: As per Express 4.x, `res.send(404)` is deprecated. It's now `res.sendStatus(404)`. http://expressjs.com/en/api.html#res.sendStatus – 0xRm Jun 28 '16 at 06:35

score 13 · Answer 6 · answered Nov 11 '14 at 15:00

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);
}

score 11 · Answer 7 · answered Aug 10 '12 at 02:02

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.

score 11 · Answer 8 · edited Dec 13 '19 at 10:48

11

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);

edited Dec 13 '19 at 10:48

Pathik Vejani

4,263
8
57
98

answered Aug 24 '19 at 17:53

Tarun Rawat

244
3
9

webarnes · Answer 9 · 2013-09-24T16:21:09.483

9

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'));

edited Sep 24 '13 at 16:21

answered Sep 24 '13 at 15:25

webarnes

111
1
2

What is does next do? – Stephan Kristyn Sep 30 '14 at 15:32
`next` is calling next handler which in express.js usually are trying to render error pages. – Firanto Aug 18 '15 at 11:46

score 8 · Answer 10 · edited Sep 10 '22 at 12:17

8

Express deprecated res.send(body, status).

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

edited Sep 10 '22 at 12:17

Enginer

3,048
1
26
22

answered Dec 24 '17 at 12:34

Rajeev Jayaswal

1,423
1
20
22

Thanks. Wokring with warning of middlewares. – Ashok Jan 12 '23 at 12:59

score 2 · Answer 11 · answered Feb 23 '23 at 11:19

2

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

res.status(200).send();

answered Feb 23 '23 at 11:19

mDeram

69
1
9

score 0 · Answer 12 · answered Jun 25 '18 at 23:41

0

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

answered Jun 25 '18 at 23:41

JoeTidee

24,754
25
104
149

score 0 · Answer 13 · answered Sep 03 '21 at 00:05

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();

How to specify HTTP error code using Express.js?

13 Answers13

Linked