Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tflanagan/generic-throttle
A lightweight, flexible promise based throttle class perfect for any rate or concurrency limiting need
https://github.com/tflanagan/generic-throttle
concurrency-limit javascript nodejs pool promise rate-limit throttle
Last synced: about 2 months ago
JSON representation
A lightweight, flexible promise based throttle class perfect for any rate or concurrency limiting need
- Host: GitHub
- URL: https://github.com/tflanagan/generic-throttle
- Owner: tflanagan
- License: other
- Created: 2017-02-03T00:53:02.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-18T04:30:56.000Z (over 1 year ago)
- Last Synced: 2024-11-11T21:47:57.709Z (about 2 months ago)
- Topics: concurrency-limit, javascript, nodejs, pool, promise, rate-limit, throttle
- Language: TypeScript
- Size: 1.3 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
generic-throttle
==============
[](https://www.npmjs.com/package/generic-throttle) [](https://www.npmjs.com/package/generic-throttle) [](https://www.npmjs.com/package/generic-throttle)
A lightweight, flexible promise based throttle class perfect for any rate or concurrency limiting need.
Written in TypeScript, targets Nodejs and the Browser
Install
-------
```
# Latest Stable Release
$ npm install generic-throttle
# Latest Commit
$ npm install tflanagan/generic-throttle
# Also available via Bower
$ bower install generic-throttle
```
Documentation
-------------
[TypeDoc Documentation](https://tflanagan.github.io/generic-throttle/)
Rate Limit Example
------------------
This Throttle instance will rate limit the throttle to a maximum of 10 requests
every 30 seconds. It will not throw an error if the maximum is exceeded.
```javascript
'use strict';
const { Throttle } = require('generic-throttle');
const throttle = new Throttle(10, 30000, false);
function delay(){
return new Promise((resolve) => {
setTimeout(() => {
resolve();
}, 2000);
});
}
function asyncRequest(i){
return throttle.acquire(() => {
console.log('%d does some async request', i);
return delay();
}).then(function(){
console.log('%d finished', i);
});
}
for(let i = 0; i < 30; ++i){
asyncRequest(i);
}
```
Concurrency Limit Example
-------------------------
This Throttle instance will limit concurrency to 5 requests at any given
moment. It will not throw an error if the maximum is exceeded.
```javascript
'use strict';
const { Throttle } = require('generic-throttle');
const throttle = new Throttle(5);
function delay(){
return new Promise((resolve) => {
setTimeout(() => {
resolve();
}, 2000);
});
}
function asyncRequest(i){
return throttle.acquire(() => {
console.log('%d does some async request', i);
return delay();
}).then(function(){
console.log('%d finished', i);
});
}
for(let i = 0; i < 30; ++i){
asyncRequest(i);
}
```
License
-------
Copyright 2014 Tristian Flanagan
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.