Skip to content

Commit

Permalink
fix: constructor comment
Browse files Browse the repository at this point in the history
  • Loading branch information
OscarMulder committed Aug 26, 2022
1 parent 48cb685 commit 77dd0ec
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ class api42 {
*
* @param {ApiSecret[]} secrets Array of ApiSecret objects containing the client_id and client_secret
* make sure all keys have the same rate limit. Since the keys are rotated after every call, they are used equally.
* @param {number} concurrentOffset Offset from the maximum concurrent requests per second, to make sure the rate limit is not exceeded.
* The default value is 0, which means that the maximum concurrent requests per second is used (but you might get more retries).
* Recommended value is 1 if your key can do more than 2 req per second.
*/
constructor(secrets: ApiSecret[], concurrentOffset: number = 0) {
if (secrets.length === 0) {
Expand Down

0 comments on commit 77dd0ec

Please sign in to comment.