Add description + interfaces

2019-06-04 11:25:33 -04:00
parent eaeed0dde6
commit 5eeae17559
3 changed files with 147 additions and 18 deletions
--- a/src/functions/functions.ts
+++ b/src/functions/functions.ts
@@ -547,7 +547,8 @@ export function unbatch() {

 /**
 * Limits date of data transferred into stream.
- * @param rate Desired rate in ms
+ * @param targetRate Desired rate in ms
+ * @param period Period to sleep for when rate is above or equal to targetRate
 */
 export function rate(targetRate: number = 50, period: number = 2) {
    const deltaMS = ((1 / targetRate) * 1000) / period; // Skip half a period