BuildDocsReferenceGuidesBlog
Discord logo
Discord
GitHub logo
Fconnect
Bun

function

http2.connect

function connect(
authority: string | URL,
listener: (session: ClientHttp2Session, socket: Socket | TLSSocket) => void

Returns a ClientHttp2Session instance.

import http2 from 'node:http2';
const client = http2.connect('https://localhost:1234');

// Use the client

client.close();
@param authority

The remote HTTP/2 server to connect to. This must be in the form of a minimal, valid URL with the http:// or https:// prefix, host name, and IP port (if a non-default port is used). Userinfo (user ID and password), path, querystring, and fragment details in the URL will be ignored.

@param listener

Will be registered as a one-time listener of the 'connect' event.

function connect(
authority: string | URL,
options?: ClientSessionOptions | SecureClientSessionOptions,
listener?: (session: ClientHttp2Session, socket: Socket | TLSSocket) => void

Returns a ClientHttp2Session instance.

import http2 from 'node:http2';
const client = http2.connect('https://localhost:1234');

// Use the client

client.close();
@param authority

The remote HTTP/2 server to connect to. This must be in the form of a minimal, valid URL with the http:// or https:// prefix, host name, and IP port (if a non-default port is used). Userinfo (user ID and password), path, querystring, and fragment details in the URL will be ignored.

@param listener

Will be registered as a one-time listener of the 'connect' event.

Referenced types

interface URL

interface ClientHttp2Session

This is the interface from which event-emitting Node.js APIs inherit in the types package. It is not intended for consumer use.

It provides event-mapped definitions similar to EventEmitter, except that its signatures are deliberately permissive: they provide type hinting, but not rigid type-checking, for compatibility reasons.

Classes that inherit directly from EventEmitter in JavaScript can inherit directly from this interface in the type definitions. Classes that are more than one inheritance level away from EventEmitter (eg. net.Socket > stream.Duplex > EventEmitter) must instead copy these method definitions into the derived class. Search "#region InternalEventEmitter" for examples.

  • readonly alpnProtocol?: string

    Value will be undefined if the Http2Session is not yet connected to a socket, h2c if the Http2Session is not connected to a TLSSocket, or will return the value of the connected TLSSocket's own alpnProtocol property.

  • readonly closed: boolean

    Will be true if this Http2Session instance has been closed, otherwise false.

  • readonly connecting: boolean

    Will be true if this Http2Session instance is still connecting, will be set to false before emitting connect event and/or calling the http2.connect callback.

  • readonly destroyed: boolean

    Will be true if this Http2Session instance has been destroyed and must no longer be used, otherwise false.

  • readonly encrypted?: boolean

    Value is undefined if the Http2Session session socket has not yet been connected, true if the Http2Session is connected with a TLSSocket, and false if the Http2Session is connected to any other kind of socket or stream.

  • readonly localSettings: Settings

    A prototype-less object describing the current local settings of this Http2Session. The local settings are local to thisHttp2Session instance.

  • readonly originSet?: string[]

    If the Http2Session is connected to a TLSSocket, the originSet property will return an Array of origins for which the Http2Session may be considered authoritative.

    The originSet property is only available when using a secure TLS connection.

  • readonly pendingSettingsAck: boolean

    Indicates whether the Http2Session is currently waiting for acknowledgment of a sent SETTINGS frame. Will be true after calling the http2session.settings() method. Will be false once all sent SETTINGS frames have been acknowledged.

  • readonly remoteSettings: Settings

    A prototype-less object describing the current remote settings of thisHttp2Session. The remote settings are set by the connected HTTP/2 peer.

  • readonly socket: Socket | TLSSocket

    Returns a Proxy object that acts as a net.Socket (or tls.TLSSocket) but limits available methods to ones safe to use with HTTP/2.

    destroy, emit, end, pause, read, resume, and write will throw an error with code ERR_HTTP2_NO_SOCKET_MANIPULATION. See Http2Session and Sockets for more information.

    setTimeout method will be called on this Http2Session.

    All other interactions will be routed directly to the socket.

  • readonly state: SessionState

    Provides miscellaneous information about the current state of theHttp2Session.

    An object describing the current status of this Http2Session.

  • readonly type: number

    The http2session.type will be equal to http2.constants.NGHTTP2_SESSION_SERVER if this Http2Session instance is a server, and http2.constants.NGHTTP2_SESSION_CLIENT if the instance is a client.

  • error: Error,
    event: string | symbol,
    ...args: any[]
    ): void;

    The Symbol.for('nodejs.rejection') method is called in case a promise rejection happens when emitting an event and captureRejections is enabled on the emitter. It is possible to use events.captureRejectionSymbol in place of Symbol.for('nodejs.rejection').

    import { EventEmitter, captureRejectionSymbol } from 'node:events';

class MyClass extends EventEmitter {
  constructor() {
    super({ captureRejections: true });
  }

  [captureRejectionSymbol](err, event, ...args) {
    console.log('rejection happened for', event, 'with', err, ...args);
    this.destroy(err);
  }

  destroy(err) {
    // Tear the resource down here.
  }
}
  • eventName: E,
    listener: (...args: ClientHttp2StreamEventMap[E]) => void
    ): this;

    Alias for emitter.on(eventName, listener).

    eventName: string | symbol,
    listener: (...args: any[]) => void
    ): this;

    Alias for emitter.on(eventName, listener).

  • callback?: () => void
    ): void;

    Gracefully closes the Http2Session, allowing any existing streams to complete on their own and preventing new Http2Stream instances from being created. Once closed, http2session.destroy()might be called if there are no open Http2Stream instances.

    If specified, the callback function is registered as a handler for the'close' event.

  • error?: Error,
    code?: number
    ): void;

    Immediately terminates the Http2Session and the associated net.Socket or tls.TLSSocket.

    Once destroyed, the Http2Session will emit the 'close' event. If error is not undefined, an 'error' event will be emitted immediately before the 'close' event.

    If there are any remaining open Http2Streams associated with the Http2Session, those will also be destroyed.

    @param error

    An Error object if the Http2Session is being destroyed due to an error.

    @param code

    The HTTP/2 error code to send in the final GOAWAY frame. If unspecified, and error is not undefined, the default is INTERNAL_ERROR, otherwise defaults to NO_ERROR.

  • eventName: E,
    ...args: ClientHttp2StreamEventMap[E]
    ): boolean;

    Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

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

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
    eventName: string | symbol,
    ...args: any[]
    ): boolean;

    Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

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

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
  • eventNames(): string | symbol[];

    Returns an array listing the events for which the emitter has registered listeners.

    import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
  • getMaxListeners(): number;

    Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to events.defaultMaxListeners.

  • code?: number,
    lastStreamID?: number,
    opaqueData?: ArrayBufferView<ArrayBufferLike>
    ): void;

    Transmits a GOAWAY frame to the connected peer without shutting down theHttp2Session.

    @param code

    An HTTP/2 error code

    @param lastStreamID

    The numeric ID of the last processed Http2Stream

    @param opaqueData

    A TypedArray or DataView instance containing additional data to be carried within the GOAWAY frame.

  • eventName: E,
    listener?: (...args: ClientHttp2StreamEventMap[E]) => void
    ): number;

    Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

    @param eventName

    The name of the event being listened for

    @param listener

    The event handler function

    eventName: string | symbol,
    listener?: (...args: any[]) => void
    ): number;

    Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

    @param eventName

    The name of the event being listened for

    @param listener

    The event handler function

  • eventName: E
    ): (...args: ClientHttp2StreamEventMap[E]) => void[];

    Returns a copy of the array of listeners for the event named eventName.

    server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
    eventName: string | symbol
    ): (...args: any[]) => void[];

    Returns a copy of the array of listeners for the event named eventName.

    server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
  • off<E extends keyof ClientHttp2StreamEventMap>(
    eventName: E,
    listener: (...args: ClientHttp2StreamEventMap[E]) => void
    ): this;

    Alias for emitter.removeListener().

    eventName: string | symbol,
    listener: (...args: any[]) => void
    ): this;

    Alias for emitter.removeListener().

  • on<E extends keyof ClientHttp2StreamEventMap>(
    eventName: E,
    listener: (...args: ClientHttp2StreamEventMap[E]) => void
    ): this;

    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
    @param eventName

    The name of the event.

    @param listener

    The callback function

    eventName: string | symbol,
    listener: (...args: any[]) => void
    ): this;

    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
    @param eventName

    The name of the event.

    @param listener

    The callback function

  • eventName: E,
    listener: (...args: ClientHttp2StreamEventMap[E]) => void
    ): this;

    Adds a one-time listener 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
    @param eventName

    The name of the event.

    @param listener

    The callback function

    eventName: string | symbol,
    listener: (...args: any[]) => void
    ): this;

    Adds a one-time listener 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
    @param eventName

    The name of the event.

    @param listener

    The callback function

  • callback: (err: null | Error, duration: number, payload: NonSharedBuffer) => void
    ): boolean;

    Sends a PING frame to the connected HTTP/2 peer. A callback function must be provided. The method will return true if the PING was sent, false otherwise.

    The maximum number of outstanding (unacknowledged) pings is determined by the maxOutstandingPings configuration option. The default maximum is 10.

    If provided, the payload must be a Buffer, TypedArray, or DataView containing 8 bytes of data that will be transmitted with the PING and returned with the ping acknowledgment.

    The callback will be invoked with three arguments: an error argument that will be null if the PING was successfully acknowledged, a duration argument that reports the number of milliseconds elapsed since the ping was sent and the acknowledgment was received, and a Buffer containing the 8-byte PING payload.

    session.ping(Buffer.from('abcdefgh'), (err, duration, payload) => {
  if (!err) {
    console.log(`Ping acknowledged in ${duration} milliseconds`);
    console.log(`With payload '${payload.toString()}'`);
  }
});

    If the payload argument is not specified, the default payload will be the 64-bit timestamp (little endian) marking the start of the PING duration.

    payload: ArrayBufferView,
    callback: (err: null | Error, duration: number, payload: NonSharedBuffer) => void
    ): boolean;
  • eventName: E,
    listener: (...args: ClientHttp2StreamEventMap[E]) => void
    ): this;

    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.

    @param eventName

    The name of the event.

    @param listener

    The callback function

    eventName: string | symbol,
    listener: (...args: any[]) => void
    ): this;

    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.

    @param eventName

    The name of the event.

    @param listener

    The callback function

  • eventName: E,
    listener: (...args: ClientHttp2StreamEventMap[E]) => void
    ): this;

    Adds a one-time listener 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.

    @param eventName

    The name of the event.

    @param listener

    The callback function

    eventName: string | symbol,
    listener: (...args: any[]) => void
    ): this;

    Adds a one-time listener 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.

    @param eventName

    The name of the event.

    @param listener

    The callback function

  • eventName: E
    ): (...args: ClientHttp2StreamEventMap[E]) => void[];

    Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

    import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
    eventName: string | symbol
    ): (...args: any[]) => void[];

    Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

    import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
  • ref(): void;

    Calls ref() on this Http2Session instance's underlying net.Socket.

  • eventName?: E
    ): this;

    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.

    eventName?: string | symbol
    ): this;

    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.

  • eventName: E,
    listener: (...args: ClientHttp2StreamEventMap[E]) => void
    ): this;

    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 from emit() 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 indexes 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.

    eventName: string | symbol,
    listener: (...args: any[]) => void
    ): this;

    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 from emit() 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 indexes 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.

  • headers?: readonly string[] | OutgoingHttpHeaders,
    options?: ClientSessionRequestOptions

    For HTTP/2 Client Http2Session instances only, the http2session.request() creates and returns an Http2Stream instance that can be used to send an HTTP/2 request to the connected server.

    When a ClientHttp2Session is first created, the socket may not yet be connected. if clienthttp2session.request() is called during this time, the actual request will be deferred until the socket is ready to go. If the session is closed before the actual request be executed, an ERR_HTTP2_GOAWAY_SESSION is thrown.

    This method is only available if http2session.type is equal to http2.constants.NGHTTP2_SESSION_CLIENT.

    import http2 from 'node:http2';
