Add IteratorStream docs

amphp · May 22, 2017 · bf2565b · bf2565b
1 parent adac8fe
commit bf2565b
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/docs/iterator-stream.md b/docs/iterator-stream.md
@@ -1,3 +1,16 @@
 # IteratorStream
 
-TBD
+`IteratorStream` allows converting an `Amp\Iterator` that yields strings into an `InputStream`.
+
+```php
+$emitter = new Emitter;
+
+asyncCoroutine(function () use ($emitter) {
+    for ($i = 0; $i < 10; $i++) {
+        yield new Delayed(1000);
+        yield $emitter->emit(".");
+    }
+});
+
+$inputStream = new IteratorStream($emitter->iterate());
+```