Deprecate combined status, response signatures

closes expressjs#2227

Author: dougwilson

History.md

@@ -6,6 +6,9 @@ unreleased
     - `app.set('query parser', 'simple')` parse with "querystring" core module
     - `app.set('query parser', false)` disable query string parsing
     - `app.set('query parser', true)` enable simple parsing
+  * deprecate `res.json(status, obj)` -- use `res.status(status).json(obj)` instead
+  * deprecate `res.jsonp(status, obj)` -- use `res.status(status).jsonp(obj)` instead
+  * deprecate `res.send(status, body)` -- use `res.status(status).send(body)` instead
   * deps: [email protected]
   * deps: [email protected]
     - Respond after request fully read

lib/response.js

@@ -72,9 +72,8 @@ res.links = function(links){
  *     res.send(new Buffer('wahoo'));
  *     res.send({ some: 'json' });
  *     res.send('<p>some html</p>');
- *     res.send(404, 'Sorry, cant find that');
- *     res.send(404);
  *
+ * @param {string|number|boolean|object|Buffer} body
  * @api public
  */
 
@@ -92,9 +91,10 @@ res.send = function send(body) {
   if (arguments.length === 2) {
     // res.send(body, status) backwards compat
     if (typeof arguments[0] !== 'number' && typeof arguments[1] === 'number') {
-      deprecate('res.send(body, status): Use res.send(status, body) instead');
+      deprecate('res.send(body, status): Use res.status(status).send(body) instead');
       this.statusCode = arguments[1];
     } else {
+      deprecate('res.send(status, body): Use res.status(status).send(body) instead');
       this.statusCode = arguments[0];
       chunk = arguments[1];
     }
@@ -107,6 +107,7 @@ res.send = function send(body) {
       this.type('txt');
     }
 
+    deprecate('res.send(status): Use res.status(status).end() instead');
     this.statusCode = chunk;
     chunk = http.STATUS_CODES[chunk];
   }
@@ -197,9 +198,8 @@ res.send = function send(body) {
  *
  *     res.json(null);
  *     res.json({ user: 'tj' });
- *     res.json(500, 'oh noes!');
- *     res.json(404, 'I dont have that');
  *
+ * @param {string|number|boolean|object} obj
  * @api public
  */
 
@@ -210,13 +210,10 @@ res.json = function json(obj) {
   if (arguments.length === 2) {
     // res.json(body, status) backwards compat
     if (typeof arguments[1] === 'number') {
+      deprecate('res.json(obj, status): Use res.status(status).json(obj) instead');
       this.statusCode = arguments[1];
-      if (typeof arguments[0] === 'number') {
-        deprecate('res.json(obj, status): Use res.json(status, obj) instead');
-      } else {
-        deprecate('res.json(num, status): Use res.status(status).json(num) instead');
-      }
     } else {
+      deprecate('res.json(status, obj): Use res.status(status).json(obj) instead');
       this.statusCode = arguments[0];
       val = arguments[1];
     }
@@ -243,9 +240,8 @@ res.json = function json(obj) {
  *
  *     res.jsonp(null);
  *     res.jsonp({ user: 'tj' });
- *     res.jsonp(500, 'oh noes!');
- *     res.jsonp(404, 'I dont have that');
  *
+ * @param {string|number|boolean|object} obj
  * @api public
  */
 
@@ -256,13 +252,10 @@ res.jsonp = function jsonp(obj) {
   if (arguments.length === 2) {
     // res.json(body, status) backwards compat
     if (typeof arguments[1] === 'number') {
+      deprecate('res.jsonp(obj, status): Use res.status(status).json(obj) instead');
       this.statusCode = arguments[1];
-      if (typeof arguments[0] === 'number') {
-        deprecate('res.jsonp(obj, status): Use res.jsonp(status, obj) instead');
-      } else {
-        deprecate('res.jsonp(num, status): Use res.status(status).jsonp(num) instead');
-      }
     } else {
+      deprecate('res.jsonp(status, obj): Use res.status(status).jsonp(obj) instead');
       this.statusCode = arguments[0];
       val = arguments[1];
     }