feat(rstream): add tweenNumber()

thi-ng · Apr 11, 2019 · 17d0fdb · 17d0fdb
1 parent b5da3b2
commit 17d0fdb
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/packages/rstream/src/tween.ts b/packages/rstream/src/tween.ts
@@ -78,3 +78,28 @@ export const tween = <T>(
         scan(reducer(() => initial, (acc, { src }) => mix(acc, src))),
         dedupe(stop || (() => false))
     );
+
+/**
+ * Convenience version of `tween` for its most common use case, tweening
+ * of numeric streams.
+ *
+ * @param src
+ * @param init
+ * @param speed
+ * @param eps
+ * @param clock
+ */
+export const tweenNumber = (
+    src: ISubscribable<number>,
+    init = 0,
+    speed = 0.05,
+    eps = 1e-3,
+    clock?: ISubscribable<any> | number
+) =>
+    tween<number>(
+        src,
+        init,
+        (a, b) => a + (b - a) * speed,
+        (a, b) => Math.abs(a - b) < eps,
+        clock
+    );