axios-rate-limit
TypeScript icon, indicating that this package has built-in type declarations

1.3.2 • Public • Published

axios-rate-limit

npm version npm downloads npm bundle size build status code coverage install size known vulnerabilities

A rate limit for Axios: set how many requests per interval should perform immediately, other will be delayed automatically.

Installing

npm install axios-rate-limit

Usage

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

// options hot-reloading also available
http.setMaxRPS(3)
http.getMaxRPS() // 3
http.setRateLimitOptions({ maxRequests: 6, perMilliseconds: 150 }) // same options as constructor

Alternatives

Consider using Axios built-in rate-limiting functionality.

Readme

Keywords

Package Sidebar

Install

npm i axios-rate-limit

Weekly Downloads

61,227

Version

1.3.2

License

MIT

Unpacked Size

12.2 kB

Total Files

5

Last publish

Collaborators

  • aishek