axios-rate-limit 1.3.1 → 1.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/typings/index.d.ts +9 -5
package/package.json
CHANGED
package/typings/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
2
2
|
|
|
3
3
|
export interface RateLimitedAxiosInstance extends AxiosInstance {
|
|
4
|
-
getMaxRPS()
|
|
5
|
-
setMaxRPS(rps:number)
|
|
6
|
-
setRateLimitOptions(options: rateLimitOptions)
|
|
4
|
+
getMaxRPS: () => number,
|
|
5
|
+
setMaxRPS: (rps: number) => void,
|
|
6
|
+
setRateLimitOptions: (options: rateLimitOptions) => void,
|
|
7
7
|
// enable(axios: any): void,
|
|
8
8
|
// handleRequest(request:any):any,
|
|
9
9
|
// handleResponse(response: any): any,
|
|
@@ -12,7 +12,11 @@ export interface RateLimitedAxiosInstance extends AxiosInstance {
|
|
|
12
12
|
// shift():any
|
|
13
13
|
}
|
|
14
14
|
|
|
15
|
-
type rateLimitOptions = {
|
|
15
|
+
export type rateLimitOptions = {
|
|
16
|
+
maxRequests?: number,
|
|
17
|
+
perMilliseconds?: number,
|
|
18
|
+
maxRPS?: number
|
|
19
|
+
};
|
|
16
20
|
|
|
17
21
|
/**
|
|
18
22
|
* Apply rate limit to axios instance.
|
|
@@ -33,7 +37,7 @@ type rateLimitOptions = { maxRequests?: number, perMilliseconds?: number, maxRPS
|
|
|
33
37
|
* http.getMaxRPS() // 3
|
|
34
38
|
* http.setRateLimitOptions({ maxRequests: 6, perMilliseconds: 150 }) // same options as constructor
|
|
35
39
|
*
|
|
36
|
-
* @param {Object}
|
|
40
|
+
* @param {Object} axiosInstance axios instance
|
|
37
41
|
* @param {Object} options options for rate limit, available for live update
|
|
38
42
|
* @param {Number} options.maxRequests max requests to perform concurrently in given amount of time.
|
|
39
43
|
* @param {Number} options.perMilliseconds amount of time to limit concurrent requests.
|