const clientSession = http2.connect('https://localhost:1234');
const {
  HTTP2_HEADER_PATH,
  HTTP2_HEADER_STATUS,
} = http2.constants;

const req = clientSession.request({ [HTTP2_HEADER_PATH]: '/' });
req.on('response', (headers) => {
  console.log(headers[HTTP2_HEADER_STATUS]);
  req.on('data', (chunk) => { // ..  });
  req.on('end', () => { // ..  });
});

    When the options.waitForTrailers option is set, the 'wantTrailers' event is emitted immediately after queuing the last chunk of payload data to be sent. The http2stream.sendTrailers() method can then be called to send trailing headers to the peer.

    When options.waitForTrailers is set, the Http2Stream will not automatically close when the final DATA frame is transmitted. User code must call eitherhttp2stream.sendTrailers() or http2stream.close() to close theHttp2Stream.

    When options.signal is set with an AbortSignal and then abort on the corresponding AbortController is called, the request will emit an 'error'event with an AbortError error.

    The :method and :path pseudo-headers are not specified within headers, they respectively default to:

    • :method = 'GET'
    • :path = /
  • windowSize: number
    ): void;

    Sets the local endpoint's window size. The windowSize is the total window size to set, not the delta.

    import http2 from 'node:http2';

const server = http2.createServer();
const expectedWindowSize = 2 ** 20;
server.on('connect', (session) => {

  // Set local window size to be 2 ** 20
  session.setLocalWindowSize(expectedWindowSize);
});
  • n: number
    ): this;

    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.

  • msecs: number,
    callback?: () => void
    ): void;

    Used to set a callback function that is called when there is no activity on the Http2Session after msecs milliseconds. The given callback is registered as a listener on the 'timeout' event.

  • settings: Settings,
    callback?: (err: null | Error, settings: Settings, duration: number) => void
    ): void;

    Updates the current local settings for this Http2Session and sends a new SETTINGS frame to the connected HTTP/2 peer.

    Once called, the http2session.pendingSettingsAck property will be true while the session is waiting for the remote peer to acknowledge the new settings.

    The new settings will not become effective until the SETTINGS acknowledgment is received and the 'localSettings' event is emitted. It is possible to send multiple SETTINGS frames while acknowledgment is still pending.

    @param callback

    Callback that is called once the session is connected or right away if the session is already connected.

  • unref(): void;

    Calls unref() on this Http2Sessioninstance's underlying net.Socket.

