\n\n## Description\n\nThis is a [Nest](https://github.com/nestjs/nest) module for limit http calls per timespan.\n\nSometimes a server you want to access has a rate limit. In this case you have to limit your requests against this server.\n\nThis Module provides an easy-to-use service with the same API like the HttpService of [Nest.JS](https://github.com/nestjs)\n\n\n## Installation\n\n```bash\n$ npm i --save @codemonkeys-island/nest-http-queue\n```\n\n\n## Usage\nImport the HttpQueueModule in your app.module.ts (or feature module)\n```typescript\nimport { Module } from '@nestjs/common';\nimport { HttpQueueModule } from '@codemonkeys-island/nest-http-queue';\n\n@Module({\n imports: [\n HttpQueueModule.forRoot(),\n ]\n})\nexport class AppModule {\n}\n```\n\nInject the Queue Service and use it like the HttpService.\n```typescript\nimport { Injectable } from '@nestjs/common'; \nimport { HttpQueueService } from '@codemonkeys-island/nest-http-queue'; \nimport { Observable } from \"rxjs\"; \nimport { AxiosResponse } from \"axios\";\n\n@Injectable()\nexport class RequestService { \n constructor(private httpQueueService: HttpQueueService) {\n }\n \n /**\n * Queued Request\n **/\n requestExternalData(): Observable> {\n return this.httpQueueService.get('https://api.url.com');\n }\n\n}\n```\n\n### Supported http requests:\nGET, POST, PUT, PATCH, HEAD, REQUEST, DELETE\n\n```typescript\nthis.httpQueueService.get('https://api.url.com');\n\nthis.httpQueueService.post('https://api.url.com', {});\n\nthis.httpQueueService.put('https://api.url.com', {});\n\nthis.httpQueueService.patch('https://api.url.com', {});\n\nthis.httpQueueService.head('https://api.url.com');\n\nthis.httpQueueService.request({url: 'https://api.url.com'});\n```\n\n### Initialize Module with configuration\nDefault configruation for rate limit queue is 10 requests per 10000ms and a shared queue ist disabled.\n\nIf a project needs a shared queue (if the request resources are limited for example) please enable it via `sharedQueue: true`.\n\n```json5\n{\n default: {\n sharedQueue: false,\n maxRequests: 10,\n timespan: 10000,\n }\n}\n``` \n\nFor specific hosts you could define specific rules.\n```json5\n{\n rules: {\n \"api.test.com\": {\n maxRequests: 10,\n timespan: 10000,\n } \n },\n}\n``` \n\nTo inject a custom configuration just initialize the module with a configuration.\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { HttpQueueModule } from '@codemonkeys-island/nest-http-queue';\n\n@Module({\n imports: [\n HttpQueueModule.forRoot({\n default: {\n maxRequests: 5,\n timespan: 1000\n } \n }),\n ]\n})\nexport class AppModule {\n}\n```\n\n### Use Custom Rules\nBeside of host based queues or a shared queue there is one other queue: **custom rule**\n\n#### Define Custom Rule\n```json5\n{\n rules: {\n \"custom-rule\": {\n maxRequests: 100,\n timespan: 100,\n } \n },\n}\n``` \n#### Usage of Custom Rule\n```typescript\nreturn this.httpQueueService.get('https://api.url.com', {}, 'custom-rule');\n```\n\n## Stay in touch\n\n- Author - [mrbacony](https://github.com/mrbacony)\n\n## License\n\n- Nest Http Queue is [MIT licensed](LICENSE).","readmeFilename":"README.md"}
![\"Nest](\"https://nestjs.com/img/logo_text.svg\"){kind=logo}
\n![\"NPM](\"https://img.shields.io/npm/v/@codemonkeys-island/nest-http-queue\")
![\"Package](\"https://img.shields.io/npm/l/@codemonkeys-island/nest-http-queue\")
![\"NPM](\"https://img.shields.io/npm/dm/@codemonkeys-island/nest-http-queue\")