Refactor responseHeader to responseHeaders (#3375)

nodejs · Jun 26, 2024 · 040d9da · 040d9da
1 parent 01400c5
commit 040d9da
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 3 deletions.
diff --git a/test/types/dispatcher.test-d.ts b/test/types/dispatcher.test-d.ts
@@ -47,6 +47,8 @@ expectAssignable<Dispatcher>(new Dispatcher())
     expectAssignable<Error | null>(err)
     expectAssignable<Dispatcher.ConnectData>(data)
   }))
+  expectAssignable<Promise<Dispatcher.ConnectData>>(dispatcher.connect({ origin: '', path: '', responseHeaders: 'raw' }))
+  expectAssignable<Promise<Dispatcher.ConnectData>>(dispatcher.connect({ origin: '', path: '', responseHeaders: null }))
 
   // request
   expectAssignable<Promise<Dispatcher.ResponseData>>(dispatcher.request({ origin: '', path: '', method: 'GET', maxRedirections: 0 }))
@@ -62,6 +64,8 @@ expectAssignable<Dispatcher>(new Dispatcher())
     expectAssignable<Error | null>(err)
     expectAssignable<Dispatcher.ResponseData>(data)
   }))
+  expectAssignable<Promise<Dispatcher.ResponseData>>(dispatcher.request({ origin: '', path: '', method: 'GET', responseHeaders: 'raw' }))
+  expectAssignable<Promise<Dispatcher.ResponseData>>(dispatcher.request({ origin: '', path: '', method: 'GET', responseHeaders: null }))
 
   // pipeline
   expectAssignable<Duplex>(dispatcher.pipeline({ origin: '', path: '', method: 'GET', maxRedirections: 0 }, data => {
@@ -72,6 +76,14 @@ expectAssignable<Dispatcher>(new Dispatcher())
     expectAssignable<Dispatcher.PipelineHandlerData>(data)
     return new Readable()
   }))
+  expectAssignable<Duplex>(dispatcher.pipeline({ origin: '', path: '', method: 'GET', responseHeaders: 'raw' }, data => {
+    expectAssignable<Dispatcher.PipelineHandlerData>(data)
+    return new Readable()
+  }))
+  expectAssignable<Duplex>(dispatcher.pipeline({ origin: '', path: '', method: 'GET', responseHeaders: null }, data => {
+    expectAssignable<Dispatcher.PipelineHandlerData>(data)
+    return new Readable()
+  }))
 
   // stream
   expectAssignable<Promise<Dispatcher.StreamData>>(dispatcher.stream({ origin: '', path: '', method: 'GET', maxRedirections: 0 }, data => {
@@ -104,13 +116,23 @@ expectAssignable<Dispatcher>(new Dispatcher())
       expectAssignable<Dispatcher.StreamData>(data)
     }
   ))
+  expectAssignable<Promise<Dispatcher.StreamData>>(dispatcher.stream({ origin: '', path: '', method: 'GET', responseHeaders: 'raw' }, data => {
+    expectAssignable<Dispatcher.StreamFactoryData>(data)
+    return new Writable()
+  }))
+  expectAssignable<Promise<Dispatcher.StreamData>>(dispatcher.stream({ origin: '', path: '', method: 'GET', responseHeaders: null }, data => {
+    expectAssignable<Dispatcher.StreamFactoryData>(data)
+    return new Writable()
+  }))
 
   // upgrade
   expectAssignable<Promise<Dispatcher.UpgradeData>>(dispatcher.upgrade({ path: '', maxRedirections: 0 }))
   expectAssignable<void>(dispatcher.upgrade({ path: '' }, (err, data) => {
     expectAssignable<Error | null>(err)
     expectAssignable<Dispatcher.UpgradeData>(data)
   }))
+  expectAssignable<Promise<Dispatcher.UpgradeData>>(dispatcher.upgrade({ path: '', responseHeaders: 'raw' }))
+  expectAssignable<Promise<Dispatcher.UpgradeData>>(dispatcher.upgrade({ path: '', responseHeaders: null }))
 
   // close
   expectAssignable<Promise<void>>(dispatcher.close())

diff --git a/types/dispatcher.d.ts b/types/dispatcher.d.ts
@@ -139,7 +139,7 @@ declare namespace Dispatcher {
     /** Default: false */
     redirectionLimitReached?: boolean;
     /** Default: `null` */
-    responseHeader?: 'raw' | null;
+    responseHeaders?: 'raw' | null;
   }
   export interface RequestOptions extends DispatchOptions {
     /** Default: `null` */
@@ -153,7 +153,7 @@ declare namespace Dispatcher {
     /** Default: `null` */
     onInfo?: (info: { statusCode: number, headers: Record<string, string | string[]> }) => void;
     /** Default: `null` */
-    responseHeader?: 'raw' | null;
+    responseHeaders?: 'raw' | null;
     /** Default: `64 KiB` */
     highWaterMark?: number;
   }
@@ -176,7 +176,7 @@ declare namespace Dispatcher {
     /** Default: false */
     redirectionLimitReached?: boolean;
     /** Default: `null` */
-    responseHeader?: 'raw' | null;
+    responseHeaders?: 'raw' | null;
   }
   export interface ConnectData {
     statusCode: number;