feat(rstream): add trigger() utility stream

thi-ng · Sep 19, 2018 · 929c6f4 · 929c6f4
1 parent e82e312
commit 929c6f4
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/packages/rstream/src/index.ts b/packages/rstream/src/index.ts
@@ -4,6 +4,7 @@ export * from "./stream";
 export * from "./stream-merge";
 export * from "./stream-sync";
 export * from "./subscription";
+export * from "./trigger";
 
 export * from "./from/atom";
 export * from "./from/event";

diff --git a/packages/rstream/src/trigger.ts b/packages/rstream/src/trigger.ts
@@ -0,0 +1,10 @@
+import { fromIterable } from "./from/iterable";
+import { Stream } from "./stream";
+
+/**
+ * Utility stream. Returns a new stream which emits a single `true`
+ * value and then closes.
+ */
+export function trigger(): Stream<boolean> {
+    return fromIterable([true]);
+}