axios-rate-limit 1.1.2 → 1.3.0

package/CHANGELOG.md

@@ -1,7 +1,22 @@
 # Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-### 1.1.2
+## 1.3.0
+* Add TypeScript typings (see https://github.com/aishek/axios-rate-limit/pull/23)
+* Upgrade handlebars to 4.5.3
+* Upgrade acorn to 5.7.4
+* Upgrade lodash to 4.17.19
+
+## 1.2.1
+* Fix TypeScript imports (see https://github.com/aishek/axios-rate-limit/pull/19/files)
+
+## 1.2.0
+* Add maxRPS options, getMaxRPS, setMaxRPS, setRateLimitOptions methods
+
+## 1.1.3
+* Fixed ref/unref timeout behaviour for NodeJS (see https://github.com/aishek/axios-rate-limit/issues/16)
+
+## 1.1.2
 * Fixed NodeJS delayed shutdown (see https://github.com/aishek/axios-rate-limit/pull/13/files)
 
 ## 1.1.1

package/README.md

@@ -19,12 +19,20 @@ import axios from 'axios';
 import rateLimit from 'axios-rate-limit';
 
 // sets max 2 requests per 1 second, other will be delayed
-const http = rateLimit(axios.create(), { maxRequests: 2, perMilliseconds: 1000 });
+// note maxRPS is a shorthand for perMilliseconds: 1000, and it takes precedence
+// if specified both with maxRequests and perMilliseconds
+const http = rateLimit(axios.create(), { maxRequests: 2, perMilliseconds: 1000, maxRPS: 2 })
+http.getMaxRPS() // 2
 http.get('https://example.com/api/v1/users.json?page=1') // will perform immediately
 http.get('https://example.com/api/v1/users.json?page=2') // will perform immediately
 http.get('https://example.com/api/v1/users.json?page=3') // will perform after 1 second from the first one
+
+// options hot-reloading also available
+http.setMaxRPS(3)
+http.getMaxRPS() // 3
+http.setRateLimitOptions({ maxRequests: 6, perMilliseconds: 150 }) // same options as constructor
 ```
 
 ## A bit of advertising :-)
 
-Since 2010 lead my own software development company [Cifronomika](http://cifronomika.com/). We doing Ruby on Rails and JavaScript development. Feel free to contact
+Since 2010 run my own software development company [Cifronomika](http://cifronomika.com/). We doing Ruby on Rails and JavaScript development. Feel free to contact

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "axios-rate-limit",
   "description": "Rate limit for axios.",
-  "version": "1.1.2",
+  "version": "1.3.0",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/aishek/axios-rate-limit/issues"
@@ -103,7 +103,13 @@
       "com",
       "NodeJS",
       "TypeScript",
-      "Unreleased"
+      "Unreleased",
+      "unref",
+      "maxRPS",
+      "setMaxRPS",
+      "getMaxRPS",
+      "setRateLimitOptions",
+      "lodash"
     ]
   }
 }

package/src/index.js

@@ -1,7 +1,4 @@
-function AxiosRateLimit (options) {
-  this.maxRequests = options.maxRequests
-  this.perMilliseconds = options.perMilliseconds
-
+function AxiosRateLimit (axios) {
   this.queue = []
   this.timeslotRequests = 0
 
@@ -13,7 +10,28 @@ function AxiosRateLimit (options) {
   this.handleRequest = this.handleRequest.bind(this)
   this.handleResponse = this.handleResponse.bind(this)
 
-  this.enable(options.axios)
+  this.enable(axios)
+}
+
+AxiosRateLimit.prototype.getMaxRPS = function () {
+  var perSeconds = (this.perMilliseconds / 1000)
+  return this.maxRequests / perSeconds
+}
+
+AxiosRateLimit.prototype.setMaxRPS = function (rps) {
+  this.setRateLimitOptions({
+    maxRequests: rps,
+    perMilliseconds: 1000
+  })
+}
+
+AxiosRateLimit.prototype.setRateLimitOptions = function (options) {
+  if (options.maxRPS) {
+    this.setMaxRPS(options.maxRPS)
+  } else {
+    this.perMilliseconds = options.perMilliseconds
+    this.maxRequests = options.maxRequests
+  }
 }
 
 AxiosRateLimit.prototype.enable = function (axios) {
@@ -53,19 +71,28 @@ AxiosRateLimit.prototype.shiftInitial = function () {
 
 AxiosRateLimit.prototype.shift = function () {
   if (!this.queue.length) return
-  if (this.timeslotRequests === this.maxRequests) return
+  if (this.timeslotRequests === this.maxRequests) {
+    if (this.timeoutId && typeof this.timeoutId.ref === 'function') {
+      this.timeoutId.ref()
+    }
+
+    return
+  }
 
   var queued = this.queue.shift()
   queued.resolve()
 
   if (this.timeslotRequests === 0) {
-    var timeoutId = setTimeout(function () {
+    this.timeoutId = setTimeout(function () {
       this.timeslotRequests = 0
       this.shift()
     }.bind(this), this.perMilliseconds)
 
-    if (typeof timeoutId.unref === 'function') timeoutId.unref()
+    if (typeof this.timeoutId.unref === 'function') {
+      if (this.queue.length === 0) this.timeoutId.unref()
+    }
   }
+
   this.timeslotRequests += 1
 }
 
@@ -77,23 +104,31 @@ AxiosRateLimit.prototype.shift = function () {
  *   import rateLimit from 'axios-rate-limit';
  *
  *   // sets max 2 requests per 1 second, other will be delayed
- *   const http = rateLimit(axios.create(), { maxRequests: 2, perMilliseconds: 1000 });
+ *   // note maxRPS is a shorthand for perMilliseconds: 1000, and it takes precedence
+ *   // if specified both with maxRequests and perMilliseconds
+ *   const http = rateLimit(axios.create(), { maxRequests: 2, perMilliseconds: 1000, maxRPS: 2 })
+*    http.getMaxRPS() // 2
  *   http.get('https://example.com/api/v1/users.json?page=1') // will perform immediately
  *   http.get('https://example.com/api/v1/users.json?page=2') // will perform immediately
  *   http.get('https://example.com/api/v1/users.json?page=3') // will perform after 1 second from the first one
+ *   http.setMaxRPS(3)
+ *   http.getMaxRPS() // 3
+ *   http.setRateLimitOptions({ maxRequests: 6, perMilliseconds: 150 }) // same options as constructor
  *
  * @param {Object} axios axios instance
- * @param {Object} options options for rate limit.
+ * @param {Object} options options for rate limit, available for live update
  * @param {Number} options.maxRequests max requests to perform concurrently in given amount of time.
  * @param {Number} options.perMilliseconds amount of time to limit concurrent requests.
  * @returns {Object} axios instance with interceptors added
  */
 function axiosRateLimit (axios, options) {
-  new AxiosRateLimit({
-    maxRequests: options.maxRequests,
-    perMilliseconds: options.perMilliseconds,
-    axios: axios
-  })
+  var rateLimitInstance = new AxiosRateLimit(axios)
+  rateLimitInstance.setRateLimitOptions(options)
+
+  axios.getMaxRPS = AxiosRateLimit.prototype.getMaxRPS.bind(rateLimitInstance)
+  axios.setMaxRPS = AxiosRateLimit.prototype.setMaxRPS.bind(rateLimitInstance)
+  axios.setRateLimitOptions = AxiosRateLimit.prototype.setRateLimitOptions
+    .bind(rateLimitInstance)
 
   return axios
 }

package/typings/index.d.ts

@@ -1,10 +1,45 @@
 import { AxiosInstance } from 'axios';
 
-interface RateLimitedAxiosInstance extends AxiosInstance {}
+export interface RateLimitedAxiosInstance extends AxiosInstance {
+   getMaxRPS(): number,
+   setMaxRPS(rps:number): void,
+   setRateLimitOptions(options: rateLimitOptions): void,
+   // enable(axios: any): void,
+   // handleRequest(request:any):any,
+   // handleResponse(response: any): any,
+   // push(requestHandler:any):any,
+   // shiftInitial():any,
+   // shift():any
+}
 
-declare function axiosRateLimit(
+type rateLimitOptions = { maxRequests?: number, perMilliseconds?: number, maxRPS?:number };
+
+ /**
+  * Apply rate limit to axios instance.
+  *
+  * @example
+  *   import axios from 'axios';
+  *   import rateLimit from 'axios-rate-limit';
+  *
+  *   // sets max 2 requests per 1 second, other will be delayed
+  *   // note maxRPS is a shorthand for perMilliseconds: 1000, and it takes precedence
+  *   // if specified both with maxRequests and perMilliseconds
+  *   const http = rateLimit(axios.create(), { maxRequests: 2, perMilliseconds: 1000, maxRPS: 2 })
+ *    http.getMaxRPS() // 2
+  *   http.get('https://example.com/api/v1/users.json?page=1') // will perform immediately
+  *   http.get('https://example.com/api/v1/users.json?page=2') // will perform immediately
+  *   http.get('https://example.com/api/v1/users.json?page=3') // will perform after 1 second from the first one
+  *   http.setMaxRPS(3)
+  *   http.getMaxRPS() // 3
+  *   http.setRateLimitOptions({ maxRequests: 6, perMilliseconds: 150 }) // same options as constructor
+  *
+  * @param {Object} axios axios instance
+  * @param {Object} options options for rate limit, available for live update
+  * @param {Number} options.maxRequests max requests to perform concurrently in given amount of time.
+  * @param {Number} options.perMilliseconds amount of time to limit concurrent requests.
+  * @returns {Object} axios instance with interceptors added
+  */
+export default function axiosRateLimit(
     axiosInstance: AxiosInstance,
-    options: { maxRequests: number, perMilliseconds: number },
+    options: rateLimitOptions
 ): RateLimitedAxiosInstance;
-
-export default axiosRateLimit;