Commit fb71ba4
committed
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 <cjihrig@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>1 parent d4e1eaf commit fb71ba4
2 files changed
Lines changed: 13 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -523,6 +523,17 @@ Type: Runtime | |||
| 523 | 523 | of V8 5.8. It is replaced by Inspector which is activated with `--inspect` | |
| 524 | 524 | instead. | |
| 525 | 525 | ||
| 526 | + <a id="DEP0063"></a> | ||
| 527 | + #### DEP0063: ServerResponse.prototype.writeHeader() | ||
| 528 | + | ||
| 529 | + Type: Documentation-only | ||
| 530 | + | ||
| 531 | + The `http` module `ServerResponse.prototype.writeHeader()` API has been | ||
| 532 | + deprecated. Please use `ServerResponse.prototype.writeHead()` instead. | ||
| 533 | + | ||
| 534 | + *Note*: The `ServerResponse.prototype.writeHeader()` method was never documented | ||
| 535 | + as an officially supported API. | ||
| 536 | + | ||
| 526 | 537 | [alloc]: buffer.html#buffer_class_method_buffer_alloc_size_fill_encoding | |
| 527 | 538 | [alloc_unsafe_size]: buffer.html#buffer_class_method_buffer_allocunsafe_size | |
| 528 | 539 | [`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size | |
| 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) { | |
0 commit comments