fix: return type of rateLimit (#376)

fastify · Sep 2, 2024 · 4626bc7 · 4626bc7
1 parent 595a627
commit 4626bc7
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 2 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,15 +1,31 @@
 /// <reference types='node' />
 
 import {
+  ContextConfigDefault,
   FastifyPluginCallback,
   FastifyRequest,
+  FastifySchema,
   preHandlerAsyncHookHandler,
+  RouteGenericInterface,
   RouteOptions
 } from 'fastify';
 
 declare module 'fastify' {
-  interface FastifyInstance {
-    rateLimit: (options?: fastifyRateLimit.RateLimitOptions) => preHandlerAsyncHookHandler;
+  interface FastifyInstance<RawServer, RawRequest, RawReply, Logger, TypeProvider> {
+    rateLimit<
+      RouteGeneric extends RouteGenericInterface = RouteGenericInterface,
+      ContextConfig = ContextConfigDefault,
+      SchemaCompiler extends FastifySchema = FastifySchema,
+    >(options?: fastifyRateLimit.RateLimitOptions): preHandlerAsyncHookHandler<
+      RawServer,
+      RawRequest,
+      RawReply,
+      RouteGeneric,
+      ContextConfig,
+      SchemaCompiler,
+      TypeProvider,
+      Logger
+    >;
   }
   interface FastifyContextConfig {
     rateLimit?: fastifyRateLimit.RateLimitOptions | false;

diff --git a/types/index.test-d.ts b/types/index.test-d.ts
@@ -7,6 +7,7 @@ import fastify, {
 } from 'fastify'
 import * as http2 from 'http2'
 import { default as ioredis } from 'ioredis'
+import pino from 'pino';
 import fastifyRateLimit, {
   errorResponseBuilderContext,
   FastifyRateLimitOptions,
@@ -160,3 +161,15 @@ const errorResponseContext: errorResponseBuilderContext = {
   max: 1000,
   ttl: 123
 }
+const appWithCustomLogger = fastify({
+  logger: pino(),
+}).withTypeProvider()
+
+appWithCustomLogger.register(fastifyRateLimit, options1)
+
+appWithCustomLogger.route({
+  method: 'GET',
+  url: '/',
+  preHandler: appWithCustomLogger.rateLimit({}),
+  handler: () => {},
+})