BuildDocsReferenceGuidesBlog
Discord logo
Discord
GitHub logo
FcreateSecureServer
Bun

function

http2.createSecureServer

onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void

Returns a tls.Server instance that creates and manages Http2Session instances.

import http2 from 'node:http2';
import fs from 'node:fs';

const options = {
  key: fs.readFileSync('server-key.pem'),
  cert: fs.readFileSync('server-cert.pem'),
};

// Create a secure HTTP/2 server
const server = http2.createSecureServer(options);

server.on('stream', (stream, headers) => {
  stream.respond({
    'content-type': 'text/html; charset=utf-8',
    ':status': 200,
  });
  stream.end('<h1>Hello World</h1>');
});

server.listen(8443);
@param onRequestHandler

See Compatibility API

function createSecureServer<Http1Request extends typeof IncomingMessage = typeof IncomingMessage, Http1Response extends typeof ServerResponse = typeof ServerResponse, Http2Request extends typeof Http2ServerRequest = typeof Http2ServerRequest, Http2Response extends typeof Http2ServerResponse = typeof Http2ServerResponse>(
options: SecureServerOptions<Http1Request, Http1Response, Http2Request, Http2Response>,
onRequestHandler?: (request: InstanceType<Http2Request>, response: InstanceType<Http2Response>) => void
): Http2SecureServer<Http1Request, Http1Response, Http2Request, Http2Response>;

Returns a tls.Server instance that creates and manages Http2Session instances.

import http2 from 'node:http2';
import fs from 'node:fs';

const options = {
  key: fs.readFileSync('server-key.pem'),
  cert: fs.readFileSync('server-cert.pem'),
};

// Create a secure HTTP/2 server
const server = http2.createSecureServer(options);

server.on('stream', (stream, headers) => {
  stream.respond({
    'content-type': 'text/html; charset=utf-8',
    ':status': 200,
  });
  stream.end('<h1>Hello World</h1>');
});

server.listen(8443);
@param onRequestHandler

See Compatibility API

Referenced types

interface Http2SecureServer<Http1Request extends typeof IncomingMessage = typeof IncomingMessage, Http1Response extends typeof ServerResponse = typeof ServerResponse, Http2Request extends typeof Http2ServerRequest = typeof Http2ServerRequest, Http2Response extends typeof Http2ServerResponse = typeof Http2ServerResponse>

Accepts encrypted connections using TLS or SSL.

  • connections: number
  • readonly listening: boolean

    Indicates whether or not the server is listening for connections.

  • maxConnections: number

    Set this property to reject connections when the server's connection count gets high.

    It is not recommended to use this option once a socket has been sent to a child with child_process.fork().

  • [Symbol.asyncDispose](): Promise<void>;

    Calls () and returns a promise that fulfills when the server has closed.

  • 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.
  }
}
  • hostname: string,
    context: SecureContextOptions | SecureContext
    ): void;

    The server.addContext() method adds a secure context that will be used if the client request's SNI name matches the supplied hostname (or wildcard).

    When there are multiple matching contexts, the most recently added one is used.

    @param hostname

    A SNI host name or wildcard (e.g. '*')

    @param context

    An object containing any of the possible properties from the createSecureContext options arguments (e.g. key, cert, ca, etc), or a TLS context object created with createSecureContext itself.

  • eventName: E,
    listener: (...args: Http2SecureServerEventMap<Http1Request, Http1Response, Http2Request, Http2Response>[E]) => void
    ): this;

    Alias for emitter.on(eventName, listener).

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

    Alias for emitter.on(eventName, listener).

  • address(): null | string | AddressInfo;

    Returns the bound address, the address family name, and port of the server as reported by the operating system if listening on an IP socket (useful to find which port was assigned when getting an OS-assigned address):{ port: 12346, family: 'IPv4', address: '127.0.0.1' }.

    For a server listening on a pipe or Unix domain socket, the name is returned as a string.

    const server = net.createServer((socket) => {
  socket.end('goodbye\n');
}).on('error', (err) => {
  // Handle errors here.
  throw err;
});

