Mark __httpPeekedData type as deprecated

httptoolkit · Dec 6, 2023 · 92eaae3 · 92eaae3
1 parent 4239d93
commit 92eaae3
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -8,6 +8,11 @@ import { EventEmitter } from 'events';
 
 declare module 'net' {
   interface Socket {
+    /**
+     * Only preserved for types backward compat - always undefined in new releases.
+     *
+     * @deprecated
+     */
     __httpPeekedData?: Buffer;
   }
 }

diff --git a/test/http.spec.ts b/test/http.spec.ts
@@ -73,7 +73,7 @@ describe("HTTP", () => {
             throw new Error("Request handler should not be called");
         });
 
-        const serverErrorPromise = new Promise<any>((resolve) => {
+        const serverErrorPromise = new Promise<[any, net.Socket]>((resolve) => {
             // Multiple errors will be fired - we want to check the data from the final
             // error (which will contain the whole packet)
             let lastResult: any;

diff --git a/test/http2.spec.ts b/test/http2.spec.ts
@@ -102,7 +102,7 @@ describe("HTTP/2", () => {
             throw new Error("Request handler should not be called");
         });
 
-        const serverErrorPromise = new Promise<any>((resolve) => {
+        const serverErrorPromise = new Promise<[any, net.Socket]>((resolve) => {
             // Multiple errors will be fired - we want to check the data from the final
             // error (which will contain the whole packet)
             let lastResult: any;

diff --git a/test/https.spec.ts b/test/https.spec.ts
@@ -118,7 +118,7 @@ describe("HTTPS", () => {
             throw new Error("Request handler should not be called");
         });
 
-        const serverErrorPromise = new Promise<any>((resolve) => {
+        const serverErrorPromise = new Promise<[any, net.Socket]>((resolve) => {
             // Multiple errors will be fired - we want to check the data from the final
             // error (which will contain the whole packet)
             let lastResult: any;