From 10bc0fa13c05b835ce83a576ee4c8983ba03d6ba Mon Sep 17 00:00:00 2001 From: Cecchi MacNaughton Date: Mon, 6 Apr 2020 22:08:33 -0700 Subject: [PATCH] doc: remove warning from `response.writeHead` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The example referenced as being potentially unsafe specifies Content-Length correctly. PR-URL: https://github.com/nodejs/node/pull/32700 Reviewed-By: Anna Henningsen Reviewed-By: James M Snell Reviewed-By: Luigi Pinca Reviewed-By: Gerhard Stöbich --- doc/api/http.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/doc/api/http.md b/doc/api/http.md index 9d7d4b2834f6df..9479ffdf814db4 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -1705,12 +1705,10 @@ const server = http.createServer((req, res) => { }); ``` -`Content-Length` is given in bytes not characters. The above example -works because the string `'hello world'` contains only single byte characters. -If the body contains higher coded characters then `Buffer.byteLength()` -should be used to determine the number of bytes in a given encoding. -And Node.js does not check whether `Content-Length` and the length of the body -which has been transmitted are equal or not. +`Content-Length` is given in bytes, not characters. Use +[`Buffer.byteLength()`][] to determine the length of the body in bytes. Node.js +does not check whether `Content-Length` and the length of the body which has +been transmitted are equal or not. Attempting to set a header field name or value that contains invalid characters will result in a [`TypeError`][] being thrown. @@ -2346,6 +2344,7 @@ not abort the request or do anything besides add a `'timeout'` event. [`'response'`]: #http_event_response [`'upgrade'`]: #http_event_upgrade [`Agent`]: #http_class_http_agent +[`Buffer.byteLength()`]: buffer.html#buffer_class_method_buffer_bytelength_string_encoding [`Duplex`]: stream.html#stream_class_stream_duplex [`TypeError`]: errors.html#errors_class_typeerror [`URL`]: url.html#url_the_whatwg_url_api