// Grab an arbitrary unused port.
server.listen(() => {
  console.log('opened server on', server.address());
});

    server.address() returns null before the 'listening' event has been emitted or after calling server.close().

  • callback?: (err?: Error) => void
    ): this;

    Stops the server from accepting new connections and keeps existing connections. This function is asynchronous, the server is finally closed when all connections are ended and the server emits a 'close' event. The optional callback will be called once the 'close' event occurs. Unlike that event, it will be called with an Error as its only argument if the server was not open when it was closed.

    @param callback

    Called when the server is closed.

  • eventName: E,
    ...args: Http2SecureServerEventMap<Http1Request, Http1Response, Http2Request, Http2Response>[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) ]
  • cb: (error: null | Error, count: number) => void
    ): this;

    Asynchronously get the number of concurrent connections on the server. Works when sockets were sent to forks.

    Callback should take two arguments err and count.

  • getMaxListeners(): number;

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

  • getTicketKeys(): NonSharedBuffer;

    Returns the session ticket keys.

    See Session Resumption for more information.

    @returns

    A 48-byte buffer containing the session ticket keys.

  • port?: number,
    hostname?: string,
    backlog?: number,
    listeningListener?: () => void
    ): this;

    Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.

    Possible signatures:

    • server.listen(handle[, backlog][, callback])
    • server.listen(options[, callback])
    • server.listen(path[, backlog][, callback]) for IPC servers
    • server.listen([port[, host[, backlog]]][, callback]) for TCP servers

    This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.

    All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).

    All Socket are set to SO_REUSEADDR (see socket(7) for details).

    The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.

    One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:

    server.on('error', (e) => {
  if (e.code === 'EADDRINUSE') {
    console.error('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});
    port?: number,
    hostname?: string,
    listeningListener?: () => void
    ): this;

    Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.

    Possible signatures:

    • server.listen(handle[, backlog][, callback])
    • server.listen(options[, callback])
    • server.listen(path[, backlog][, callback]) for IPC servers
    • server.listen([port[, host[, backlog]]][, callback]) for TCP servers

    This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.

    All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).

    All Socket are set to SO_REUSEADDR (see socket(7) for details).

    The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.

    One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:

    server.on('error', (e) => {
  if (e.code === 'EADDRINUSE') {
    console.error('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});
    port?: number,
    backlog?: number,
    listeningListener?: () => void
    ): this;

    Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.

    Possible signatures:

    • server.listen(handle[, backlog][, callback])
    • server.listen(options[, callback])
    • server.listen(path[, backlog][, callback]) for IPC servers
    • server.listen([port[, host[, backlog]]][, callback]) for TCP servers

    This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.

    All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).

    All Socket are set to SO_REUSEADDR (see socket(7) for details).

    The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.

    One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:

    server.on('error', (e) => {
  if (e.code === 'EADDRINUSE') {
    console.error('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});
    port?: number,
    listeningListener?: () => void
    ): this;

    Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.

    Possible signatures:

    • server.listen(handle[, backlog][, callback])
    • server.listen(options[, callback])
    • server.listen(path[, backlog][, callback]) for IPC servers
    • server.listen([port[, host[, backlog]]][, callback]) for TCP servers

    This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.

    All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).

    All Socket are set to SO_REUSEADDR (see socket(7) for details).

    The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.

    One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:

    server.on('error', (e) => {
  if (e.code === 'EADDRINUSE') {
    console.error('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});
    path: string,
    backlog?: number,
    listeningListener?: () => void
    ): this;

    Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.

    Possible signatures:

    • server.listen(handle[, backlog][, callback])
    • server.listen(options[, callback])
    • server.listen(path[, backlog][, callback]) for IPC servers
    • server.listen([port[, host[, backlog]]][, callback]) for TCP servers

    This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.

    All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).

    All Socket are set to SO_REUSEADDR (see socket(7) for details).

    The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.

    One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:

    server.on('error', (e) => {
  if (e.code === 'EADDRINUSE') {
    console.error('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});
    path: string,
    listeningListener?: () => void
    ): this;

    Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.

    Possible signatures:

    • server.listen(handle[, backlog][, callback])
    • server.listen(options[, callback])
    • server.listen(path[, backlog][, callback]) for IPC servers
    • server.listen([port[, host[, backlog]]][, callback]) for TCP servers

    This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.

    All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).

    All Socket are set to SO_REUSEADDR (see socket(7) for details).

    The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.

    One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:

    server.on('error', (e) => {
  if (e.code === 'EADDRINUSE') {
    console.error('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});
    options: ListenOptions,
    listeningListener?: () => void
    ): this;

    Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.

    Possible signatures:

    • server.listen(handle[, backlog][, callback])
    • server.listen(options[, callback])
    • server.listen(path[, backlog][, callback]) for IPC servers
    • server.listen([port[, host[, backlog]]][, callback]) for TCP servers

    This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.

    All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).

    All Socket are set to SO_REUSEADDR (see socket(7) for details).

    The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.

    One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:

    server.on('error', (e) => {
  if (e.code === 'EADDRINUSE') {
    console.error('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});
    handle: any,
    backlog?: number,
    listeningListener?: () => void
    ): this;

    Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.

    Possible signatures:

    • server.listen(handle[, backlog][, callback])
    • server.listen(options[, callback])
    • server.listen(path[, backlog][, callback]) for IPC servers
    • server.listen([port[, host[, backlog]]][, callback]) for TCP servers

    This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.

    All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).

    All Socket are set to SO_REUSEADDR (see socket(7) for details).

    The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.

    One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:

    server.on('error', (e) => {
  if (e.code === 'EADDRINUSE') {
    console.error('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});
    handle: any,
    listeningListener?: () => void
    ): this;

    Start a server listening for connections. A net.Server can be a TCP or an IPC server depending on what it listens to.

    Possible signatures:

    • server.listen(handle[, backlog][, callback])
    • server.listen(options[, callback])
    • server.listen(path[, backlog][, callback]) for IPC servers
    • server.listen([port[, host[, backlog]]][, callback]) for TCP servers

    This function is asynchronous. When the server starts listening, the 'listening' event will be emitted. The last parameter callbackwill be added as a listener for the 'listening' event.

    All listen() methods can take a backlog parameter to specify the maximum length of the queue of pending connections. The actual length will be determined by the OS through sysctl settings such as tcp_max_syn_backlog and somaxconn on Linux. The default value of this parameter is 511 (not 512).

    All Socket are set to SO_REUSEADDR (see socket(7) for details).

    The server.listen() method can be called again if and only if there was an error during the first server.listen() call or server.close() has been called. Otherwise, an ERR_SERVER_ALREADY_LISTEN error will be thrown.

    One of the most common errors raised when listening is EADDRINUSE. This happens when another server is already listening on the requestedport/path/handle. One way to handle this would be to retry after a certain amount of time:

    server.on('error', (e) => {
  if (e.code === 'EADDRINUSE') {
    console.error('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});
  • eventName: E,
    listener?: (...args: Http2SecureServerEventMap<Http1Request, Http1Response, Http2Request, Http2Response>[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: Http2SecureServerEventMap<Http1Request, Http1Response, Http2Request, Http2Response>[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] ]
  • eventName: E,
    listener: (...args: Http2SecureServerEventMap<Http1Request, Http1Response, Http2Request, Http2Response>[E]) => void
    ): this;

    Alias for emitter.removeListener().

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

    Alias for emitter.removeListener().

  • eventName: E,
    listener: (...args: Http2SecureServerEventMap<Http1Request, Http1Response, Http2Request, Http2Response>[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: Http2SecureServerEventMap<Http1Request, Http1Response, Http2Request, Http2Response>[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

  • eventName: E,
    listener: (...args: Http2SecureServerEventMap<Http1Request, Http1Response, Http2Request, Http2Response>[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: Http2SecureServerEventMap<Http1Request, Http1Response, Http2Request, Http2Response>[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: Http2SecureServerEventMap<Http1Request, Http1Response, Http2Request, Http2Response>[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(): this;

    Opposite of unref(), calling ref() on a previously unrefed server will not let the program exit if it's the only server left (the default behavior). If the server is refed calling ref() again will have no effect.

  • 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: Http2SecureServerEventMap<Http1Request, Http1Response, Http2Request, Http2Response>[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.

  • 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.

  • options: SecureContextOptions
    ): void;

    The server.setSecureContext() method replaces the secure context of an existing server. Existing connections to the server are not interrupted.

    @param options

    An object containing any of the possible properties from the createSecureContext options arguments (e.g. key, cert, ca, etc).

  • keys: Buffer
    ): void;

    Sets the session ticket keys.

    Changes to the ticket keys are effective only for future server connections. Existing or currently pending server connections will use the previous keys.

    See Session Resumption for more information.

    @param keys

    A 48-byte buffer containing the session ticket keys.

  • msec?: number,
    callback?: () => void
    ): this;
  • unref(): this;

    Calling unref() on a server will allow the program to exit if this is the only active server in the event system. If the server is already unrefed callingunref() again will have no effect.

  • settings: Settings
    ): void;

    Throws ERR_HTTP2_INVALID_SETTING_VALUE for invalid settings values. Throws ERR_INVALID_ARG_TYPE for invalid settings argument.

interface SecureServerOptions<Http1Request extends typeof IncomingMessage = typeof IncomingMessage, Http1Response extends typeof ServerResponse = typeof ServerResponse, Http2Request extends typeof Http2ServerRequest = typeof Http2ServerRequest, Http2Response extends typeof Http2ServerResponse = typeof Http2ServerResponse>

  • allowHalfOpen?: boolean

    Indicates whether half-opened TCP connections are allowed.

  • allowHTTP1?: boolean
  • 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.)

  • blockList?: BlockList

    blockList can be used for disabling inbound access to specific IP addresses, IP ranges, or IP subnets. This does not work if the server is behind a reverse proxy, NAT, etc. because the address checked against the block list is the address of the proxy, or the one specified by the NAT.

  • 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.

  • 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.

  • 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.

  • handshakeTimeout?: number

    Abort the connection if the SSL/TLS handshake does not finish in the specified number of milliseconds. A 'tlsClientError' is emitted on the tls.Server object whenever a handshake times out. Default: 120000 (120 seconds).

  • highWaterMark?: number

    Optionally overrides all net.Sockets' readableHighWaterMark and writableHighWaterMark.

  • 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

  • Http1IncomingMessage?: Http1Request
  • Http1ServerResponse?: Http1Response
  • Http2ServerRequest?: Http2Request
  • Http2ServerResponse?: Http2Response
  • keepAlive?: boolean

    If set to true, it enables keep-alive functionality on the socket immediately after a new incoming connection is received, similarly on what is done in socket.setKeepAlive([enable][, initialDelay]).

  • keepAliveInitialDelay?: number

    If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket.

  • 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.

  • 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.

  • 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.

  • noDelay?: boolean

    If set to true, it disables the use of Nagle's algorithm immediately after a new incoming connection is received.

  • origins?: string[]
  • 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.

  • pauseOnConnect?: boolean

    Indicates whether the socket should be paused on incoming connections.

  • 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.

  • pskCallback?: (socket: TLSSocket, identity: string) => null | ArrayBufferView<ArrayBufferLike>
  • pskIdentityHint?: string

    hint to send to a client to help with selecting the identity during TLS-PSK negotiation. Will be ignored in TLS 1.3. Upon failing to set pskIdentityHint tlsClientError will be emitted with ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED code.

  • 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.

  • 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.

  • 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.