Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add support for a timeout #18

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,23 @@ const profiles = await Promise.all(

const justMe = await throttle(() => fetch('https://api.github.com/search/users?q=shaunpersad'));
```
### Promises with timeout
Starting in version `2.1.5`, you can also add a timeout to the waiting. If the promise doesn't resolve before the timeout is reached, it will throw an Error("Cancelled due to timeout")
```javascript
const throttledQueue = require('throttled-queue');
// at most make 4 requests per minute, with timeout after 2 seconds
const throttle = throttledQueue(4, 60*1000, false, 2000);

for(let i=0; i<5; i++){
try {
const res = await throttle(() => fetch('https://api.github.com/search/users?q=shaunpersad'));
console.log("request",i,"success")
}
catch(error) {
console.log("request",i,"error:",error)
}
}
```

## Typescript support
The package is written in Typescript and includes types by default. The `throttle` function is a generic,
Expand Down
Loading