Skip to main content

pushStream

method ServerHttp2Stream.pushStream
Jump to headingServerHttp2Stream.pushStream(
callback?: (
err: Error | null,
pushStream: ServerHttp2Stream,
) => void
,
): void

Initiates a push stream. The callback is invoked with the new Http2Stream instance created for the push stream passed as the second argument, or an Error passed as the first argument.

import http2 from 'node:http2';
const server = http2.createServer();
server.on('stream', (stream) => {
  stream.respond({ ':status': 200 });
  stream.pushStream({ ':path': '/' }, (err, pushStream, headers) => {
    if (err) throw err;
    pushStream.respond({ ':status': 200 });
    pushStream.end('some pushed data');
  });
  stream.end('some data');
});

Setting the weight of a push stream is not allowed in the HEADERS frame. Pass a weight value to http2stream.priority with the silent option set to true to enable server-side bandwidth balancing between concurrent streams.

Calling http2stream.pushStream() from within a pushed stream is not permitted and will throw an error.

Parameters Jump to heading

optional
Jump to headingcallback: (
err: Error | null,
pushStream: ServerHttp2Stream,
) => void

Callback that is called once the push stream has been initiated.

Return Type Jump to heading

void
Jump to headingServerHttp2Stream.pushStream(
callback?: (
err: Error | null,
pushStream: ServerHttp2Stream,
) => void
,
): void

Parameters Jump to heading

optional
Jump to headingcallback: (
err: Error | null,
pushStream: ServerHttp2Stream,
) => void

Return Type Jump to heading

void
Back to top