http: docs-only deprecation of res.writeHeader()

Doc-only deprecation of the undocumented res.writeHeader() API. Also makes res.writeHeader an alias of res.writeHead since the previous implementation simply deferred to that method. PR-URL: #11355 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rod Vagg <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]>
nodejs · Feb 25, 2017 · fb71ba4 · fb71ba4
1 parent d4e1eaf
commit fb71ba4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
@@ -523,6 +523,17 @@ Type: Runtime
 of V8 5.8. It is replaced by Inspector which is activated with `--inspect`
 instead.
 
+<a id="DEP0063"></a>
+#### DEP0063: ServerResponse.prototype.writeHeader()
+
+Type: Documentation-only
+
+The `http` module `ServerResponse.prototype.writeHeader()` API has been
+deprecated. Please use `ServerResponse.prototype.writeHead()` instead.
+
+*Note*: The `ServerResponse.prototype.writeHeader()` method was never documented
+as an officially supported API.
+
 [alloc]: buffer.html#buffer_class_method_buffer_alloc_size_fill_encoding
 [alloc_unsafe_size]: buffer.html#buffer_class_method_buffer_allocunsafe_size
 [`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size

diff --git a/lib/_http_server.js b/lib/_http_server.js
@@ -231,9 +231,8 @@ function writeHead(statusCode, reason, obj) {
  this._storeHeader(statusLine, headers);
 }
 
-ServerResponse.prototype.writeHeader = function writeHeader() {
- this.writeHead.apply(this, arguments);
-};
+// Docs-only deprecated: DEP0063
+ServerResponse.prototype.writeHeader = ServerResponse.prototype.writeHead;
 
 
 function Server(requestListener) {