doc: update pushStream docs to use err first

Refs: nodejs#17406 (comment) PR-URL: nodejs#18088 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>
kjin · Apr 30, 2018 · 3d13a16 · 3d13a16
1 parent 39a0d35
commit 3d13a16
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/doc/api/http2.md b/doc/api/http2.md
@@ -1174,14 +1174,16 @@ added: v8.4.0
 * Returns: {undefined}
 
 Initiates a push stream. The callback is invoked with the new `Http2Stream`
-instance created for the push stream.
+instance created for the push stream passed as the second argument, or an
+`Error` passed as the first argument.
 
 ```js
 const http2 = require('http2');
 const server = http2.createServer();
 server.on('stream', (stream) => {
   stream.respond({ ':status': 200 });
-  stream.pushStream({ ':path': '/' }, (pushStream) => {
+  stream.pushStream({ ':path': '/' }, (err, pushStream) => {
+    if (err) throw err;
     pushStream.respond({ ':status': 200 });
     pushStream.end('some pushed data');
   });