![](\"https://user-images.githubusercontent.com/39852038/91653275-d14ace00-eaa7-11ea-9654-492cca9506d5.png\")
\n\n \n
\n\n
![\"NPM](\"https://img.shields.io/npm/v/nestjs-rate-limiter.svg?sanitize=true\")
\n![\"NPM](\"https://img.shields.io/npm/dm/nestjs-rate-limiter.svg?sanitize=true\")
\n![\"License\"/](\"https://img.shields.io/npm/l/nestjs-rate-limiter.svg?colorB=black&label=LICENSE&sanitize=true\")
\n![\"Test\"/](\"https://github.com/ozkanonur/nestjs-rate-limiter/actions/workflows/test.yml/badge.svg?branch=master\"){kind=icon}
\n\n
[options](https://github.com/ozkanonur/nestjs-rate-limiter#options).\n\n```ts\n@Module({\n imports: [\n // All the values here are defaults.\n RateLimiterModule.register({\n for: 'Express',\n type: 'Memory',\n keyPrefix: 'global',\n points: 4,\n pointsConsumed: 1,\n inmemoryBlockOnConsumed: 0,\n duration: 1,\n blockDuration: 0,\n inmemoryBlockDuration: 0,\n queueEnabled: false,\n whiteList: [],\n blackList: [],\n storeClient: undefined,\n insuranceLimiter: undefined,\n storeType: undefined,\n dbName: undefined,\n tableName: undefined,\n tableCreated: undefined,\n clearExpiredByTimeout: undefined,\n execEvenly: false,\n execEvenlyMinDelayMs: undefined,\n indexKeyPrefix: {},\n maxQueueSize: 100,\n omitResponseHeaders: false,\n errorMessage: 'Rate limit exceeded',\n logger: true,\n customResponseSchema: undefined\n }),\n ],\n providers: [\n {\n provide: APP_GUARD,\n useClass: RateLimiterGuard,\n },\n ],\n})\nexport class ApplicationModule {}\n```\n\n### Fastify based Graphql\nIf you want to use this library on a fastify based graphql server, you need to override the graphql context in the app.module as shown below.\n```ts\nGraphQLModule.forRoot({\n context: ({ request, reply }) => {\n return { req: request, res: reply }\n },\n}),\n```\n\n# Options\n\n#### ● for\n Default: 'Express'\n Type: 'Express' | 'Fastify' | 'Microservice' | 'ExpressGraphql' | 'FastifyGraphql'\n Default: 'Memory'\n Type: 'Memory' | 'Redis' | 'Memcache' | 'Postgres' | 'MySQL' | 'Mongo'\n Default: 'global'\n Type: string\n Default: 4\n Type: number\n Default: 1\n Type: number\n Default: 0\n Type: number\n Default: 1\n Type: number\n Default: 0\n Type: number\n Default: 0\n Type: number\n Default: false\n Type: boolean\n duration value.\n\n#### ● whiteList\n Default: []\n Type: string[]\n Default: []\n Type: string[]\n Default: undefined\n Type: any\n Default: undefined\n Type: any\n Default: storeClient.constructor.name\n Type: any\n Default for MySQL, Postgres & Mongo: 'rate-limiter'\n Type: string\n Default: equals to 'keyPrefix' option\n Type: string\n Default: false\n Type: boolean\n true.\n\n#### ● clearExpiredByTimeout\n Default for MySQL and PostgreSQL: true\n Type: boolean\n Default: false\n Type: boolean\n Default: duration * 1000 / points\n Type: number\n Default: {}\n Type: {}\n Default: 100\n Type: number\n 429 as response to requests that over of the maxQueueSize.\n\n#### ● omitResponseHeaders\n Default: false\n Type: boolean\n X-Retry-After, X-RateLimit-Limit, X-Retry-Remaining, X-Retry-Reset) should be omitted in the response.\n\n\n#### ● errorMessage\n Default: 'Rate limit exceeded'\n Type: string\n Default: true\n Type: boolean\n Default: undefined \n Type: string\n getIpFromRequest function by extending RateLimiterGuard class.\n\n```ts\nimport { RateLimiterGuard } from 'nestjs-rate-limiter'\nimport type { Request } from 'express'\n\nclass ExampleRateLimiterGuard extends RateLimiterGuard {\n protected getIpFromRequest(request: Request): string {\n return request.get('x-forwarded-for');\n }\n}\n```\n\n# Benchmarks\n\n1000 concurrent clients with maximum 2000 requests per sec during 30 seconds.\n\n```\n1. Memory 0.34 ms\n2. Redis 2.45 ms\n3. Memcached 3.89 ms\n4. Mongo 4.75 ms\n```\n\n500 concurrent clients with maximum 1000 req per sec during 30 seconds\n\n```\n5. PostgreSQL 7.48 ms (with connection pool max 100)\n6. MySQL 14.59 ms (with connection pool 100)\n```\n\n## TODO\n- [ ] Support Websocket\n- [ ] Support Rpc\n","readmeFilename":"README.md","contributors":[{"name":"Onur Ozkan","email":"onurozkan.dev@outlook.com"},{"name":"Ryan Dowling","email":"ryan@ryandowling.me"}]}