interface ClientSessionOptions

  • createConnection?: (authority: URL, option: SessionOptions) => Duplex

    An optional callback that receives the URL instance passed to connect and the options object, and returns any Duplex stream that is to be used as the connection for this session.

  • maxDeflateDynamicTableSize?: number

    Sets the maximum dynamic table size for deflating header fields.

  • maxHeaderListPairs?: number

    Sets the maximum number of header entries. This is similar to server.maxHeadersCount or request.maxHeadersCount in the node:http module. The minimum value is 1.

  • maxOutstandingPings?: number

    Sets the maximum number of outstanding, unacknowledged pings.

  • maxReservedRemoteStreams?: number

    Sets the maximum number of reserved push streams the client will accept at any given time. Once the current number of currently reserved push streams exceeds reaches this limit, new push streams sent by the server will be automatically rejected. The minimum allowed value is 0. The maximum allowed value is 2<sup>32</sup>-1. A negative value sets this option to the maximum allowed value.

  • maxSendHeaderBlockLength?: number

    Sets the maximum allowed size for a serialized, compressed block of headers. Attempts to send headers that exceed this limit will result in a 'frameError' event being emitted and the stream being closed and destroyed.

  • maxSessionMemory?: number

    Sets the maximum memory that the Http2Session is permitted to use. The value is expressed in terms of number of megabytes, e.g. 1 equal 1 megabyte. The minimum value allowed is 1. This is a credit based limit, existing Http2Streams may cause this limit to be exceeded, but new Http2Stream instances will be rejected while this limit is exceeded. The current number of Http2Stream sessions, the current memory use of the header compression tables, current data queued to be sent, and unacknowledged PING and SETTINGS frames are all counted towards the current limit.

  • maxSettings?: number

    Sets the maximum number of settings entries per SETTINGS frame. The minimum value allowed is 1.

  • paddingStrategy?: number

    Strategy used for determining the amount of padding to use for HEADERS and DATA frames.

  • peerMaxConcurrentStreams?: number

    Sets the maximum number of concurrent streams for the remote peer as if a SETTINGS frame had been received. Will be overridden if the remote peer sets its own value for maxConcurrentStreams.

  • protocol?: 'http:' | 'https:'

    The protocol to connect with, if not set in the authority. Value may be either 'http:' or 'https:'.

  • remoteCustomSettings?: number[]

    The array of integer values determines the settings types, which are included in the CustomSettings-property of the received remoteSettings. Please see the CustomSettings-property of the Http2Settings object for more information, on the allowed setting types.

  • settings?: Settings

    The initial settings to send to the remote peer upon connection.

  • strictFieldWhitespaceValidation?: boolean

    If true, it turns on strict leading and trailing whitespace validation for HTTP/2 header field names and values as per RFC-9113.

  • unknownProtocolTimeout?: number

    Specifies a timeout in milliseconds that a server should wait when an ['unknownProtocol'][] is emitted. If the socket has not been destroyed by that time the server will destroy it.

