feat(TS): add types for composed dispatchers (#2967)

* feat: add types for composed dispatchers * Update types/dispatcher.d.ts * refactor: adjust --------- Co-authored-by: Matteo Collina <[email protected]>
nodejs · Mar 20, 2024 · a045e56 · a045e56
1 parent 5d0cd38
commit a045e56
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/test/types/dispatcher.test-d.ts b/test/types/dispatcher.test-d.ts
@@ -127,6 +127,12 @@ expectAssignable<Dispatcher>(new Dispatcher())
 
 declare const { body }: Dispatcher.ResponseData;
 
+// compose
+{
+  expectAssignable<Dispatcher.ComposedDispatcher>(new Dispatcher().compose(new Dispatcher().dispatch, new Dispatcher().dispatch))
+  expectAssignable<Dispatcher.ComposedDispatcher>(new Dispatcher().compose([new Dispatcher().dispatch, new Dispatcher().dispatch]))
+}
+
 {
   // body mixin tests
   expectType<never | undefined>(body.body)

diff --git a/types/dispatcher.d.ts b/types/dispatcher.d.ts
@@ -18,6 +18,9 @@ declare class Dispatcher extends EventEmitter {
   /** Starts two-way communications with the requested resource. */
   connect(options: Dispatcher.ConnectOptions): Promise<Dispatcher.ConnectData>;
   connect(options: Dispatcher.ConnectOptions, callback: (err: Error | null, data: Dispatcher.ConnectData) => void): void;
+  /** Compose a chain of dispatchers */
+  compose(dispatchers: Dispatcher['dispatch'][]): Dispatcher.ComposedDispatcher;
+  compose(...dispatchers: Dispatcher['dispatch'][]): Dispatcher.ComposedDispatcher;
   /** Performs an HTTP request. */
   request(options: Dispatcher.RequestOptions): Promise<Dispatcher.ResponseData>;
   request(options: Dispatcher.RequestOptions, callback: (err: Error | null, data: Dispatcher.ResponseData) => void): void;
@@ -93,6 +96,8 @@ declare class Dispatcher extends EventEmitter {
 }
 
 declare namespace Dispatcher {
+  export interface ComposedDispatcher extends Dispatcher {}
+  export type DispatcherInterceptor = (dispatch: Dispatcher['dispatch']) => Dispatcher['dispatch'];
   export interface DispatchOptions {
     origin?: string | URL;
     path: string;