Skip to content

Commit d0d949c

Browse files
committed
README.md :: clearly state that the source array is not modified
1 parent 4ce4e56 commit d0d949c

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ The result of [require][13] is a 'function' that when invoked, will return a [Re
2727
var streamify = require('stream-array');
2828
```
2929

30-
The Array passed into stream-array() can contain any type, as it assumes the receiving stream can handle it. Each element will be dequeued and pushed into the following piped stream.
30+
The source array can contain any type as it is assumed that the receiving
31+
stream can handle it. Each element in the array will be [pushed][14] into the
32+
[piped][15] stream, **without** modifying the source array.
3133

3234
```
3335
var readable = streamify(['Hello', new Buffer('World')]);
@@ -62,6 +64,8 @@ npm install stream-array
6264
[11]: http://nodejs.org/api/stream.html#stream_class_stream_readable
6365
[12]: http://nodejs.org/api/stream.html#stream_stream
6466
[13]: http://nodejs.org/api/globals.html#globals_require
67+
[14]: https://nodejs.org/api/stream.html#stream_readable_push_chunk_encoding
68+
[15]: https://nodejs.org/api/stream.html#stream_readable_pipe_destination_options
6569

6670
## License
6771

0 commit comments

Comments
 (0)