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

jasnell · jasnell · commit fb71ba49212d · 2017-02-24T18:05:52.000-08:00
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 <cjihrig@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
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) {

Original file line number	Diff line number	Diff line change
`@@ -231,9 +231,8 @@ function writeHead(statusCode, reason, obj) {`
`231`	`231`	`this._storeHeader(statusLine, headers);`
`232`	`232`	`}`
`233`	`233`
`234`		`-ServerResponse.prototype.writeHeader = function writeHeader() {`
`235`		`- this.writeHead.apply(this, arguments);`
`236`		`-};`
	`234`	`+// Docs-only deprecated: DEP0063`
	`235`	`+ServerResponse.prototype.writeHeader = ServerResponse.prototype.writeHead;`
`237`	`236`
`238`	`237`
`239`	`238`	`function Server(requestListener) {`