doc: document http2 network error behaviour

Fixes: nodejs#21836 PR-URL: nodejs#21861 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Minwoo Jung <[email protected]>
Trott · Jul 23, 2018 · 0e4cbde · 0e4cbde
1 parent daa15b5
commit 0e4cbde
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/doc/api/http2.md b/doc/api/http2.md
@@ -271,12 +271,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