UNPKG

prom-utils

Version:

Promise utilities: rate limiting, queueing/batching, defer, etc.

github.com/smartprocure/prom-utils

smartprocure/prom-utils

111 lines (67 loc) • 3.04 kB
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# 0.20.0 - `rateLimit` accepts multiple `RateLimiter` objects. - A new `RateLimiter` interface has been created in place of `RateLimitOptions`. The `maxItemsPerPeriod` field is now required. - The `getStats` method now returns an array of stats objects. # 0.19.0 - BREAKING: `waitUntil` now returns the truthy value from the predicate instead of `void`. The function resolves with the result of the predicate when it becomes truthy. # 0.18.0 - Added `multiplex` - Merges multiple async iterators into a single async iterator that yields values as they become available. # 0.17.0 - Added `batchQueueParallel` - A concurrent-safe version of `batchQueue` that supports `batchSize` and `batchBytes` options but not timeout or throughput limiting. # 0.16.0 - Dependencies updated. # 0.15.0 - `rateLimit` - Added `maxItemsPerPeriod` option along with the options from `throughputLimiter`. - Added `bypass` option to `add`. - `throughputLimiter` - Added `minWindowLength`, `period`, `expireAfter`, and `getTimeframe` options. - The `windowLength` option is now `maxWindowLength`. - Separated `throttle` and `append`. These two convenience methods were also created: `throttleAndAppend` and `appendAndThrottle`. # 0.14.0 - `batchQueue` - Added `lastFlush`. # 0.13.0 - Added debug statements for `pausable`. - Bumped dependencies. # 0.12.1 - Fixed type for `raceTimeout`. # 0.12.0 - Added `raceTimeout`. # 0.11.0 - Fixed: `rateLimit` should remove an item if it has rejected. - `rateLimit` - `.finish` swallows exceptions. - `rateLimit` - Added `length` getter. - `batchQueue` - Added `length` getter. - BREAKING: `pausable.proceed` changed to `pausable.maybeBlock`. # 0.10.0 - Added `throughputLimiter` - Limit throughput (items/sec). - Added `sleep` - Sleep for `time` ms before resolving the Promise. - `batchQueue` - Added `maxItemsPerSec` and `maxBytesPerSec` options for throughput throttling. - Changed testing library from jest to vitest. - Bumped packages. # 0.9.0 - Better types - removed all use of `any`. - `rateLimit` - Changed the return type of the `finish` method to `Promise<void>`. # 0.8.0 - Added `waitUntil` - Wait until the predicate returns truthy or the timeout expires. - Changed function signature to use generics for `batchQueue`. # 0.7.0 - Changed dependency for determining size in bytes of a value for `batchQueue`. # 0.6.1 - `rateLimit` - Catch promise exceptions which will be re-thrown in `.add` or `.finish`. # 0.6.0 - Added `pacemaker`. # 0.5.0 - Changed debug code to be more logical. # 0.4.0 - Added `batchBytes` option to `batchQueue` which triggers a queue flush if the total size of the queue is greater than or equal to `batchBytes`. # 0.3.0 - `defer` - `pausable` # 0.2.0 - `batchQueue` now accepts an option object which includes `batchSize` and `timeout`. - A timer will be set if the `timeout` option is passed when the first item is enqueued. If the timeout occurs before `batchSize` is reached, `flush` is called. # 0.1.0 - Initial release.