-
Notifications
You must be signed in to change notification settings - Fork 0
/
Limiter.js
92 lines (85 loc) · 2.11 KB
/
Limiter.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/**
* Rate limiter class
*/
class Limit {
/**
* Sets the current points as well as the maximum points
* @param {*} points the points to use
* @param {*} timeout timeout in ms for points to be added back
*/
constructor(points, timeout) {
this.MAX_POINTS = points;
this.points = points;
this.TIMEOUT = timeout;
}
/**
* Resets point count to the maximum
*/
resetPoints() {
this.points = this.MAX_POINTS;
}
/**
* Gets the remaining points
*/
getPoints() {
return this.points;
}
/**
* Gets the maximum points
*/
getMaxPoints() {
return this.MAX_POINTS;
}
/**
* Sets the remaining points
* @param {*} points the points to use
*/
setPoints(points) {
this.points = points;
}
/**
* Sets the maximum points
* @param {*} maxPoints the points to use
*/
setMaxPoints(maxPoints) {
this.MAX_POINTS = maxPoints;
}
/**
* Tries to remove points from the Limit.
* If no points are available, waits until
* points are available before resolving.
* @param {*} num number of points to remove
*/
removePoints(num) {
let self = this;
// Promise that resolves when num points can be removed
return new Promise((resolve) => {
// Repeats checking until there are enough points
(function wait() {
if(self.points - num >= 0) { // If there is room to remove the points
self.points -= num; // Remove the points
setTimeout(() => self.addPoints(num), self.TIMEOUT); // Add the points back timeout ms after
resolve();
} else {
setTimeout(wait, 1000); // Else try again after 1 second
}
})();
});
}
/**
* Adds points to the point count
* If number of points would add
* over max points, then set
* points equal to max points
* @param {*} num number of points to add
*/
addPoints(num) {
if(num + this.points > this.MAX_POINTS) {
this.points = this.MAX_POINTS;
} else {
this.points += num;
}
return this.points;
}
}
module.exports = Limit;