feat(TS): add types

nodejs · Dec 26, 2022 · deb3835 · deb3835
1 parent a8dd12e
commit deb3835
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 7 deletions.
diff --git a/test/types/agent.test-d.ts b/test/types/agent.test-d.ts
@@ -5,7 +5,7 @@ import { URL } from 'url'
 
 expectAssignable<Agent>(new Agent())
 expectAssignable<Agent>(new Agent({}))
-expectAssignable<Agent>(new Agent({ maxRedirections: 1 }))
+expectAssignable<Agent>(new Agent({ maxRedirections: 1, reset: true }))
 expectAssignable<Agent>(new Agent({ factory: () => new Dispatcher() }))
 
 {
@@ -93,7 +93,7 @@ expectAssignable<Agent>(new Agent({ factory: () => new Dispatcher() }))
   }))
 
   // dispatch
-  expectAssignable<boolean>(agent.dispatch({ origin: '', path: '', method: 'GET' }, {}))
+  expectAssignable<boolean>(agent.dispatch({ reset: true, origin: '', path: '', method: 'GET' }, {}))
   expectAssignable<boolean>(agent.dispatch({ origin: '', path: '', method: 'GET', maxRedirections: 1 }, {}))
 
   // close

diff --git a/test/types/api.test-d.ts b/test/types/api.test-d.ts
@@ -5,7 +5,7 @@ import { Dispatcher, request, stream, pipeline, connect, upgrade } from '../..'
 // request
 expectAssignable<Promise<Dispatcher.ResponseData>>(request(''))
 expectAssignable<Promise<Dispatcher.ResponseData>>(request('', { }))
-expectAssignable<Promise<Dispatcher.ResponseData>>(request('', { method: 'GET' }))
+expectAssignable<Promise<Dispatcher.ResponseData>>(request('', { method: 'GET', reset: true }))
 
 // stream
 expectAssignable<Promise<Dispatcher.StreamData>>(stream('', { method: 'GET' }, data => {

diff --git a/test/types/balanced-pool.test-d.ts b/test/types/balanced-pool.test-d.ts
@@ -8,7 +8,7 @@ expectAssignable<BalancedPool>(new BalancedPool('', {}))
 expectAssignable<BalancedPool>(new BalancedPool(new URL('http://localhost'), {}))
 expectAssignable<BalancedPool>(new BalancedPool('', { factory: () => new Dispatcher() }))
 expectAssignable<BalancedPool>(new BalancedPool('', { factory: (origin, opts) => new Client(origin, opts) }))
-expectAssignable<BalancedPool>(new BalancedPool('', { connections: 1 }))
+expectAssignable<BalancedPool>(new BalancedPool('', { connections: 1, reset: true }))
 expectAssignable<BalancedPool>(new BalancedPool(['http://localhost:4242', 'http://www.nodejs.org']))
 
 {
@@ -27,7 +27,7 @@ expectAssignable<BalancedPool>(new BalancedPool(['http://localhost:4242', 'http:
   // request
   expectAssignable<Promise<Dispatcher.ResponseData>>(pool.request({ origin: '', path: '', method: 'GET' }))
   expectAssignable<Promise<Dispatcher.ResponseData>>(pool.request({ origin: new URL('http://localhost'), path: '', method: 'GET' }))
-  expectAssignable<void>(pool.request({ origin: '', path: '', method: 'GET' }, (err, data) => {
+  expectAssignable<void>(pool.request({ reset: false, origin: '', path: '', method: 'GET' }, (err, data) => {
     expectAssignable<Error | null>(err)
     expectAssignable<Dispatcher.ResponseData>(data)
   }))

diff --git a/test/types/pool.test-d.ts b/test/types/pool.test-d.ts
@@ -8,7 +8,7 @@ expectAssignable<Pool>(new Pool('', {}))
 expectAssignable<Pool>(new Pool(new URL('http://localhost'), {}))
 expectAssignable<Pool>(new Pool('', { factory: () => new Dispatcher() }))
 expectAssignable<Pool>(new Pool('', { factory: (origin, opts) => new Client(origin, opts) }))
-expectAssignable<Pool>(new Pool('', { connections: 1 }))
+expectAssignable<Pool>(new Pool('', { connections: 1, reset: true }))
 
 {
   const pool = new Pool('', {})
@@ -21,7 +21,7 @@ expectAssignable<Pool>(new Pool('', { connections: 1 }))
   // request
   expectAssignable<Promise<Dispatcher.ResponseData>>(pool.request({ origin: '', path: '', method: 'GET' }))
   expectAssignable<Promise<Dispatcher.ResponseData>>(pool.request({ origin: new URL('http://localhost'), path: '', method: 'GET' }))
-  expectAssignable<void>(pool.request({ origin: '', path: '', method: 'GET' }, (err, data) => {
+  expectAssignable<void>(pool.request({ reset: false, origin: '', path: '', method: 'GET' }, (err, data) => {
     expectAssignable<Error | null>(err)
     expectAssignable<Dispatcher.ResponseData>(data)
   }))

diff --git a/types/client.d.ts b/types/client.d.ts
@@ -27,6 +27,8 @@ declare namespace Client {
     keepAliveTimeoutThreshold?: number | null;
     /** The amount of concurrent requests to be sent over the single TCP/TLS connection according to [RFC7230](https://tools.ietf.org/html/rfc7230#section-6.3.2). Default: `1`. */
     pipelining?: number | null;
+    /** Indicate wether or not send `connection` header with keep-alive value for long-living connections */
+    reset?: boolean;
     /** **/
     connect?: buildConnector.BuildOptions | buildConnector.connector | null;
     /** The maximum length of request headers in bytes. Default: `16384` (16KiB). */

diff --git a/types/dispatcher.d.ts b/types/dispatcher.d.ts
@@ -97,6 +97,8 @@ declare namespace Dispatcher {
     origin?: string | URL;
     path: string;
     method: HttpMethod;
+    /** Indicate wether or not send `connection` header with keep-alive value for long-living connections */
+    reset?: boolean;
     /** Default: `null` */
     body?: string | Buffer | Uint8Array | Readable | null | FormData;
     /** Default: `null` */