fix(types): fix Logger type (#1104)

chimurai · web-flow · commit cf72bcd7417e · 2025-04-17T20:34:00.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## next
+
+- fix(types): fix Logger type
+
 ## [v3.0.5](https://github.com/chimurai/http-proxy-middleware/releases/tag/v3.0.5)
 
 - fix(fixRequestBody): check readableLength ([#1096](https://github.com/chimurai/http-proxy-middleware/pull/1096))
diff --git a/src/types.ts b/src/types.ts
@@ -136,5 +136,5 @@ export interface Options<TReq = http.IncomingMessage, TRes = http.ServerResponse
    * @link https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/logger.md
    * @since v3.0.0
    */
-  logger?: Logger | any;
+  logger?: Logger;
 }
diff --git a/test/types.spec.ts b/test/types.spec.ts
@@ -101,6 +101,33 @@ describe('http-proxy-middleware TypeScript Types', () => {
         options = { logger: console };
         expect(options).toBeDefined();
       });
+
+      it('should allow custom logger option', () => {
+        const customLogger = {
+          info: () => {},
+          warn: () => {},
+          error: () => {},
+        };
+        options = { logger: customLogger };
+        expect(options).toBeDefined();
+      });
+
+      it('should fail when custom logger has missing log function', () => {
+        const customLogger = {
+          info: () => {},
+          // warn: () => {},
+          error: () => {},
+        };
+        // @ts-expect-error explanation: should error when customLogger has a missing log function
+        options = { logger: customLogger };
+        expect(options).toBeDefined();
+      });
+
+      it('should fail when invalid logger is provided', () => {
+        // @ts-expect-error explanation: should error when invalid logger is provided
+        options = { logger: 500 };
+        expect(options).toBeDefined();
+      });
     });
 
     describe('on', () => {

Original file line number	Diff line number	Diff line change
`@@ -136,5 +136,5 @@ export interface Options<TReq = http.IncomingMessage, TRes = http.ServerResponse`
`136`	`136`	`* @link https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/logger.md`
`137`	`137`	`* @since v3.0.0`
`138`	`138`	`*/`
`139`		`- logger?: Logger \| any;`
	`139`	`+ logger?: Logger;`
`140`	`140`	`}`