feat(rstream): add tween() stream operator

thi-ng · Mar 3, 2019 · c74a2d0 · c74a2d0
1 parent b2e6e6f
commit c74a2d0
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 6 deletions.
diff --git a/packages/rstream/src/api.ts b/packages/rstream/src/api.ts
@@ -59,4 +59,4 @@ export interface IStream<T> extends ISubscriber<T> {
 export type StreamCancel = () => void;
 export type StreamSource<T> = (sub: Stream<T>) => StreamCancel;
 
-export let DEBUG = true;
+export let DEBUG = false;
diff --git a/packages/rstream/src/index.ts b/packages/rstream/src/index.ts
@@ -6,6 +6,7 @@ export * from "./stream-merge";
 export * from "./stream-sync";
 export * from "./subscription";
 export * from "./trigger";
+export * from "./tween";
 
 export * from "./from/atom";
 export * from "./from/event";

diff --git a/packages/rstream/src/tween.ts b/packages/rstream/src/tween.ts
@@ -0,0 +1,66 @@
+import { Fn2 } from "@thi.ng/api";
+import { dedupe, reducer, scan } from "@thi.ng/transducers";
+import { CloseMode } from "./api";
+import { fromInterval } from "./from/interval";
+import { sync } from "./stream-sync";
+import { Subscription } from "./subscription";
+
+/**
+ * Takes an existing stream/subscription `src` and attaches new
+ * subscription which interpolates between incoming values from `src`
+ * using the given `mix` function. The returned subscription produces
+ * values at a fixed frequency, defined by `delay` (in ms, default
+ * 16ms). In general, that frequency should be higher than that of
+ * `src`.
+ *
+ * If `stop` is given as well, no values will be passed downstream if
+ * that function returns true. This can be used to limit traffic once
+ * the tween target value has been reached.
+ *
+ * ```
+ * val = stream();
+ *
+ * rs.tween(
+ *   // consume from `val` stream
+ *   val,
+ *   // initial start value to interpolate from
+ *   0,
+ *   // interpolation fn (LERP)
+ *   (a, b) => a + (b - a) * 0.5,
+ *   // stop emitting values if difference to previous result < 0.01
+ *   (a, b) => Math.abs(a - b) < 0.01
+ * ).subscribe(rs.trace("tweened"))
+ *
+ * a.next(10)
+ * // 5
+ * // 7.5
+ * // ...
+ * // 9.98046875
+ *
+ * a.next(100)
+ * // 55
+ * // 77.5
+ * // ...
+ * // 99.989013671875
+ * ```
+ *
+ * @param src
+ * @param initial
+ * @param mix
+ * @param stop
+ * @param delay
+ */
+export const tween = <T>(
+    src: Subscription<any, T>,
+    initial: T,
+    mix: Fn2<T, T, T>,
+    stop: Fn2<T, T, boolean>,
+    delay = 16
+) =>
+    sync({
+        src: { src, _: fromInterval(delay) },
+        close: CloseMode.FIRST
+    }).transform(
+        scan(reducer(() => initial, (acc, { src }) => mix(acc, src))),
+        dedupe(stop || (() => false))
+    );
diff --git a/packages/rstream/tsconfig.json b/packages/rstream/tsconfig.json
@@ -3,9 +3,8 @@
     "compilerOptions": {
         "outDir": ".",
         "module": "es6",
-        "target": "es6"
+        "target": "es6",
+        "preserveConstEnums": false
     },
-    "include": [
-        "./src/**/*.ts"
-    ]
-}
+    "include": ["./src/**/*.ts"]
+}