From 574d3b9ce8c852b64bccd20aec206ab41971ef57 Mon Sep 17 00:00:00 2001 From: Peter Dalgaard-Jensen Date: Fri, 19 Jan 2018 21:11:09 +0100 Subject: [PATCH] doc: fix documentation of http2Stream.pushstream() Improve documentation of callback signature of http2Stream.pushStream() function to align with the changes made in https://github.com/nodejs/node/pull/17406. PR-URL: https://github.com/nodejs/node/pull/18258 Fixes: https://github.com/nodejs/node/issues/18198 Refs: https://github.com/nodejs/node/pull/17406 Reviewed-By: Luigi Pinca Reviewed-By: James M Snell --- doc/api/http2.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/api/http2.md b/doc/api/http2.md index 2528fd271c22fc..0f08bba08f948a 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -1199,6 +1199,10 @@ added: v8.4.0 created stream is dependent on. * `callback` {Function} Callback that is called once the push stream has been initiated. + * `err` {Error} + * `pushStream` {[`ServerHttp2Stream`][]} The returned pushStream object. + * `headers` {[Headers Object][]} Headers object the pushStream was initiated + with. * Returns: {undefined} Initiates a push stream. The callback is invoked with the new `Http2Stream` @@ -1210,7 +1214,7 @@ const http2 = require('http2'); const server = http2.createServer(); server.on('stream', (stream) => { stream.respond({ ':status': 200 }); - stream.pushStream({ ':path': '/' }, (err, pushStream) => { + stream.pushStream({ ':path': '/' }, (err, pushStream, headers) => { if (err) throw err; pushStream.respond({ ':status': 200 }); pushStream.end('some pushed data');