axios-rate-limit 1.3.2 → 1.4.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "axios-rate-limit",
   "description": "Rate limit for axios.",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/aishek/axios-rate-limit/issues"
@@ -11,9 +11,13 @@
     "url": "https://github.com/aishek/axios-rate-limit.git"
   },
   "homepage": "https://github.com/aishek/axios-rate-limit#readme",
+  "dependencies": {
+    "axios": ">=0.18.0"
+  },
   "devDependencies": {
+    "axios0": "npm:axios@^0.28.1",
+    "axios1": "npm:axios@^1.0.0",
     "@logux/eslint-config": "28.1.0",
-    "axios": "^0.18.0",
     "eslint": "^5.16.0",
     "eslint-ci": "^1.0.0",
     "eslint-config-standard": "^12.0.0",

package/src/index.js

@@ -18,6 +18,10 @@ AxiosRateLimit.prototype.getMaxRPS = function () {
   return this.maxRequests / perSeconds
 }
 
+AxiosRateLimit.prototype.getQueue = function () {
+  return this.queue
+}
+
 AxiosRateLimit.prototype.setMaxRPS = function (rps) {
   this.setRateLimitOptions({
     maxRequests: rps,
@@ -155,6 +159,7 @@ function axiosRateLimit (axios, options) {
   var rateLimitInstance = new AxiosRateLimit(axios)
   rateLimitInstance.setRateLimitOptions(options)
 
+  axios.getQueue = AxiosRateLimit.prototype.getQueue.bind(rateLimitInstance)
   axios.getMaxRPS = AxiosRateLimit.prototype.getMaxRPS.bind(rateLimitInstance)
   axios.setMaxRPS = AxiosRateLimit.prototype.setMaxRPS.bind(rateLimitInstance)
   axios.setRateLimitOptions = AxiosRateLimit.prototype.setRateLimitOptions

package/typings/index.d.ts

@@ -1,15 +1,20 @@
 import { AxiosInstance } from 'axios';
 
+export type RateLimitRequestHandler = {
+  resolve: () => boolean
+}
+
 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
+    getQueue: () => RateLimitRequestHandler[],
+    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
 }
 
 export type rateLimitOptions = {