doc: document http2 network error behaviour

addaleax · kjin · commit 8b036091d9c3 · 2018-08-23T10:43:33.000-07:00
Fixes: nodejs#21836 PR-URL: nodejs#21861 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
diff --git a/doc/api/http2.md b/doc/api/http2.md
@@ -272,12 +272,17 @@ server.on('stream', (stream, headers) => {
     'content-type': 'text/html',
     ':status': 200
   });
+  stream.on('error', (error) => console.error(error));
   stream.end('<h1>Hello World</h1>');
 });
 
 server.listen(80);
 ```
 
+Even though HTTP/2 streams and network sockets are not in a 1:1 correspondence,
+a network error will destroy each individual stream and must be handled on the
+stream level, as shown above.
+
 #### Event: 'timeout'
 <!-- YAML
 added: v8.4.0
