From adc1d288c4b36a0b6baafe902f6448e5320f4f29 Mon Sep 17 00:00:00 2001 From: Antoine AMARA Date: Fri, 1 Sep 2017 15:28:12 +0200 Subject: [PATCH] doc: fix http.ClientRequest method descriptions fix documentation for methods getHeader, setHeader and removeHeader for http.ClientRequest class. The documentation said these functions can be called but they're wasn't describe into the API description yet. add parameters and general description for each methods. Fixes: https://github.com/nodejs/node/issues/15048 --- doc/api/http.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 58 insertions(+), 3 deletions(-) diff --git a/doc/api/http.md b/doc/api/http.md index c0fe0e72bcde18..50fa3e1135ad78 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -286,9 +286,9 @@ added: v0.1.17 This object is created internally and returned from [`http.request()`][]. It represents an _in-progress_ request whose header has already been queued. The -header is still mutable using the `setHeader(name, value)`, `getHeader(name)`, -`removeHeader(name)` API. The actual header will be sent along with the first -data chunk or when calling [`request.end()`][]. +header is still mutable using the [`setHeader(name, value)`][], + [`getHeader(name)`][], [`removeHeader(name)`][] API. The actual header will +be sent along with the first data chunk or when calling [`request.end()`][]. To get the response, add a listener for [`'response'`][] to the request object. [`'response'`][] will be emitted from the request object when the response @@ -542,6 +542,58 @@ That's usually desired (it saves a TCP round-trip), but not when the first data is not sent until possibly much later. `request.flushHeaders()` bypasses the optimization and kickstarts the request. +### request.getHeader(name) + + +* `name` {string} +* Returns: {string} + +Reads out a header on the request. Note that the name is case insensitive. + +Example: +```js +const contentType = request.getHeader('Content-Type'); +``` + +### request.removeHeader(name) + + +* `name` {string} + +Removes a header that's already defined into headers object. + +Example: +```js +request.removeHeader('Content-Type'); +``` + +### request.setHeader(name, value) + + +* `name` {string} +* `value` {string} + +Sets a single header value for headers object. If this header already exists in +the to-be-sent headers, its value will be replaced. Use an array of strings +here to send multiple headers with the same name. + +Example: +```js +request.setHeader('Content-Type', 'application/json'); +``` + +or + +```js +request.setHeader('Set-Cookie', ['type=ninja', 'language=javascript']); +``` + ### request.setNoDelay([noDelay])