Skip to content

feat: Implement retry limit configuration #1178

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.

Sign up for GitHub

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

Open
FoxxMD wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −2
Open

feat: Implement retry limit configuration #1178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,11 @@ const config = {

// Optional: Set max number of request with X seconds
// (default: 15 requests every 18 seconds)
rateLimit: [15, 18]
rateLimit: [15, 18],

// Optional: Set number of request retries for GET requests
// Default 10
retryLimit: 10
};

const mbApi = new MusicBrainzApi(config);
Expand Down
8 changes: 7 additions & 1 deletion lib/musicbrainz-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,12 @@ export interface IMusicBrainzConfig {
* Default is [15, 18], which allows up to 15 requests every 18 seconds
*/
rateLimit?: [number, number]
/**
* Number of times to retry a GET request
*
* Default is 10
*/
retryLimit?: number
}

interface IInternalConfig extends IMusicBrainzConfig {
Expand Down Expand Up @@ -264,7 +270,7 @@ export class MusicBrainzApi {

const response = await this.httpClient.get(`/ws/2${relUrl}`, {
query,
retryLimit: 10
retryLimit: this.config.retryLimit ?? 10
});

if(response.status === 400) {
Expand Down
Loading