Skip to content

Http2Stream

[<Interface>]
type Http2Stream =
    abstract member aborted: bool
    abstract member bufferSize: float
    abstract member destroyed: bool
    abstract member endAfterHeaders: bool
    abstract member id: float option
    abstract member pending: bool
    abstract member rstCode: float
    abstract member sentHeaders: OutgoingHttpHeaders
    abstract member sentInfoHeaders: OutgoingHttpHeaders array option
    abstract member sentTrailers: OutgoingHttpHeaders option
    abstract member session: Http2Session option
    abstract member state: StreamState
    abstract member ``end`` (chunk: obj, encoding: BufferEncoding, ?cb: (unit -> unit)) : Http2Stream
    abstract member ``end`` (chunk: obj, ?cb: (unit -> unit)) : Http2Stream
    abstract member ``end`` (?cb: (unit -> unit)) : Http2Stream
    abstract member addListener (event: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream
    abstract member addListenerAborted (listener: unit -> unit) : Http2Stream
    abstract member addListenerClose (listener: unit -> unit) : Http2Stream
    abstract member addListenerData (listener: U2<string,NonSharedBuffer> -> unit) : Http2Stream
    abstract member addListenerDrain (listener: unit -> unit) : Http2Stream
    abstract member addListenerEnd (listener: unit -> unit) : Http2Stream
    abstract member addListenerError (listener: exn -> unit) : Http2Stream
    abstract member addListenerFinish (listener: unit -> unit) : Http2Stream
    abstract member addListenerFrameError (listener: Listener) : Http2Stream
    abstract member addListenerPipe (listener: Readable -> unit) : Http2Stream
    abstract member addListenerStreamClosed (listener: float -> unit) : Http2Stream
    abstract member addListenerTimeout (listener: unit -> unit) : Http2Stream
    abstract member addListenerTrailers (listener: Listener2) : Http2Stream
    abstract member addListenerUnpipe (listener: Readable -> unit) : Http2Stream
    abstract member addListenerWantTrailers (listener: unit -> unit) : Http2Stream
    abstract member close (?code: float, ?callback: (unit -> unit)) : unit
    abstract member compose<'T when 'T :> ReadableStream> (stream: U4<'T,AsyncIterable<'T,obj,obj>,(obj -> unit),Iterable<'T,obj,obj>>, ?options: Options) : 'T
    abstract member destroy (?error: exn) : Http2Stream
    abstract member emitAborted () : bool
    abstract member emitData (chunk: U2<string,NonSharedBuffer>) : bool
    abstract member emitFrameError (frameType: float, errorCode: float, id: float) : bool
    abstract member emitStreamClosed (code: float) : bool
    abstract member emitTimeout () : bool
    abstract member emitTrailers (trailers: IncomingHttpHeaders, flags: float) : bool
    abstract member emitWantTrailers () : bool
    abstract member off (eventName: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream
    abstract member on (event: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream
    abstract member onAborted (listener: unit -> unit) : Http2Stream
    abstract member onClose (listener: unit -> unit) : Http2Stream
    abstract member onData (listener: U2<string,NonSharedBuffer> -> unit) : Http2Stream
    abstract member onDrain (listener: unit -> unit) : Http2Stream
    abstract member onEnd (listener: unit -> unit) : Http2Stream
    abstract member onError (listener: exn -> unit) : Http2Stream
    abstract member onFinish (listener: unit -> unit) : Http2Stream
    abstract member onFrameError (listener: Listener) : Http2Stream
    abstract member onPipe (listener: Readable -> unit) : Http2Stream
    abstract member onStreamClosed (listener: float -> unit) : Http2Stream
    abstract member onTimeout (listener: unit -> unit) : Http2Stream
    abstract member onTrailers (listener: Listener2) : Http2Stream
    abstract member onUnpipe (listener: Readable -> unit) : Http2Stream
    abstract member onWantTrailers (listener: unit -> unit) : Http2Stream
    abstract member once (event: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream
    abstract member onceAborted (listener: unit -> unit) : Http2Stream
    abstract member onceClose (listener: unit -> unit) : Http2Stream
    abstract member onceData (listener: U2<string,NonSharedBuffer> -> unit) : Http2Stream
    abstract member onceDrain (listener: unit -> unit) : Http2Stream
    abstract member onceEnd (listener: unit -> unit) : Http2Stream
    abstract member onceError (listener: exn -> unit) : Http2Stream
    abstract member onceFinish (listener: unit -> unit) : Http2Stream
    abstract member onceFrameError (listener: Listener) : Http2Stream
    abstract member oncePipe (listener: Readable -> unit) : Http2Stream
    abstract member onceStreamClosed (listener: float -> unit) : Http2Stream
    abstract member onceTimeout (listener: unit -> unit) : Http2Stream
    abstract member onceTrailers (listener: Listener2) : Http2Stream
    abstract member onceUnpipe (listener: Readable -> unit) : Http2Stream
    abstract member onceWantTrailers (listener: unit -> unit) : Http2Stream
    abstract member pause () : Http2Stream
    abstract member pipe<'T when 'T :> WritableStream> (destination: 'T, ?options: Options) : 'T
    abstract member prependListener (event: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream
    abstract member prependListenerAborted (listener: unit -> unit) : Http2Stream
    abstract member prependListenerClose (listener: unit -> unit) : Http2Stream
    abstract member prependListenerData (listener: U2<string,NonSharedBuffer> -> unit) : Http2Stream
    abstract member prependListenerDrain (listener: unit -> unit) : Http2Stream
    abstract member prependListenerEnd (listener: unit -> unit) : Http2Stream
    abstract member prependListenerError (listener: exn -> unit) : Http2Stream
    abstract member prependListenerFinish (listener: unit -> unit) : Http2Stream
    abstract member prependListenerFrameError (listener: Listener) : Http2Stream
    abstract member prependListenerPipe (listener: Readable -> unit) : Http2Stream
    abstract member prependListenerStreamClosed (listener: float -> unit) : Http2Stream
    abstract member prependListenerTimeout (listener: unit -> unit) : Http2Stream
    abstract member prependListenerTrailers (listener: Listener2) : Http2Stream
    abstract member prependListenerUnpipe (listener: Readable -> unit) : Http2Stream
    abstract member prependListenerWantTrailers (listener: unit -> unit) : Http2Stream
    abstract member prependOnceListener (event: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream
    abstract member prependOnceListenerAborted (listener: unit -> unit) : Http2Stream
    abstract member prependOnceListenerClose (listener: unit -> unit) : Http2Stream
    abstract member prependOnceListenerData (listener: U2<string,NonSharedBuffer> -> unit) : Http2Stream
    abstract member prependOnceListenerDrain (listener: unit -> unit) : Http2Stream
    abstract member prependOnceListenerEnd (listener: unit -> unit) : Http2Stream
    abstract member prependOnceListenerError (listener: exn -> unit) : Http2Stream
    abstract member prependOnceListenerFinish (listener: unit -> unit) : Http2Stream
    abstract member prependOnceListenerFrameError (listener: Listener) : Http2Stream
    abstract member prependOnceListenerPipe (listener: Readable -> unit) : Http2Stream
    abstract member prependOnceListenerStreamClosed (listener: float -> unit) : Http2Stream
    abstract member prependOnceListenerTimeout (listener: unit -> unit) : Http2Stream
    abstract member prependOnceListenerTrailers (listener: Listener2) : Http2Stream
    abstract member prependOnceListenerUnpipe (listener: Readable -> unit) : Http2Stream
    abstract member prependOnceListenerWantTrailers (listener: unit -> unit) : Http2Stream
    abstract member priority (options: StreamPriorityOptions) : unit
    abstract member removeAllListeners (?eventName: U2<string,Symbol>) : Http2Stream
    abstract member removeListener (event: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream
    abstract member removeListenerClose (listener: unit -> unit) : Http2Stream
    abstract member removeListenerData (listener: obj -> unit) : Http2Stream
    abstract member removeListenerDrain (listener: unit -> unit) : Http2Stream
    abstract member removeListenerEnd (listener: unit -> unit) : Http2Stream
    abstract member removeListenerError (listener: exn -> unit) : Http2Stream
    abstract member removeListenerFinish (listener: unit -> unit) : Http2Stream
    abstract member removeListenerPause (listener: unit -> unit) : Http2Stream
    abstract member removeListenerPipe (listener: Readable -> unit) : Http2Stream
    abstract member removeListenerReadable (listener: unit -> unit) : Http2Stream
    abstract member removeListenerResume (listener: unit -> unit) : Http2Stream
    abstract member removeListenerUnpipe (listener: Readable -> unit) : Http2Stream
    abstract member resume () : Http2Stream
    abstract member sendTrailers (headers: OutgoingHttpHeaders) : unit
    abstract member setDefaultEncoding (encoding: BufferEncoding) : Http2Stream
    abstract member setEncoding (encoding: BufferEncoding) : Http2Stream
    abstract member setMaxListeners (n: float) : Http2Stream
    abstract member setTimeout (msecs: float, ?callback: (unit -> unit)) : unit
    abstract member unpipe (?destination: WritableStream) : Http2Stream
    abstract member wrap (stream: ReadableStream) : Http2Stream
AssemblyXantham.Fable.Node
ImplementsDuplex

Declared inside

AddListener
Compose
On
Once
Pipe
PrependListener
PrependOnceListener

Properties

abstract member aborted: bool

Set to true if the Http2Stream instance was aborted abnormally. When set, the 'aborted' event will have been emitted.

@since v8.4.0

abstract member bufferSize: float

This property shows the number of characters currently buffered to be written. See net.Socket.bufferSize for details.

@since v11.2.0, v10.16.0

abstract member destroyed: bool

Set to true if the Http2Stream instance has been destroyed and is no longer usable.

@since v8.4.0

abstract member endAfterHeaders: bool

Set to true if the END_STREAM flag was set in the request or response HEADERS frame received, indicating that no additional data should be received and the readable side of the Http2Stream will be closed.

@since v10.11.0

abstract member id: float option

The numeric stream identifier of this Http2Stream instance. Set to undefined if the stream identifier has not yet been assigned.

@since v8.4.0

abstract member pending: bool

Set to true if the Http2Stream instance has not yet been assigned a numeric stream identifier.

@since v9.4.0

abstract member rstCode: float

Set to the RST_STREAM``error code reported when the Http2Stream is destroyed after either receiving an RST_STREAM frame from the connected peer, calling http2stream.close(), or http2stream.destroy(). Will be undefined if the Http2Stream has not been closed.

@since v8.4.0

abstract member sentHeaders: OutgoingHttpHeaders

An object containing the outbound headers sent for this Http2Stream.

@since v9.5.0

abstract member sentInfoHeaders: OutgoingHttpHeaders array option

An array of objects containing the outbound informational (additional) headers sent for this Http2Stream.

@since v9.5.0

abstract member sentTrailers: OutgoingHttpHeaders option

An object containing the outbound trailers sent for this HttpStream.

@since v9.5.0

abstract member session: Http2Session option

A reference to the Http2Session instance that owns this Http2Stream. The value will be undefined after the Http2Stream instance is destroyed.

@since v8.4.0

abstract member state: StreamState

Provides miscellaneous information about the current state of the Http2Stream.

A current state of this Http2Stream.

@since v8.4.0

Methods

abstract member ``end`` (chunk: obj, encoding: BufferEncoding, ?cb: (unit -> unit)) : Http2Stream

Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

Calling the write method after calling end will raise an error.

// Write 'hello, ' and then end with 'world!'.
import fs from 'node:fs';
const file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// Writing more now is not allowed!

Signals that no more data will be written, with one final chunk of data.

@since v0.9.4

Parameter
cbCallback for when the stream is finished.
chunkOptional data to write. For streams not operating in object mode, chunk must be a , , or . For object mode streams, chunk may be any JavaScript value other than null.
cbCallback for when the stream is finished.
chunkOptional data to write. For streams not operating in object mode, chunk must be a , , or . For object mode streams, chunk may be any JavaScript value other than null.
encodingThe encoding if chunk is a string
cbCallback for when the stream is finished.
abstract member ``end`` (chunk: obj, ?cb: (unit -> unit)) : Http2Stream

Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

Calling the write method after calling end will raise an error.

// Write 'hello, ' and then end with 'world!'.
import fs from 'node:fs';
const file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// Writing more now is not allowed!

Signals that no more data will be written, with one final chunk of data.

@since v0.9.4

Parameter
cbCallback for when the stream is finished.
chunkOptional data to write. For streams not operating in object mode, chunk must be a , , or . For object mode streams, chunk may be any JavaScript value other than null.
cbCallback for when the stream is finished.
chunkOptional data to write. For streams not operating in object mode, chunk must be a , , or . For object mode streams, chunk may be any JavaScript value other than null.
encodingThe encoding if chunk is a string
cbCallback for when the stream is finished.
abstract member ``end`` (?cb: (unit -> unit)) : Http2Stream

Calling the writable.end() method signals that no more data will be written to the Writable. The optional chunk and encoding arguments allow one final additional chunk of data to be written immediately before closing the stream.

Calling the write method after calling end will raise an error.

// Write 'hello, ' and then end with 'world!'.
import fs from 'node:fs';
const file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// Writing more now is not allowed!

Signals that no more data will be written, with one final chunk of data.

@since v0.9.4

Parameter
cbCallback for when the stream is finished.
chunkOptional data to write. For streams not operating in object mode, chunk must be a , , or . For object mode streams, chunk may be any JavaScript value other than null.
cbCallback for when the stream is finished.
chunkOptional data to write. For streams not operating in object mode, chunk must be a , , or . For object mode streams, chunk may be any JavaScript value other than null.
encodingThe encoding if chunk is a string
cbCallback for when the stream is finished.
abstract member addListener (event: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream

Event emitter The defined events on documents including:

  1. close
  2. data
  3. drain
  4. end
  5. error
  6. finish
  7. pause
  8. pipe
  9. readable
  10. resume
  11. unpipe
abstract member addListenerAborted (listener: unit -> unit) : Http2Stream
addListener(event: "aborted", listener: () => void): this
abstract member addListenerClose (listener: unit -> unit) : Http2Stream
addListener(event: "close", listener: () => void): this
abstract member addListenerData (listener: U2<string,NonSharedBuffer> -> unit) : Http2Stream
addListener(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this
abstract member addListenerDrain (listener: unit -> unit) : Http2Stream
addListener(event: "drain", listener: () => void): this
abstract member addListenerEnd (listener: unit -> unit) : Http2Stream
addListener(event: "end", listener: () => void): this
abstract member addListenerError (listener: exn -> unit) : Http2Stream
addListener(event: "error", listener: (err: Error) => void): this
abstract member addListenerFinish (listener: unit -> unit) : Http2Stream
addListener(event: "finish", listener: () => void): this
abstract member addListenerFrameError (listener: Listener) : Http2Stream
addListener(event: "frameError", listener: (frameType: number, errorCode: number, id: number) => void): this
abstract member addListenerPipe (listener: Readable -> unit) : Http2Stream
addListener(event: "pipe", listener: (src: stream.Readable) => void): this
abstract member addListenerStreamClosed (listener: float -> unit) : Http2Stream
addListener(event: "streamClosed", listener: (code: number) => void): this
abstract member addListenerTimeout (listener: unit -> unit) : Http2Stream
addListener(event: "timeout", listener: () => void): this
abstract member addListenerTrailers (listener: Listener2) : Http2Stream
addListener(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this
abstract member addListenerUnpipe (listener: Readable -> unit) : Http2Stream
addListener(event: "unpipe", listener: (src: stream.Readable) => void): this
abstract member addListenerWantTrailers (listener: unit -> unit) : Http2Stream
addListener(event: "wantTrailers", listener: () => void): this
abstract member close (?code: float, ?callback: (unit -> unit)) : unit

Closes the Http2Stream instance by sending an RST_STREAM frame to the connected HTTP/2 peer.

@since v8.4.0

Parameter
codeUnsigned 32-bit integer identifying the error code.
callbackAn optional function registered to listen for the 'close' event.
abstract member compose<'T when 'T :> ReadableStream> (stream: U4<'T,AsyncIterable<'T,obj,obj>,(obj -> unit),Iterable<'T,obj,obj>>, ?options: Options) : 'T
abstract member destroy (?error: exn) : Http2Stream

Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event (unless emitClose is set to false). After this call, the readable stream will release any internal resources and subsequent calls to push() will be ignored.

Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.

Implementors should not override this method, but instead implement readable._destroy().

@since v8.0.0

Parameter
errorError which will be passed as payload in 'error' event
abstract member emitAborted () : bool
emit(event: "aborted"): boolean
abstract member emitData (chunk: U2<string,NonSharedBuffer>) : bool
emit(event: "data", chunk: NonSharedBuffer | string): boolean
abstract member emitFrameError (frameType: float, errorCode: float, id: float) : bool
emit(event: "frameError", frameType: number, errorCode: number, id: number): boolean
abstract member emitStreamClosed (code: float) : bool
emit(event: "streamClosed", code: number): boolean
abstract member emitTimeout () : bool
emit(event: "timeout"): boolean
abstract member emitTrailers (trailers: IncomingHttpHeaders, flags: float) : bool
emit(event: "trailers", trailers: IncomingHttpHeaders, flags: number): boolean
abstract member emitWantTrailers () : bool
emit(event: "wantTrailers"): boolean
abstract member off (eventName: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream

Alias for emitter.removeListener().

@since v10.0.0

abstract member on (event: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.on('connection', (stream) => {
console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a
abstract member onAborted (listener: unit -> unit) : Http2Stream
on(event: "aborted", listener: () => void): this
abstract member onClose (listener: unit -> unit) : Http2Stream
on(event: "close", listener: () => void): this
abstract member onData (listener: U2<string,NonSharedBuffer> -> unit) : Http2Stream
on(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this
abstract member onDrain (listener: unit -> unit) : Http2Stream
on(event: "drain", listener: () => void): this
abstract member onEnd (listener: unit -> unit) : Http2Stream
on(event: "end", listener: () => void): this
abstract member onError (listener: exn -> unit) : Http2Stream
on(event: "error", listener: (err: Error) => void): this
abstract member onFinish (listener: unit -> unit) : Http2Stream
on(event: "finish", listener: () => void): this
abstract member onFrameError (listener: Listener) : Http2Stream
on(event: "frameError", listener: (frameType: number, errorCode: number, id: number) => void): this
abstract member onPipe (listener: Readable -> unit) : Http2Stream
on(event: "pipe", listener: (src: stream.Readable) => void): this
abstract member onStreamClosed (listener: float -> unit) : Http2Stream
on(event: "streamClosed", listener: (code: number) => void): this
abstract member onTimeout (listener: unit -> unit) : Http2Stream
on(event: "timeout", listener: () => void): this
abstract member onTrailers (listener: Listener2) : Http2Stream
on(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this
abstract member onUnpipe (listener: Readable -> unit) : Http2Stream
on(event: "unpipe", listener: (src: stream.Readable) => void): this
abstract member onWantTrailers (listener: unit -> unit) : Http2Stream
on(event: "wantTrailers", listener: () => void): this
abstract member once (event: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream

Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a
abstract member onceAborted (listener: unit -> unit) : Http2Stream
once(event: "aborted", listener: () => void): this
abstract member onceClose (listener: unit -> unit) : Http2Stream
once(event: "close", listener: () => void): this
abstract member onceData (listener: U2<string,NonSharedBuffer> -> unit) : Http2Stream
once(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this
abstract member onceDrain (listener: unit -> unit) : Http2Stream
once(event: "drain", listener: () => void): this
abstract member onceEnd (listener: unit -> unit) : Http2Stream
once(event: "end", listener: () => void): this
abstract member onceError (listener: exn -> unit) : Http2Stream
once(event: "error", listener: (err: Error) => void): this
abstract member onceFinish (listener: unit -> unit) : Http2Stream
once(event: "finish", listener: () => void): this
abstract member onceFrameError (listener: Listener) : Http2Stream
once(event: "frameError", listener: (frameType: number, errorCode: number, id: number) => void): this
abstract member oncePipe (listener: Readable -> unit) : Http2Stream
once(event: "pipe", listener: (src: stream.Readable) => void): this
abstract member onceStreamClosed (listener: float -> unit) : Http2Stream
once(event: "streamClosed", listener: (code: number) => void): this
abstract member onceTimeout (listener: unit -> unit) : Http2Stream
once(event: "timeout", listener: () => void): this
abstract member onceTrailers (listener: Listener2) : Http2Stream
once(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this
abstract member onceUnpipe (listener: Readable -> unit) : Http2Stream
once(event: "unpipe", listener: (src: stream.Readable) => void): this
abstract member onceWantTrailers (listener: unit -> unit) : Http2Stream
once(event: "wantTrailers", listener: () => void): this
abstract member pause () : Http2Stream

The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

const readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
console.log(`Received ${chunk.length} bytes of data.`);
readable.pause();
console.log('There will be no additional data for 1 second.');
setTimeout(() => {
console.log('Now data will start flowing again.');
readable.resume();
}, 1000);
});

The readable.pause() method has no effect if there is a 'readable' event listener.

@since v0.9.4

abstract member pipe<'T when 'T :> WritableStream> (destination: 'T, ?options: Options) : 'T
abstract member prependListener (event: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.prependListener('connection', (stream) => {
console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

abstract member prependListenerAborted (listener: unit -> unit) : Http2Stream
prependListener(event: "aborted", listener: () => void): this
abstract member prependListenerClose (listener: unit -> unit) : Http2Stream
prependListener(event: "close", listener: () => void): this
abstract member prependListenerData (listener: U2<string,NonSharedBuffer> -> unit) : Http2Stream
prependListener(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this
abstract member prependListenerDrain (listener: unit -> unit) : Http2Stream
prependListener(event: "drain", listener: () => void): this
abstract member prependListenerEnd (listener: unit -> unit) : Http2Stream
prependListener(event: "end", listener: () => void): this
abstract member prependListenerError (listener: exn -> unit) : Http2Stream
prependListener(event: "error", listener: (err: Error) => void): this
abstract member prependListenerFinish (listener: unit -> unit) : Http2Stream
prependListener(event: "finish", listener: () => void): this
abstract member prependListenerFrameError (listener: Listener) : Http2Stream
prependListener(event: "frameError", listener: (frameType: number, errorCode: number, id: number) => void): this
abstract member prependListenerPipe (listener: Readable -> unit) : Http2Stream
prependListener(event: "pipe", listener: (src: stream.Readable) => void): this
abstract member prependListenerStreamClosed (listener: float -> unit) : Http2Stream
prependListener(event: "streamClosed", listener: (code: number) => void): this
abstract member prependListenerTimeout (listener: unit -> unit) : Http2Stream
prependListener(event: "timeout", listener: () => void): this
abstract member prependListenerTrailers (listener: Listener2) : Http2Stream
prependListener(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this
abstract member prependListenerUnpipe (listener: Readable -> unit) : Http2Stream
prependListener(event: "unpipe", listener: (src: stream.Readable) => void): this
abstract member prependListenerWantTrailers (listener: unit -> unit) : Http2Stream
prependListener(event: "wantTrailers", listener: () => void): this
abstract member prependOnceListener (event: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

abstract member prependOnceListenerAborted (listener: unit -> unit) : Http2Stream
prependOnceListener(event: "aborted", listener: () => void): this
abstract member prependOnceListenerClose (listener: unit -> unit) : Http2Stream
prependOnceListener(event: "close", listener: () => void): this
abstract member prependOnceListenerData (listener: U2<string,NonSharedBuffer> -> unit) : Http2Stream
prependOnceListener(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this
abstract member prependOnceListenerDrain (listener: unit -> unit) : Http2Stream
prependOnceListener(event: "drain", listener: () => void): this
abstract member prependOnceListenerEnd (listener: unit -> unit) : Http2Stream
prependOnceListener(event: "end", listener: () => void): this
abstract member prependOnceListenerError (listener: exn -> unit) : Http2Stream
prependOnceListener(event: "error", listener: (err: Error) => void): this
abstract member prependOnceListenerFinish (listener: unit -> unit) : Http2Stream
prependOnceListener(event: "finish", listener: () => void): this
abstract member prependOnceListenerFrameError (listener: Listener) : Http2Stream
prependOnceListener(event: "frameError", listener: (frameType: number, errorCode: number, id: number) => void): this
abstract member prependOnceListenerPipe (listener: Readable -> unit) : Http2Stream
prependOnceListener(event: "pipe", listener: (src: stream.Readable) => void): this
abstract member prependOnceListenerStreamClosed (listener: float -> unit) : Http2Stream
prependOnceListener(event: "streamClosed", listener: (code: number) => void): this
abstract member prependOnceListenerTimeout (listener: unit -> unit) : Http2Stream
prependOnceListener(event: "timeout", listener: () => void): this
abstract member prependOnceListenerTrailers (listener: Listener2) : Http2Stream
prependOnceListener(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this
abstract member prependOnceListenerUnpipe (listener: Readable -> unit) : Http2Stream
prependOnceListener(event: "unpipe", listener: (src: stream.Readable) => void): this
abstract member prependOnceListenerWantTrailers (listener: unit -> unit) : Http2Stream
prependOnceListener(event: "wantTrailers", listener: () => void): this
abstract member priority (options: StreamPriorityOptions) : unit

Updates the priority for this Http2Stream instance.

@since v8.4.0

abstract member removeAllListeners (?eventName: U2<string,Symbol>) : Http2Stream

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

@since v0.1.26

abstract member removeListener (event: U2<string,Symbol>, listener: obj array -> unit) : Http2Stream

Removes the specified listener from the listener array for the event named eventName.

const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

import { EventEmitter } from 'node:events';
const ee = new EventEmitter();

function pong() {
console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

abstract member removeListenerClose (listener: unit -> unit) : Http2Stream
removeListener(event: "close", listener: () => void): this
abstract member removeListenerData (listener: obj -> unit) : Http2Stream
removeListener(event: "data", listener: (chunk: any) => void): this
abstract member removeListenerDrain (listener: unit -> unit) : Http2Stream
removeListener(event: "drain", listener: () => void): this
abstract member removeListenerEnd (listener: unit -> unit) : Http2Stream
removeListener(event: "end", listener: () => void): this
abstract member removeListenerError (listener: exn -> unit) : Http2Stream
removeListener(event: "error", listener: (err: Error) => void): this
abstract member removeListenerFinish (listener: unit -> unit) : Http2Stream
removeListener(event: "finish", listener: () => void): this
abstract member removeListenerPause (listener: unit -> unit) : Http2Stream
removeListener(event: "pause", listener: () => void): this
abstract member removeListenerPipe (listener: Readable -> unit) : Http2Stream
removeListener(event: "pipe", listener: (src: Readable) => void): this
abstract member removeListenerReadable (listener: unit -> unit) : Http2Stream
removeListener(event: "readable", listener: () => void): this
abstract member removeListenerResume (listener: unit -> unit) : Http2Stream
removeListener(event: "resume", listener: () => void): this
abstract member removeListenerUnpipe (listener: Readable -> unit) : Http2Stream
removeListener(event: "unpipe", listener: (src: Readable) => void): this
abstract member resume () : Http2Stream

The readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events, switching the stream into flowing mode.

The readable.resume() method can be used to fully consume the data from a stream without actually processing any of that data:

getReadableStreamSomehow()
.resume()
.on('end', () => {
console.log('Reached the end, but did not read anything.');
});

The readable.resume() method has no effect if there is a 'readable' event listener.

@since v0.9.4

abstract member sendTrailers (headers: OutgoingHttpHeaders) : unit

Sends a trailing HEADERS frame to the connected HTTP/2 peer. This method will cause the Http2Stream to be immediately closed and must only be called after the 'wantTrailers' event has been emitted. When sending a request or sending a response, the options.waitForTrailers option must be set in order to keep the Http2Stream open after the final DATA frame so that trailers can be sent.

import http2 from 'node:http2';
const server = http2.createServer();
server.on('stream', (stream) => {
stream.respond(undefined, { waitForTrailers: true });
stream.on('wantTrailers', () => {
stream.sendTrailers({ xyz: 'abc' });
});
stream.end('Hello World');
});

The HTTP/1 specification forbids trailers from containing HTTP/2 pseudo-header fields (e.g. ':method', ':path', etc).

@since v10.0.0

abstract member setDefaultEncoding (encoding: BufferEncoding) : Http2Stream

The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

@since v0.11.15

Parameter
encodingThe new default encoding
abstract member setEncoding (encoding: BufferEncoding) : Http2Stream

The readable.setEncoding() method sets the character encoding for data read from the Readable stream.

By default, no encoding is assigned and stream data will be returned as Buffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Buffer objects. For instance, calling readable.setEncoding('utf8') will cause the output data to be interpreted as UTF-8 data, and passed as strings. Calling readable.setEncoding('hex') will cause the data to be encoded in hexadecimal string format.

The Readable stream will properly handle multi-byte characters delivered through the stream that would otherwise become improperly decoded if simply pulled from the stream as Buffer objects.

const readable = getReadableStreamSomehow();
readable.setEncoding('utf8');
readable.on('data', (chunk) => {
assert.equal(typeof chunk, 'string');
console.log('Got %d characters of string data:', chunk.length);
});

@since v0.9.4

Parameter
encodingThe encoding to use.
abstract member setMaxListeners (n: float) : Http2Stream

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

@since v0.3.5

abstract member setTimeout (msecs: float, ?callback: (unit -> unit)) : unit
import http2 from 'node:http2';
const client = http2.connect('http://example.org:8000');
const { NGHTTP2_CANCEL } = http2.constants;
const req = client.request({ ':path': '/' });

// Cancel the stream if there's no activity after 5 seconds
req.setTimeout(5000, () => req.close(NGHTTP2_CANCEL));

@since v8.4.0

abstract member unpipe (?destination: WritableStream) : Http2Stream

The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

If the destination is not specified, then all pipes are detached.

If the destination is specified, but no pipe is set up for it, then the method does nothing.

import fs from 'node:fs';
const readable = getReadableStreamSomehow();
const writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt',
// but only for the first second.
readable.pipe(writable);
setTimeout(() => {
console.log('Stop writing to file.txt.');
readable.unpipe(writable);
console.log('Manually close the file stream.');
writable.end();
}, 1000);

@since v0.9.4

Parameter
destinationOptional specific stream to unpipe
abstract member wrap (stream: ReadableStream) : Http2Stream

Prior to Node.js 0.10, streams did not implement the entire node:stream module API as it is currently defined. (See Compatibility for more information.)

When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, the readable.wrap() method can be used to create a Readable stream that uses the old stream as its data source.

It will rarely be necessary to use readable.wrap() but the method has been provided as a convenience for interacting with older Node.js applications and libraries.

import { OldReader } from './old-api-module.js';
import { Readable } from 'node:stream';
const oreader = new OldReader();
const myReader = new Readable().wrap(oreader);

myReader.on('readable', () => {
myReader.read(); // etc.
});

@since v0.9.4

Parameter
streamAn "old style" readable stream