interface SecureClientSessionOptions

  • allowPartialTrustChain?: boolean

    Treat intermediate (non-self-signed) certificates in the trust CA certificate list as trusted.

  • ALPNCallback?: (arg: { protocols: string[]; servername: string }) => undefined | string

    If set, this will be called when a client opens a connection using the ALPN extension. One argument will be passed to the callback: an object containing servername and protocols fields, respectively containing the server name from the SNI extension (if any) and an array of ALPN protocol name strings. The callback must return either one of the strings listed in protocols, which will be returned to the client as the selected ALPN protocol, or undefined, to reject the connection with a fatal alert. If a string is returned that does not match one of the client's ALPN protocols, an error will be thrown. This option cannot be used with the ALPNProtocols option, and setting both options will throw an error.

  • ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

  • ca?: string | Buffer<ArrayBufferLike> | string | Buffer<ArrayBufferLike>[]

    Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.

  • cert?: string | Buffer<ArrayBufferLike> | string | Buffer<ArrayBufferLike>[]

    Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.

  • checkServerIdentity?: (hostname: string, cert: PeerCertificate) => undefined | Error
  • ciphers?: string

    Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.

  • createConnection?: (authority: URL, option: SessionOptions) => Duplex

    An optional callback that receives the URL instance passed to connect and the options object, and returns any Duplex stream that is to be used as the connection for this session.

  • crl?: string | Buffer<ArrayBufferLike> | string | Buffer<ArrayBufferLike>[]

    PEM formatted CRLs (Certificate Revocation Lists).

  • dhparam?: string | Buffer<ArrayBufferLike>

    'auto' or custom Diffie-Hellman parameters, required for non-ECDHE perfect forward secrecy. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available. ECDHE-based perfect forward secrecy will still be available.

  • ecdhCurve?: string

    A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.

  • enableTrace?: boolean

    When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems.

  • honorCipherOrder?: boolean

    Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions

  • host?: string
  • key?: string | Buffer<ArrayBufferLike> | string | Buffer<ArrayBufferLike> | KeyObject[]

    Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form {pem: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

  • maxDeflateDynamicTableSize?: number

    Sets the maximum dynamic table size for deflating header fields.

  • maxHeaderListPairs?: number

    Sets the maximum number of header entries. This is similar to server.maxHeadersCount or request.maxHeadersCount in the node:http module. The minimum value is 1.

  • maxOutstandingPings?: number

    Sets the maximum number of outstanding, unacknowledged pings.

  • maxReservedRemoteStreams?: number

    Sets the maximum number of reserved push streams the client will accept at any given time. Once the current number of currently reserved push streams exceeds reaches this limit, new push streams sent by the server will be automatically rejected. The minimum allowed value is 0. The maximum allowed value is 2<sup>32</sup>-1. A negative value sets this option to the maximum allowed value.

  • maxSendHeaderBlockLength?: number

    Sets the maximum allowed size for a serialized, compressed block of headers. Attempts to send headers that exceed this limit will result in a 'frameError' event being emitted and the stream being closed and destroyed.

  • maxSessionMemory?: number

    Sets the maximum memory that the Http2Session is permitted to use. The value is expressed in terms of number of megabytes, e.g. 1 equal 1 megabyte. The minimum value allowed is 1. This is a credit based limit, existing Http2Streams may cause this limit to be exceeded, but new Http2Stream instances will be rejected while this limit is exceeded. The current number of Http2Stream sessions, the current memory use of the header compression tables, current data queued to be sent, and unacknowledged PING and SETTINGS frames are all counted towards the current limit.

  • maxSettings?: number

    Sets the maximum number of settings entries per SETTINGS frame. The minimum value allowed is 1.

  • maxVersion?: SecureVersion

    Optionally set the maximum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. Default: 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.

  • minDHSize?: number
  • minVersion?: SecureVersion

    Optionally set the minimum TLS version to allow. One of 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Cannot be specified along with the secureProtocol option, use one or the other. It is not recommended to use less than TLSv1.2, but it may be required for interoperability. Default: 'TLSv1.2', unless changed using CLI options. Using --tls-v1.0 sets the default to 'TLSv1'. Using --tls-v1.1 sets the default to 'TLSv1.1'. Using --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.

  • paddingStrategy?: number

    Strategy used for determining the amount of padding to use for HEADERS and DATA frames.

  • passphrase?: string

    Shared passphrase used for a single private key and/or a PFX.

  • path?: string
  • peerMaxConcurrentStreams?: number

    Sets the maximum number of concurrent streams for the remote peer as if a SETTINGS frame had been received. Will be overridden if the remote peer sets its own value for maxConcurrentStreams.

  • pfx?: string | Buffer<ArrayBufferLike> | string | Buffer<ArrayBufferLike> | PxfObject[]

    PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form {buf: <string|buffer>[, passphrase: <string>]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

  • port?: number
  • protocol?: 'http:' | 'https:'

    The protocol to connect with, if not set in the authority. Value may be either 'http:' or 'https:'.

  • pskCallback?: (hint: null | string) => null | PSKCallbackNegotation

    When negotiating TLS-PSK (pre-shared keys), this function is called with optional identity hint provided by the server or null in case of TLS 1.3 where hint was removed. It will be necessary to provide a custom tls.checkServerIdentity() for the connection as the default one will try to check hostname/IP of the server against the certificate but that's not applicable for PSK because there won't be a certificate present. More information can be found in the RFC 4279.

  • rejectUnauthorized?: boolean

    If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.

  • remoteCustomSettings?: number[]

    The array of integer values determines the settings types, which are included in the CustomSettings-property of the received remoteSettings. Please see the CustomSettings-property of the Http2Settings object for more information, on the allowed setting types.

  • requestCert?: boolean

    If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.

  • secureContext?: SecureContext

    An optional TLS context object from tls.createSecureContext()

  • secureOptions?: number

    Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options

  • secureProtocol?: string

    Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

  • servername?: string
  • session?: Buffer<ArrayBufferLike>
  • sessionIdContext?: string

    Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.

  • sessionTimeout?: number

    The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.

  • settings?: Settings

    The initial settings to send to the remote peer upon connection.

  • sigalgs?: string

    Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).

  • SNICallback?: (servername: string, cb: (err: null | Error, ctx?: SecureContext) => void) => void

    SNICallback(servername, cb) <Function> A function that will be called if the client supports SNI TLS extension. Two arguments will be passed when called: servername and cb. SNICallback should invoke cb(null, ctx), where ctx is a SecureContext instance. (tls.createSecureContext(...) can be used to get a proper SecureContext.) If SNICallback wasn't provided the default callback with high-level API will be used (see below).

  • strictFieldWhitespaceValidation?: boolean

    If true, it turns on strict leading and trailing whitespace validation for HTTP/2 header field names and values as per RFC-9113.

  • ticketKeys?: Buffer<ArrayBufferLike>

    48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.

  • timeout?: number
  • unknownProtocolTimeout?: number

    Specifies a timeout in milliseconds that a server should wait when an ['unknownProtocol'][] is emitted. If the socket has not been destroyed by that time the server will destroy it.