Fix type definition for Client Interceptors (nodejs#2269)

Updating the client constructor to accept an array of interceptor functions to match the documentation.
crysmags · Feb 27, 2024 · a5a51b0 · a5a51b0
1 parent 9f2c705
commit a5a51b0
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/test/types/client.test-d.ts b/test/types/client.test-d.ts
@@ -68,6 +68,18 @@ expectAssignable<Client>(new Client(new URL('http://localhost'), {}))
   expectAssignable<Client>(new Client('', {
     autoSelectFamilyAttemptTimeout: 300e3
   }))
+  expectAssignable<Client>(new Client('', {
+    interceptors: {
+      Client: [(dispatcher) => {
+        expectAssignable<Dispatcher['dispatch']>(dispatcher);
+        return (opts, handlers) => {
+          expectAssignable<Dispatcher.DispatchOptions>(opts);
+          expectAssignable<Dispatcher.DispatchHandlers>(handlers);
+          return dispatcher(opts, handlers)
+        }
+      }]
+    }
+  }))
 }
 
 {

diff --git a/types/client.d.ts b/types/client.d.ts
@@ -1,7 +1,6 @@
 import { URL } from 'url'
 import { TlsOptions } from 'tls'
 import Dispatcher from './dispatcher'
-import DispatchInterceptor from './dispatcher'
 import buildConnector from "./connector";
 
 /**
@@ -19,7 +18,7 @@ export class Client extends Dispatcher {
 
 export declare namespace Client {
   export interface OptionsInterceptors {
-    Client: readonly DispatchInterceptor[];
+    Client: readonly Dispatcher.DispatchInterceptor[];
   }
   export interface Options {
     /** TODO */