@nestjs/throttler 4.2.1 → 5.0.0

package/README.md

@@ -20,8 +20,6 @@
 <a href="https://opencollective.com/nest#sponsor"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
   <a href="https://twitter.com/nestframework"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
 </p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
 
 ## Description
 
@@ -50,185 +48,117 @@ For NestJS v10, please use version 4.1.0 or above
 - [Table of Contents](#table-of-contents)
 - [Usage](#usage)
   - [ThrottlerModule](#throttlermodule)
-  - [Decorators](#decorators)
-    - [@Throttle()](#throttle)
-    - [@SkipThrottle()](#skipthrottle)
-  - [Ignoring specific user agents](#ignoring-specific-user-agents)
-  - [ThrottlerStorage](#throttlerstorage)
+  - [Customization](#customization)
+  - [ThrottlerStorage](#storages)
   - [Proxies](#proxies)
-  - [Working with Websockets](#working-with-websockets)
-  - [Working with GraphQL](#working-with-graphql)
+  - [Working with Websockets](#websockets)
+  - [Working with GraphQL](#graphql)
 - [Community Storage Providers](#community-storage-providers)
 
 ## Usage
 
 ### ThrottlerModule
 
-The `ThrottleModule` is the main entry point for this package, and can be used
-in a synchronous or asynchronous manner. All the needs to be passed is the
-`ttl`, the time to live in seconds for the request tracker, and the `limit`, or
-how many times an endpoint can be hit before returning a 429.
-
-```ts
-import { APP_GUARD } from '@nestjs/core';
-import { ThrottlerGuard, ThrottlerModule } from '@nestjs/throttler';
+Once the installation is complete, the `ThrottlerModule` can be configured as any other Nest package with `forRoot` or `forRootAsync` methods.
 
+```typescript
+@@filename(app.module)
 @Module({
   imports: [
-    ThrottlerModule.forRoot({
-      ttl: 60,
+    ThrottlerModule.forRoot([{
+      ttl: 60000,
       limit: 10,
-    }),
-  ],
-  providers: [
-    {
-      provide: APP_GUARD,
-      useClass: ThrottlerGuard,
-    },
+    }]),
   ],
 })
 export class AppModule {}
 ```
 
-The above would mean that 10 requests from the same IP can be made to a single endpoint in 1 minute.
+The above will set the global options for the `ttl`, the time to live in milliseconds, and the `limit`, the maximum number of requests within the ttl, for the routes of your application that are guarded.
 
-```ts
-@Module({
-  imports: [
-    ThrottlerModule.forRootAsync({
-      imports: [ConfigModule],
-      inject: [ConfigService],
-      useFactory: (config: ConfigService) => ({
-        ttl: config.get('THROTTLE_TTL'),
-        limit: config.get('THROTTLE_LIMIT'),
-      }),
-    }),
-  ],
-  providers: [
-    {
-      provide: APP_GUARD,
-      useClass: ThrottlerGuard,
-    },
-  ],
-})
-export class AppModule {}
-```
+Once the module has been imported, you can then choose how you would like to bind the `ThrottlerGuard`. Any kind of binding as mentioned in the [guards](https://docs.nestjs.com/guards) section is fine. If you wanted to bind the guard globally, for example, you could do so by adding this provider to any module:
 
-The above is also a valid configuration for asynchronous registration of the module.
+```typescript
+{
+  provide: APP_GUARD,
+  useClass: ThrottlerGuard
+}
+```
 
-**NOTE:** If you add the `ThrottlerGuard` to your `AppModule` as a global guard
-then all the incoming requests will be throttled by default. This can also be
-omitted in favor of `@UseGuards(ThrottlerGuard)`. The global guard check can be
-skipped using the `@SkipThrottle()` decorator mentioned later.
+#### Multiple Throttler Definitions
 
-Example with `@UseGuards(ThrottlerGuard)`:
+There may come upon times where you want to set up multiple throttling definitions, like no more than 3 calls in a second, 20 calls in 10 seconds, and 100 calls in a minute. To do so, you can set up your definitions in the array with named options, that can later be referenced in the `@SkipThrottle()` and `@Throttle()` decorators to change the options again.
 
-```ts
-// app.module.ts
+```typescript
+@@filename(app.module)
 @Module({
   imports: [
-    ThrottlerModule.forRoot({
-      ttl: 60,
-      limit: 10,
-    }),
+    ThrottlerModule.forRoot([
+      {
+        name: 'short'
+        ttl: 1000,
+        limit: 3,
+      },
+      {
+        name: 'medium',
+        ttl: 10000,
+        limit: 20
+      },
+      {
+        long: 'long',
+        ttl: 60000,
+        limit: 100
+      }
+    ]),
   ],
 })
 export class AppModule {}
-
-// app.controller.ts
-@Controller()
-export class AppController {
-  @UseGuards(ThrottlerGuard)
-  @Throttle(5, 30)
-  normal() {}
-}
 ```
 
-### Decorators
+#### Customization
 
-#### @Throttle()
+There may be a time where you want to bind the guard to a controller or globally, but want to disable rate limiting for one or more of your endpoints. For that, you can use the `@SkipThrottle()` decorator, to negate the throttler for an entire class or a single route. The `@SkipThrottle()` decorator can also take in an object of string keys with boolean values for if there is a case where you want to exclude _most_ of a controller, but not every route, and configure it per throttler set if you have more than one. If you do not pass an object, the default is to use `{{ '{' }} default: true {{ '}' }}`
 
-```ts
-@Throttle(limit: number = 30, ttl: number = 60)
-```
-
-This decorator will set `THROTTLER_LIMIT` and `THROTTLER_TTL` metadatas on the
-route, for retrieval from the `Reflector` class. Can be applied to controllers
-and routes.
-
-#### @SkipThrottle()
-
-```ts
-@SkipThrottle(skip = true)
+```typescript
+@SkipThrottle()
+@Controller('users')
+export class UsersController {}
 ```
 
-This decorator can be used to skip a route or a class **or** to negate the
-skipping of a route in a class that is skipped.
+This `@SkipThrottle()` decorator can be used to skip a route or a class or to negate the skipping of a route in a class that is skipped.
 
-```ts
+```typescript
 @SkipThrottle()
-@Controller()
-export class AppController {
-  @SkipThrottle(false)
-  dontSkip() {}
-
-  doSkip() {}
+@Controller('users')
+export class UsersController {
+  // Rate limiting is applied to this route.
+  @SkipThrottle({ default: false })
+  dontSkip() {
+    return 'List users work with Rate limiting.';
+  }
+  // This route will skip rate limiting.
+  doSkip() {
+    return 'List users work without Rate limiting.';
+  }
 }
 ```
 
-In the above controller, `dontSkip` would be counted against and rate-limited
-while `doSkip` would not be limited in any way.
-
-### Ignoring specific user agents
-
-You can use the `ignoreUserAgents` key to ignore specific user agents.
-
-```ts
-@Module({
-  imports: [
-    ThrottlerModule.forRoot({
-      ttl: 60,
-      limit: 10,
-      ignoreUserAgents: [
-        // Don't throttle request that have 'googlebot' defined in them.
-        // Example user agent: Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)
-        /googlebot/gi,
-
-        // Don't throttle request that have 'bingbot' defined in them.
-        // Example user agent: Mozilla/5.0 (compatible; Bingbot/2.0; +http://www.bing.com/bingbot.htm)
-        new RegExp('bingbot', 'gi'),
-      ],
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-### ThrottlerStorage
-
-Interface to define the methods to handle the details when it comes to keeping track of the requests.
+There is also the `@Throttle()` decorator which can be used to override the `limit` and `ttl` set in the global module, to give tighter or looser security options. This decorator can be used on a class or a function as well. With version 5 and onwards, the decorator takes in an object with the string relating to the name of the throttler set, and an object with the limit and ttl keys and integer values, similar to the options passed to the root module. If you do not have a name set in your original options, use the string `default` You have to configure it like this:
 
-Currently the key is seen as an `MD5` hash of the `IP` the `ClassName` and the
-`MethodName`, to ensure that no unsafe characters are used and to ensure that
-the package works for contexts that don't have explicit routes (like Websockets
-and GraphQL).
-
-The interface looks like this:
-
-```ts
-export interface ThrottlerStorage {
-  storage: Record<string, ThrottlerStorageOptions>;
-  increment(key: string, ttl: number): Promise<ThrottlerStorageRecord>;
+```typescript
+// Override default configuration for Rate limiting and duration.
+@Throttle({ default: { limit: 3, ttl: 60000 } })
+@Get()
+findAll() {
+  return "List users works with custom rate limiting.";
 }
 ```
 
-So long as the Storage service implements this interface, it should be usable by the `ThrottlerGuard`.
-
-### Proxies
+#### Proxies
 
-If you are working behind a proxy, check the specific HTTP adapter options ([express](http://expressjs.com/en/guide/behind-proxies.html) and [fastify](https://www.fastify.io/docs/latest/Server/#trustproxy)) for the `trust proxy` option and enable it. Doing so will allow you to get the original IP address from the `X-Forward-For` header, and you can override the `getTracker()` method to pull the value from the header rather than from `req.ip`. The following example works with both express and fastify:
+If your application runs behind a proxy server, check the specific HTTP adapter options ([express](http://expressjs.com/en/guide/behind-proxies.html) and [fastify](https://www.fastify.io/docs/latest/Reference/Server/#trustproxy)) for the `trust proxy` option and enable it. Doing so will allow you to get the original IP address from the `X-Forwarded-For` header, and you can override the `getTracker()` method to pull the value from the header rather than from `req.ip`. The following example works with both express and fastify:
 
-```ts
+```typescript
 // throttler-behind-proxy.guard.ts
 import { ThrottlerGuard } from '@nestjs/throttler';
 import { Injectable } from '@nestjs/common';
@@ -242,23 +172,22 @@ export class ThrottlerBehindProxyGuard extends ThrottlerGuard {
 
 // app.controller.ts
 import { ThrottlerBehindProxyGuard } from './throttler-behind-proxy.guard';
+
 @UseGuards(ThrottlerBehindProxyGuard)
 ```
 
-### Working with Websockets
+> info **Hint** You can find the API of the `req` Request object for express [here](https://expressjs.com/en/api.html#req.ips) and for fastify [here](https://www.fastify.io/docs/latest/Reference/Request/).
+
+#### Websockets
 
-To work with Websockets you can extend the `ThrottlerGuard` and override the `handleRequest` method with something like the following method
+This module can work with websockets, but it requires some class extension. You can extend the `ThrottlerGuard` and override the `handleRequest` method like so:
 
-```ts
+```typescript
 @Injectable()
 export class WsThrottlerGuard extends ThrottlerGuard {
   async handleRequest(context: ExecutionContext, limit: number, ttl: number): Promise<boolean> {
     const client = context.switchToWs().getClient();
-    // this is a generic method to switch between `ws` and `socket.io`. You can choose what is appropriate for you
-    const ip = ['conn', '_socket']
-      .map((key) => client[key])
-      .filter((obj) => obj)
-      .shift().remoteAddress;
+    const ip = client._socket.remoteAddress;
     const key = this.generateKey(context, ip);
     const { totalHits } = await this.storageService.increment(key, ttl);
 
@@ -271,33 +200,149 @@ export class WsThrottlerGuard extends ThrottlerGuard {
 }
 ```
 
-There are some things to take keep in mind when working with websockets:
+> info **Hint** If you are using ws, it is necessary to replace the `_socket` with `conn`
+
+There's a few things to keep in mind when working with WebSockets:
 
-- You cannot bind the guard with `APP_GUARD` or `app.useGlobalGuards()` due to how Nest binds global guards.
-- When a limit is reached, Nest will emit an `exception` event, so make sure there is a listener ready for this.
+- Guard cannot be registered with the `APP_GUARD` or `app.useGlobalGuards()`
+- When a limit is reached, Nest will emit an `exception` event, so make sure there is a listener ready for this
 
-### Working with GraphQL
+> info **Hint** If you are using the `@nestjs/platform-ws` package you can use `client._socket.remoteAddress` instead.
 
-To get the `ThrottlerModule` to work with the GraphQL context, a couple of things must happen.
+#### GraphQL
 
-- You must use `Express` and `apollo-server-express` as your GraphQL server engine. This is
-  the default for Nest, but the [`apollo-server-fastify`](https://github.com/apollographql/apollo-server/tree/master/packages/apollo-server-fastify) package does not currently support passing `res` to the `context`, meaning headers cannot be properly set.
-- When configuring your `GraphQLModule`, you need to pass an option for `context` in the form
-  of `({ req, res}) => ({ req, res })`. This will allow access to the Express Request and Response
-  objects, allowing for the reading and writing of headers.
-- You must add in some additional context switching to get the `ExecutionContext` to pass back values correctly (or you can override the method entirely)
+The `ThrottlerGuard` can also be used to work with GraphQL requests. Again, the guard can be extended, but this time the `getRequestResponse` method will be overridden
 
-```ts
+```typescript
 @Injectable()
 export class GqlThrottlerGuard extends ThrottlerGuard {
   getRequestResponse(context: ExecutionContext) {
     const gqlCtx = GqlExecutionContext.create(context);
     const ctx = gqlCtx.getContext();
-    return { req: ctx.req, res: ctx.res }; // ctx.request and ctx.reply for fastify
+    return { req: ctx.req, res: ctx.res };
   }
 }
 ```
 
+#### Configuration
+
+The following options are valid for the object passed to the array of the `ThrottlerModule`'s options:
+
+<table>
+  <tr>
+    <td><code>name</code></td>
+    <td>the name for internal tracking of which throttler set is being used. Defaults to `default` if not passed</td>
+  </tr>
+  <tr>
+    <td><code>ttl</code></td>
+    <td>the number of milliseconds that each request will last in storage</td>
+  </tr>
+  <tr>
+    <td><code>limit</code></td>
+    <td>the maximum number of requests within the TTL limit</td>
+  </tr>
+  <tr>
+    <td><code>ignoreUserAgents</code></td>
+    <td>an array of regular expressions of user-agents to ignore when it comes to throttling requests</td>
+  </tr>
+  <tr>
+    <td><code>skipIf</code></td>
+    <td>a function that takes in the <code>ExecutionContext</code> and returns a <code>boolean</code> to short circuit the throttler logic. Like <code>@SkipThrottler()</code>, but based on the request</td>
+  </tr>
+</table>
+
+If you need to set up storages instead, or want to use a some of the above options in a more global sense, applying to each throttler set, you can pass the options above via the `throttlers` option key and use the below table
+
+<table>
+  <tr>
+    <td><code>storage</code></td>
+    <td>a custom storage service for where the throttling should be kept track. <a href="/security/rate-limiting#storages">See here.</a></td>
+  </tr>
+  <tr>
+    <td><code>ignoreUserAgents</code></td>
+    <td>an array of regular expressions of user-agents to ignore when it comes to throttling requests</td>
+  </tr>
+  <tr>
+    <td><code>skipIf</code></td>
+    <td>a function that takes in the <code>ExecutionContext</code> and returns a <code>boolean</code> to short circuit the throttler logic. Like <code>@SkipThrottler()</code>, but based on the request</td>
+  </tr>
+  <tr>
+    <td><code>throttlers</code></td>
+    <td>an array of throttler sets, defined using the table above</td>
+  </tr>
+</table>
+
+#### Async Configuration
+
+You may want to get your rate-limiting configuration asynchronously instead of synchronously. You can use the `forRootAsync()` method, which allows for dependency injection and `async` methods.
+
+One approach would be to use a factory function:
+
+```typescript
+@Module({
+  imports: [
+    ThrottlerModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: (config: ConfigService) => [
+        {
+          ttl: config.get('THROTTLE_TTL'),
+          limit: config.get('THROTTLE_LIMIT'),
+        },
+      ],
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+You can also use the `useClass` syntax:
+
+```typescript
+@Module({
+  imports: [
+    ThrottlerModule.forRootAsync({
+      imports: [ConfigModule],
+      useClass: ThrottlerConfigService,
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+This is doable, as long as `ThrottlerConfigService` implements the interface `ThrottlerOptionsFactory`.
+
+#### Storages
+
+The built in storage is an in memory cache that keeps track of the requests made until they have passed the TTL set by the global options. You can drop in your own storage option to the `storage` option of the `ThrottlerModule` so long as the class implements the `ThrottlerStorage` interface.
+
+> info **Note** `ThrottlerStorage` can be imported from `@nestjs/throttler`.
+
+#### Time Helpers
+
+There are a couple of helper methods to make the timings more readable if you prefer to use them over the direct definition. `@nestjs/throttler` exports five different helpers, `seconds`, `minutes`, `hours`, `days`, and `weeks`. To use them, simply call `seconds(5)` or any of the other helpers, and the correct number of milliseconds will be returned.
+
+#### Migration Guide
+
+For most people, wrapping your options in an array will be enough.
+
+If you are using a custom storage, you should wrap you `ttl` and `limit` in an
+array and assign it to the `throttlers` property of the options object.
+
+Any `@ThrottleSkip()` should now take in an object with `string: boolean` props.
+The strings are the names of the throttlers. If you do not have a name, pass the
+string `'default'`, as this is what will be used under the hood otherwise.
+
+Any `@Throttle()` decorators should also now take in an object with string keys,
+relating to the names of the throttler contexts (again, `'default'` if no name)
+and values of objects that have `limit` and `ttl` keys.
+
+> Warning **Important** The `ttl` is now in **milliseconds**. If you want to keep your ttl
+> in seconds for readability, use the `seconds` helper from this package. It just
+> multiplies the ttl by 1000 to make it in milliseconds.
+
+For more info, see the [Changelog](https://github.com/nestjs/throttler/blob/master/CHANGELOG.md#500)
+
 ## Community Storage Providers
 
 - [Redis](https://github.com/kkoomen/nestjs-throttler-storage-redis)

package/dist/index.d.ts

@@ -6,3 +6,4 @@ export * from './throttler.guard';
 export * from './throttler.module';
 export { getOptionsToken, getStorageToken } from './throttler.providers';
 export * from './throttler.service';
+export * from './utilities';

package/dist/index.js

@@ -25,4 +25,5 @@ var throttler_providers_1 = require("./throttler.providers");
 Object.defineProperty(exports, "getOptionsToken", { enumerable: true, get: function () { return throttler_providers_1.getOptionsToken; } });
 Object.defineProperty(exports, "getStorageToken", { enumerable: true, get: function () { return throttler_providers_1.getStorageToken; } });
 __exportStar(require("./throttler.service"), exports);
+__exportStar(require("./utilities"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,uEAAqD;AACrD,gEAA8C;AAC9C,wDAAsC;AACtC,wDAAsC;AACtC,oDAAkC;AAClC,qDAAmC;AACnC,6DAAyE;AAAhE,sHAAA,eAAe,OAAA;AAAE,sHAAA,eAAe,OAAA;AACzC,sDAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,uEAAqD;AACrD,gEAA8C;AAC9C,wDAAsC;AACtC,wDAAsC;AACtC,oDAAkC;AAClC,qDAAmC;AACnC,6DAAyE;AAAhE,sHAAA,eAAe,OAAA;AAAE,sHAAA,eAAe,OAAA;AACzC,sDAAoC;AACpC,8CAA4B"}

package/dist/throttler-module-options.interface.d.ts

@@ -1,11 +1,19 @@
 import { ExecutionContext, ModuleMetadata, Type } from '@nestjs/common/interfaces';
-export interface ThrottlerModuleOptions {
-    limit?: number;
-    ttl?: number;
+import { ThrottlerStorage } from './throttler-storage.interface';
+export type Resolvable<T extends number | string | boolean> = T | ((context: ExecutionContext) => T | Promise<T>);
+export interface ThrottlerOptions {
+    name?: string;
+    limit: Resolvable<number>;
+    ttl: Resolvable<number>;
     ignoreUserAgents?: RegExp[];
-    storage?: any;
     skipIf?: (context: ExecutionContext) => boolean;
 }
+export type ThrottlerModuleOptions = Array<ThrottlerOptions> | {
+    skipIf?: (context: ExecutionContext) => boolean;
+    ignoreUserAgents?: RegExp[];
+    storage?: ThrottlerStorage;
+    throttlers: Array<ThrottlerOptions>;
+};
 export interface ThrottlerOptionsFactory {
     createThrottlerOptions(): Promise<ThrottlerModuleOptions> | ThrottlerModuleOptions;
 }

package/dist/throttler-storage.interface.d.ts

@@ -1,7 +1,5 @@
-import { ThrottlerStorageOptions } from './throttler-storage-options.interface';
 import { ThrottlerStorageRecord } from './throttler-storage-record.interface';
 export interface ThrottlerStorage {
-    storage: Record<string, ThrottlerStorageOptions>;
     increment(key: string, ttl: number): Promise<ThrottlerStorageRecord>;
 }
 export declare const ThrottlerStorage: unique symbol;

package/dist/throttler-storage.interface.js.map

@@ -1 +1 @@
-{"version":3,"file":"throttler-storage.interface.js","sourceRoot":"","sources":["../src/throttler-storage.interface.ts"],"names":[],"mappings":";;;AAiBa,QAAA,gBAAgB,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC"}
+{"version":3,"file":"throttler-storage.interface.js","sourceRoot":"","sources":["../src/throttler-storage.interface.ts"],"names":[],"mappings":";;;AAUa,QAAA,gBAAgB,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC"}

package/dist/throttler.decorator.d.ts

@@ -1,4 +1,10 @@
-export declare const Throttle: (limit?: number, ttl?: number) => MethodDecorator & ClassDecorator;
-export declare const SkipThrottle: (skip?: boolean) => MethodDecorator & ClassDecorator;
+import { Resolvable } from './throttler-module-options.interface';
+interface ThrottlerMethodOrControllerOptions {
+    limit?: Resolvable<number>;
+    ttl?: Resolvable<number>;
+}
+export declare const Throttle: (options: Record<string, ThrottlerMethodOrControllerOptions>) => MethodDecorator & ClassDecorator;
+export declare const SkipThrottle: (skip?: Record<string, boolean>) => MethodDecorator & ClassDecorator;
 export declare const InjectThrottlerOptions: () => PropertyDecorator & ParameterDecorator;
 export declare const InjectThrottlerStorage: () => PropertyDecorator & ParameterDecorator;
+export {};

package/dist/throttler.decorator.js

@@ -4,29 +4,33 @@ exports.InjectThrottlerStorage = exports.InjectThrottlerOptions = exports.SkipTh
 const common_1 = require("@nestjs/common");
 const throttler_constants_1 = require("./throttler.constants");
 const throttler_providers_1 = require("./throttler.providers");
-function setThrottlerMetadata(target, limit, ttl) {
-    Reflect.defineMetadata(throttler_constants_1.THROTTLER_TTL, ttl, target);
-    Reflect.defineMetadata(throttler_constants_1.THROTTLER_LIMIT, limit, target);
+function setThrottlerMetadata(target, options) {
+    for (const name in options) {
+        Reflect.defineMetadata(throttler_constants_1.THROTTLER_TTL + name, options[name].ttl, target);
+        Reflect.defineMetadata(throttler_constants_1.THROTTLER_LIMIT + name, options[name].limit, target);
+    }
 }
-const Throttle = (limit = 20, ttl = 60) => {
+const Throttle = (options) => {
     return (target, propertyKey, descriptor) => {
         if (descriptor) {
-            setThrottlerMetadata(descriptor.value, limit, ttl);
+            setThrottlerMetadata(descriptor.value, options);
             return descriptor;
         }
-        setThrottlerMetadata(target, limit, ttl);
+        setThrottlerMetadata(target, options);
         return target;
     };
 };
 exports.Throttle = Throttle;
-const SkipThrottle = (skip = true) => {
+const SkipThrottle = (skip = { default: true }) => {
     return (target, propertyKey, descriptor) => {
-        if (descriptor) {
-            Reflect.defineMetadata(throttler_constants_1.THROTTLER_SKIP, skip, descriptor.value);
-            return descriptor;
+        for (const key in skip) {
+            if (descriptor) {
+                Reflect.defineMetadata(throttler_constants_1.THROTTLER_SKIP + key, skip[key], descriptor.value);
+                return descriptor;
+            }
+            Reflect.defineMetadata(throttler_constants_1.THROTTLER_SKIP + key, skip[key], target);
+            return target;
         }
-        Reflect.defineMetadata(throttler_constants_1.THROTTLER_SKIP, skip, target);
-        return target;
     };
 };
 exports.SkipThrottle = SkipThrottle;

package/dist/throttler.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"throttler.decorator.js","sourceRoot":"","sources":["../src/throttler.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AACxC,+DAAuF;AACvF,+DAAyE;AAEzE,SAAS,oBAAoB,CAAC,MAAW,EAAE,KAAa,EAAE,GAAW;IACnE,OAAO,CAAC,cAAc,CAAC,mCAAa,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IACnD,OAAO,CAAC,cAAc,CAAC,qCAAe,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC;AAQM,MAAM,QAAQ,GAAG,CAAC,KAAK,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,EAAoC,EAAE;IACjF,OAAO,CACL,MAAW,EACX,WAA6B,EAC7B,UAAyC,EACzC,EAAE;QACF,IAAI,UAAU,EAAE;YACd,oBAAoB,CAAC,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;YACnD,OAAO,UAAU,CAAC;SACnB;QACD,oBAAoB,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;QACzC,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,QAAQ,YAanB;AASK,MAAM,YAAY,GAAG,CAAC,IAAI,GAAG,IAAI,EAAoC,EAAE;IAC5E,OAAO,CACL,MAAW,EACX,WAA6B,EAC7B,UAAyC,EACzC,EAAE;QACF,IAAI,UAAU,EAAE;YACd,OAAO,CAAC,cAAc,CAAC,oCAAc,EAAE,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;YAC/D,OAAO,UAAU,CAAC;SACnB;QACD,OAAO,CAAC,cAAc,CAAC,oCAAc,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACrD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,YAAY,gBAavB;AAOK,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,IAAA,qCAAe,GAAE,CAAC,CAAC;AAAzD,QAAA,sBAAsB,0BAAmC;AAO/D,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,IAAA,qCAAe,GAAE,CAAC,CAAC;AAAzD,QAAA,sBAAsB,0BAAmC"}
+{"version":3,"file":"throttler.decorator.js","sourceRoot":"","sources":["../src/throttler.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AACxC,+DAAuF;AACvF,+DAAyE;AAQzE,SAAS,oBAAoB,CAC3B,MAAW,EACX,OAA2D;IAE3D,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE;QAC1B,OAAO,CAAC,cAAc,CAAC,mCAAa,GAAG,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACxE,OAAO,CAAC,cAAc,CAAC,qCAAe,GAAG,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;KAC7E;AACH,CAAC;AASM,MAAM,QAAQ,GAAG,CACtB,OAA2D,EACzB,EAAE;IACpC,OAAO,CACL,MAAW,EACX,WAA6B,EAC7B,UAAyC,EACzC,EAAE;QACF,IAAI,UAAU,EAAE;YACd,oBAAoB,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAChD,OAAO,UAAU,CAAC;SACnB;QACD,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC,CAAC;AAfW,QAAA,QAAQ,YAenB;AASK,MAAM,YAAY,GAAG,CAC1B,OAAgC,EAAE,OAAO,EAAE,IAAI,EAAE,EACf,EAAE;IACpC,OAAO,CACL,MAAW,EACX,WAA6B,EAC7B,UAAyC,EACzC,EAAE;QACF,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,IAAI,UAAU,EAAE;gBACd,OAAO,CAAC,cAAc,CAAC,oCAAc,GAAG,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC1E,OAAO,UAAU,CAAC;aACnB;YACD,OAAO,CAAC,cAAc,CAAC,oCAAc,GAAG,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;YAChE,OAAO,MAAM,CAAC;SACf;IACH,CAAC,CAAC;AACJ,CAAC,CAAC;AAjBW,QAAA,YAAY,gBAiBvB;AAOK,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,IAAA,qCAAe,GAAE,CAAC,CAAC;AAAzD,QAAA,sBAAsB,0BAAmC;AAO/D,MAAM,sBAAsB,GAAG,GAAG,EAAE,CAAC,IAAA,eAAM,EAAC,IAAA,qCAAe,GAAE,CAAC,CAAC;AAAzD,QAAA,sBAAsB,0BAAmC"}

package/dist/throttler.guard.d.ts

@@ -1,21 +1,28 @@
 import { CanActivate, ExecutionContext } from '@nestjs/common';
 import { Reflector } from '@nestjs/core';
-import { ThrottlerModuleOptions } from './throttler-module-options.interface';
+import { ThrottlerModuleOptions, ThrottlerOptions } from './throttler-module-options.interface';
 import { ThrottlerStorage } from './throttler-storage.interface';
+import { ThrottlerLimitDetail } from './throttler.guard.interface';
 export declare class ThrottlerGuard implements CanActivate {
     protected readonly options: ThrottlerModuleOptions;
     protected readonly storageService: ThrottlerStorage;
     protected readonly reflector: Reflector;
     protected headerPrefix: string;
     protected errorMessage: string;
+    protected throttlers: Array<ThrottlerOptions>;
+    protected commonOptions: Pick<ThrottlerOptions, 'skipIf' | 'ignoreUserAgents'>;
     constructor(options: ThrottlerModuleOptions, storageService: ThrottlerStorage, reflector: Reflector);
+    onModuleInit(): Promise<void>;
     canActivate(context: ExecutionContext): Promise<boolean>;
-    protected handleRequest(context: ExecutionContext, limit: number, ttl: number): Promise<boolean>;
-    protected getTracker(req: Record<string, any>): string;
+    protected shouldSkip(_context: ExecutionContext): Promise<boolean>;
+    protected handleRequest(context: ExecutionContext, limit: number, ttl: number, throttler: ThrottlerOptions): Promise<boolean>;
+    protected getTracker(req: Record<string, any>): Promise<string>;
     protected getRequestResponse(context: ExecutionContext): {
         req: Record<string, any>;
         res: Record<string, any>;
     };
-    protected generateKey(context: ExecutionContext, suffix: string): string;
-    protected throwThrottlingException(context: ExecutionContext): void;
+    protected generateKey(context: ExecutionContext, suffix: string, name: string): string;
+    protected throwThrottlingException(context: ExecutionContext, throttlerLimitDetail: ThrottlerLimitDetail): Promise<void>;
+    protected getErrorMessage(_context: ExecutionContext, _throttlerLimitDetail: ThrottlerLimitDetail): Promise<string>;
+    private resolveValue;
 }

package/dist/throttler.guard.interface.d.ts

@@ -0,0 +1,7 @@
+import { ThrottlerStorageRecord } from './throttler-storage-record.interface';
+export interface ThrottlerLimitDetail extends ThrottlerStorageRecord {
+    ttl: number;
+    limit: number;
+    key: string;
+    tracker: string;
+}

package/dist/throttler.guard.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=throttler.guard.interface.js.map

package/dist/throttler.guard.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"throttler.guard.interface.js","sourceRoot":"","sources":["../src/throttler.guard.interface.ts"],"names":[],"mappings":""}