@types/node 24.8.1 → 24.9.1

node/http.d.ts

@@ -40,6 +40,7 @@
  * @see [source](https://github.com/nodejs/node/blob/v24.x/lib/http.js)
  */
 declare module "http" {
+    import { NonSharedBuffer } from "node:buffer";
     import * as stream from "node:stream";
     import { URL } from "node:url";
     import { LookupOptions } from "node:dns";
@@ -339,6 +340,17 @@ declare module "http" {
          * If the header's value is an array, the items will be joined using `; `.
          */
         uniqueHeaders?: Array<string | string[]> | undefined;
+        /**
+         * A callback which receives an
+         * incoming request and returns a boolean, to control which upgrade attempts
+         * should be accepted. Accepted upgrades will fire an `'upgrade'` event (or
+         * their sockets will be destroyed, if no listener is registered) while
+         * rejected upgrades will fire a `'request'` event like any non-upgrade
+         * request.
+         * @since v24.9.0
+         * @default () => server.listenerCount('upgrade') > 0
+         */
+        shouldUpgradeCallback?: ((request: InstanceType<Request>) => boolean) | undefined;
         /**
          * If set to `true`, an error is thrown when writing to an HTTP response which does not have a body.
          * @default false
@@ -484,13 +496,13 @@ declare module "http" {
         addListener(event: "clientError", listener: (err: Error, socket: stream.Duplex) => void): this;
         addListener(
             event: "connect",
-            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
+            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: NonSharedBuffer) => void,
         ): this;
         addListener(event: "dropRequest", listener: (req: InstanceType<Request>, socket: stream.Duplex) => void): this;
         addListener(event: "request", listener: RequestListener<Request, Response>): this;
         addListener(
             event: "upgrade",
-            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
+            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: NonSharedBuffer) => void,
         ): this;
         emit(event: string, ...args: any[]): boolean;
         emit(event: "close"): boolean;
@@ -508,14 +520,14 @@ declare module "http" {
             res: InstanceType<Response> & { req: InstanceType<Request> },
         ): boolean;
         emit(event: "clientError", err: Error, socket: stream.Duplex): boolean;
-        emit(event: "connect", req: InstanceType<Request>, socket: stream.Duplex, head: Buffer): boolean;
+        emit(event: "connect", req: InstanceType<Request>, socket: stream.Duplex, head: NonSharedBuffer): boolean;
         emit(event: "dropRequest", req: InstanceType<Request>, socket: stream.Duplex): boolean;
         emit(
             event: "request",
             req: InstanceType<Request>,
             res: InstanceType<Response> & { req: InstanceType<Request> },
         ): boolean;
-        emit(event: "upgrade", req: InstanceType<Request>, socket: stream.Duplex, head: Buffer): boolean;
+        emit(event: "upgrade", req: InstanceType<Request>, socket: stream.Duplex, head: NonSharedBuffer): boolean;
         on(event: string, listener: (...args: any[]) => void): this;
         on(event: "close", listener: () => void): this;
         on(event: "connection", listener: (socket: Socket) => void): this;
@@ -524,10 +536,16 @@ declare module "http" {
         on(event: "checkContinue", listener: RequestListener<Request, Response>): this;
         on(event: "checkExpectation", listener: RequestListener<Request, Response>): this;
         on(event: "clientError", listener: (err: Error, socket: stream.Duplex) => void): this;
-        on(event: "connect", listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void): this;
+        on(
+            event: "connect",
+            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: NonSharedBuffer) => void,
+        ): this;
         on(event: "dropRequest", listener: (req: InstanceType<Request>, socket: stream.Duplex) => void): this;
         on(event: "request", listener: RequestListener<Request, Response>): this;
-        on(event: "upgrade", listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void): this;
+        on(
+            event: "upgrade",
+            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: NonSharedBuffer) => void,
+        ): this;
         once(event: string, listener: (...args: any[]) => void): this;
         once(event: "close", listener: () => void): this;
         once(event: "connection", listener: (socket: Socket) => void): this;
@@ -538,13 +556,13 @@ declare module "http" {
         once(event: "clientError", listener: (err: Error, socket: stream.Duplex) => void): this;
         once(
             event: "connect",
-            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
+            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: NonSharedBuffer) => void,
         ): this;
         once(event: "dropRequest", listener: (req: InstanceType<Request>, socket: stream.Duplex) => void): this;
         once(event: "request", listener: RequestListener<Request, Response>): this;
         once(
             event: "upgrade",
-            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
+            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: NonSharedBuffer) => void,
         ): this;
         prependListener(event: string, listener: (...args: any[]) => void): this;
         prependListener(event: "close", listener: () => void): this;
@@ -556,7 +574,7 @@ declare module "http" {
         prependListener(event: "clientError", listener: (err: Error, socket: stream.Duplex) => void): this;
         prependListener(
             event: "connect",
-            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
+            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: NonSharedBuffer) => void,
         ): this;
         prependListener(
             event: "dropRequest",
@@ -565,7 +583,7 @@ declare module "http" {
         prependListener(event: "request", listener: RequestListener<Request, Response>): this;
         prependListener(
             event: "upgrade",
-            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
+            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: NonSharedBuffer) => void,
         ): this;
         prependOnceListener(event: string, listener: (...args: any[]) => void): this;
         prependOnceListener(event: "close", listener: () => void): this;
@@ -577,7 +595,7 @@ declare module "http" {
         prependOnceListener(event: "clientError", listener: (err: Error, socket: stream.Duplex) => void): this;
         prependOnceListener(
             event: "connect",
-            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
+            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: NonSharedBuffer) => void,
         ): this;
         prependOnceListener(
             event: "dropRequest",
@@ -586,7 +604,7 @@ declare module "http" {
         prependOnceListener(event: "request", listener: RequestListener<Request, Response>): this;
         prependOnceListener(
             event: "upgrade",
-            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: Buffer) => void,
+            listener: (req: InstanceType<Request>, socket: stream.Duplex, head: NonSharedBuffer) => void,
         ): this;
     }
     /**
@@ -1106,7 +1124,7 @@ declare module "http" {
         addListener(event: "abort", listener: () => void): this;
         addListener(
             event: "connect",
-            listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void,
+            listener: (response: IncomingMessage, socket: Socket, head: NonSharedBuffer) => void,
         ): this;
         addListener(event: "continue", listener: () => void): this;
         addListener(event: "information", listener: (info: InformationEvent) => void): this;
@@ -1115,7 +1133,7 @@ declare module "http" {
         addListener(event: "timeout", listener: () => void): this;
         addListener(
             event: "upgrade",
-            listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void,
+            listener: (response: IncomingMessage, socket: Socket, head: NonSharedBuffer) => void,
         ): this;
         addListener(event: "close", listener: () => void): this;
         addListener(event: "drain", listener: () => void): this;
@@ -1128,13 +1146,19 @@ declare module "http" {
          * @deprecated
          */
         on(event: "abort", listener: () => void): this;
-        on(event: "connect", listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
+        on(
+            event: "connect",
+            listener: (response: IncomingMessage, socket: Socket, head: NonSharedBuffer) => void,
+        ): this;
         on(event: "continue", listener: () => void): this;
         on(event: "information", listener: (info: InformationEvent) => void): this;
         on(event: "response", listener: (response: IncomingMessage) => void): this;
         on(event: "socket", listener: (socket: Socket) => void): this;
         on(event: "timeout", listener: () => void): this;
-        on(event: "upgrade", listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
+        on(
+            event: "upgrade",
+            listener: (response: IncomingMessage, socket: Socket, head: NonSharedBuffer) => void,
+        ): this;
         on(event: "close", listener: () => void): this;
         on(event: "drain", listener: () => void): this;
         on(event: "error", listener: (err: Error) => void): this;
@@ -1146,13 +1170,19 @@ declare module "http" {
          * @deprecated
          */
         once(event: "abort", listener: () => void): this;
-        once(event: "connect", listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
+        once(
+            event: "connect",
+            listener: (response: IncomingMessage, socket: Socket, head: NonSharedBuffer) => void,
+        ): this;
         once(event: "continue", listener: () => void): this;
         once(event: "information", listener: (info: InformationEvent) => void): this;
         once(event: "response", listener: (response: IncomingMessage) => void): this;
         once(event: "socket", listener: (socket: Socket) => void): this;
         once(event: "timeout", listener: () => void): this;
-        once(event: "upgrade", listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this;
+        once(
+            event: "upgrade",
+            listener: (response: IncomingMessage, socket: Socket, head: NonSharedBuffer) => void,
+        ): this;
         once(event: "close", listener: () => void): this;
         once(event: "drain", listener: () => void): this;
         once(event: "error", listener: (err: Error) => void): this;
@@ -1166,7 +1196,7 @@ declare module "http" {
         prependListener(event: "abort", listener: () => void): this;
         prependListener(
             event: "connect",
-            listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void,
+            listener: (response: IncomingMessage, socket: Socket, head: NonSharedBuffer) => void,
         ): this;
         prependListener(event: "continue", listener: () => void): this;
         prependListener(event: "information", listener: (info: InformationEvent) => void): this;
@@ -1175,7 +1205,7 @@ declare module "http" {
         prependListener(event: "timeout", listener: () => void): this;
         prependListener(
             event: "upgrade",
-            listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void,
+            listener: (response: IncomingMessage, socket: Socket, head: NonSharedBuffer) => void,
         ): this;
         prependListener(event: "close", listener: () => void): this;
         prependListener(event: "drain", listener: () => void): this;
@@ -1190,7 +1220,7 @@ declare module "http" {
         prependOnceListener(event: "abort", listener: () => void): this;
         prependOnceListener(
             event: "connect",
-            listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void,
+            listener: (response: IncomingMessage, socket: Socket, head: NonSharedBuffer) => void,
         ): this;
         prependOnceListener(event: "continue", listener: () => void): this;
         prependOnceListener(event: "information", listener: (info: InformationEvent) => void): this;
@@ -1199,7 +1229,7 @@ declare module "http" {
         prependOnceListener(event: "timeout", listener: () => void): this;
         prependOnceListener(
             event: "upgrade",
-            listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void,
+            listener: (response: IncomingMessage, socket: Socket, head: NonSharedBuffer) => void,
         ): this;
         prependOnceListener(event: "close", listener: () => void): this;
         prependOnceListener(event: "drain", listener: () => void): this;

node/http2.d.ts

@@ -9,6 +9,7 @@
  * @see [source](https://github.com/nodejs/node/blob/v24.x/lib/http2.js)
  */
 declare module "http2" {
+    import { NonSharedBuffer } from "node:buffer";
     import EventEmitter = require("node:events");
     import * as fs from "node:fs";
     import * as net from "node:net";
@@ -191,7 +192,7 @@ declare module "http2" {
         sendTrailers(headers: OutgoingHttpHeaders): void;
         addListener(event: "aborted", listener: () => void): this;
         addListener(event: "close", listener: () => void): this;
-        addListener(event: "data", listener: (chunk: Buffer | string) => void): this;
+        addListener(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this;
         addListener(event: "drain", listener: () => void): this;
         addListener(event: "end", listener: () => void): this;
         addListener(event: "error", listener: (err: Error) => void): this;
@@ -206,7 +207,7 @@ declare module "http2" {
         addListener(event: string | symbol, listener: (...args: any[]) => void): this;
         emit(event: "aborted"): boolean;
         emit(event: "close"): boolean;
-        emit(event: "data", chunk: Buffer | string): boolean;
+        emit(event: "data", chunk: NonSharedBuffer | string): boolean;
         emit(event: "drain"): boolean;
         emit(event: "end"): boolean;
         emit(event: "error", err: Error): boolean;
@@ -221,7 +222,7 @@ declare module "http2" {
         emit(event: string | symbol, ...args: any[]): boolean;
         on(event: "aborted", listener: () => void): this;
         on(event: "close", listener: () => void): this;
-        on(event: "data", listener: (chunk: Buffer | string) => void): this;
+        on(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this;
         on(event: "drain", listener: () => void): this;
         on(event: "end", listener: () => void): this;
         on(event: "error", listener: (err: Error) => void): this;
@@ -236,7 +237,7 @@ declare module "http2" {
         on(event: string | symbol, listener: (...args: any[]) => void): this;
         once(event: "aborted", listener: () => void): this;
         once(event: "close", listener: () => void): this;
-        once(event: "data", listener: (chunk: Buffer | string) => void): this;
+        once(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this;
         once(event: "drain", listener: () => void): this;
         once(event: "end", listener: () => void): this;
         once(event: "error", listener: (err: Error) => void): this;
@@ -251,7 +252,7 @@ declare module "http2" {
         once(event: string | symbol, listener: (...args: any[]) => void): this;
         prependListener(event: "aborted", listener: () => void): this;
         prependListener(event: "close", listener: () => void): this;
-        prependListener(event: "data", listener: (chunk: Buffer | string) => void): this;
+        prependListener(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this;
         prependListener(event: "drain", listener: () => void): this;
         prependListener(event: "end", listener: () => void): this;
         prependListener(event: "error", listener: (err: Error) => void): this;
@@ -266,7 +267,7 @@ declare module "http2" {
         prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
         prependOnceListener(event: "aborted", listener: () => void): this;
         prependOnceListener(event: "close", listener: () => void): this;
-        prependOnceListener(event: "data", listener: (chunk: Buffer | string) => void): this;
+        prependOnceListener(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this;
         prependOnceListener(event: "drain", listener: () => void): this;
         prependOnceListener(event: "end", listener: () => void): this;
         prependOnceListener(event: "error", listener: (err: Error) => void): this;
@@ -834,10 +835,10 @@ declare module "http2" {
          * @since v8.9.3
          * @param payload Optional ping payload.
          */
-        ping(callback: (err: Error | null, duration: number, payload: Buffer) => void): boolean;
+        ping(callback: (err: Error | null, duration: number, payload: NonSharedBuffer) => void): boolean;
         ping(
             payload: NodeJS.ArrayBufferView,
-            callback: (err: Error | null, duration: number, payload: Buffer) => void,
+            callback: (err: Error | null, duration: number, payload: NonSharedBuffer) => void,
         ): boolean;
         /**
          * Calls `ref()` on this `Http2Session` instance's underlying `net.Socket`.
@@ -899,7 +900,7 @@ declare module "http2" {
         ): this;
         addListener(
             event: "goaway",
-            listener: (errorCode: number, lastStreamID: number, opaqueData?: Buffer) => void,
+            listener: (errorCode: number, lastStreamID: number, opaqueData?: NonSharedBuffer) => void,
         ): this;
         addListener(event: "localSettings", listener: (settings: Settings) => void): this;
         addListener(event: "ping", listener: () => void): this;
@@ -909,7 +910,7 @@ declare module "http2" {
         emit(event: "close"): boolean;
         emit(event: "error", err: Error): boolean;
         emit(event: "frameError", frameType: number, errorCode: number, streamID: number): boolean;
-        emit(event: "goaway", errorCode: number, lastStreamID: number, opaqueData?: Buffer): boolean;
+        emit(event: "goaway", errorCode: number, lastStreamID: number, opaqueData?: NonSharedBuffer): boolean;
         emit(event: "localSettings", settings: Settings): boolean;
         emit(event: "ping"): boolean;
         emit(event: "remoteSettings", settings: Settings): boolean;
@@ -918,7 +919,10 @@ declare module "http2" {
         on(event: "close", listener: () => void): this;
         on(event: "error", listener: (err: Error) => void): this;
         on(event: "frameError", listener: (frameType: number, errorCode: number, streamID: number) => void): this;
-        on(event: "goaway", listener: (errorCode: number, lastStreamID: number, opaqueData?: Buffer) => void): this;
+        on(
+            event: "goaway",
+            listener: (errorCode: number, lastStreamID: number, opaqueData?: NonSharedBuffer) => void,
+        ): this;
         on(event: "localSettings", listener: (settings: Settings) => void): this;
         on(event: "ping", listener: () => void): this;
         on(event: "remoteSettings", listener: (settings: Settings) => void): this;
@@ -927,7 +931,10 @@ declare module "http2" {
         once(event: "close", listener: () => void): this;
         once(event: "error", listener: (err: Error) => void): this;
         once(event: "frameError", listener: (frameType: number, errorCode: number, streamID: number) => void): this;
-        once(event: "goaway", listener: (errorCode: number, lastStreamID: number, opaqueData?: Buffer) => void): this;
+        once(
+            event: "goaway",
+            listener: (errorCode: number, lastStreamID: number, opaqueData?: NonSharedBuffer) => void,
+        ): this;
         once(event: "localSettings", listener: (settings: Settings) => void): this;
         once(event: "ping", listener: () => void): this;
         once(event: "remoteSettings", listener: (settings: Settings) => void): this;
@@ -941,7 +948,7 @@ declare module "http2" {
         ): this;
         prependListener(
             event: "goaway",
-            listener: (errorCode: number, lastStreamID: number, opaqueData?: Buffer) => void,
+            listener: (errorCode: number, lastStreamID: number, opaqueData?: NonSharedBuffer) => void,
         ): this;
         prependListener(event: "localSettings", listener: (settings: Settings) => void): this;
         prependListener(event: "ping", listener: () => void): this;
@@ -956,7 +963,7 @@ declare module "http2" {
         ): this;
         prependOnceListener(
             event: "goaway",
-            listener: (errorCode: number, lastStreamID: number, opaqueData?: Buffer) => void,
+            listener: (errorCode: number, lastStreamID: number, opaqueData?: NonSharedBuffer) => void,
         ): this;
         prependOnceListener(event: "localSettings", listener: (settings: Settings) => void): this;
         prependOnceListener(event: "ping", listener: () => void): this;
@@ -1916,45 +1923,45 @@ declare module "http2" {
          * @since v8.4.0
          */
         setTimeout(msecs: number, callback?: () => void): void;
-        read(size?: number): Buffer | string | null;
+        read(size?: number): NonSharedBuffer | string | null;
         addListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
         addListener(event: "close", listener: () => void): this;
-        addListener(event: "data", listener: (chunk: Buffer | string) => void): this;
+        addListener(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this;
         addListener(event: "end", listener: () => void): this;
         addListener(event: "readable", listener: () => void): this;
         addListener(event: "error", listener: (err: Error) => void): this;
         addListener(event: string | symbol, listener: (...args: any[]) => void): this;
         emit(event: "aborted", hadError: boolean, code: number): boolean;
         emit(event: "close"): boolean;
-        emit(event: "data", chunk: Buffer | string): boolean;
+        emit(event: "data", chunk: NonSharedBuffer | string): boolean;
         emit(event: "end"): boolean;
         emit(event: "readable"): boolean;
         emit(event: "error", err: Error): boolean;
         emit(event: string | symbol, ...args: any[]): boolean;
         on(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
         on(event: "close", listener: () => void): this;
-        on(event: "data", listener: (chunk: Buffer | string) => void): this;
+        on(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this;
         on(event: "end", listener: () => void): this;
         on(event: "readable", listener: () => void): this;
         on(event: "error", listener: (err: Error) => void): this;
         on(event: string | symbol, listener: (...args: any[]) => void): this;
         once(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
         once(event: "close", listener: () => void): this;
-        once(event: "data", listener: (chunk: Buffer | string) => void): this;
+        once(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this;
         once(event: "end", listener: () => void): this;
         once(event: "readable", listener: () => void): this;
         once(event: "error", listener: (err: Error) => void): this;
         once(event: string | symbol, listener: (...args: any[]) => void): this;
         prependListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
         prependListener(event: "close", listener: () => void): this;
-        prependListener(event: "data", listener: (chunk: Buffer | string) => void): this;
+        prependListener(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this;
         prependListener(event: "end", listener: () => void): this;
         prependListener(event: "readable", listener: () => void): this;
         prependListener(event: "error", listener: (err: Error) => void): this;
         prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
         prependOnceListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this;
         prependOnceListener(event: "close", listener: () => void): this;
-        prependOnceListener(event: "data", listener: (chunk: Buffer | string) => void): this;
+        prependOnceListener(event: "data", listener: (chunk: NonSharedBuffer | string) => void): this;
         prependOnceListener(event: "end", listener: () => void): this;
         prependOnceListener(event: "readable", listener: () => void): this;
         prependOnceListener(event: "error", listener: (err: Error) => void): this;
@@ -2614,7 +2621,7 @@ declare module "http2" {
      * ```
      * @since v8.4.0
      */
-    export function getPackedSettings(settings: Settings): Buffer;
+    export function getPackedSettings(settings: Settings): NonSharedBuffer;
     /**
      * Returns a `HTTP/2 Settings Object` containing the deserialized settings from
      * the given `Buffer` as generated by `http2.getPackedSettings()`.