doc: add simple http clientError example

The clientError event allows proper http 4xx responses to be returned when a parse error occurs, but the documentation did not demonstrate how to use it. PR-URL: nodejs#5248 Reviewed-By: Fedor Indutny <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]>
ALRubinger · Feb 17, 2016 · 9b6440a · 9b6440a
1 parent c1b3d78
commit 9b6440a
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/doc/api/http.markdown b/doc/api/http.markdown
@@ -464,6 +464,23 @@ Default behavior is to destroy the socket immediately on malformed request.
 
 `socket` is the [`net.Socket`][] object that the error originated from.
 
+```js
+const http = require('http');
+
+const server = http.createServer((req, res) => {
+  res.end();
+});
+server.on('clientError', (err, socket) => {
+  socket.end('HTTP/1.1 400 Bad Request\r\n\r\n');
+});
+server.listen(8000);
+```
+
+When the `'clientError'` event occurs, there is no `request` or `response`
+object, so any HTTP response sent, including response headers and payload,
+*must* be written directly to the `socket` object. Care must be taken to
+ensure the response is a properly formatted HTTP response message.
+
 ### Event: 'close'
 
 `function () { }`