This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

docs: clarify process.stdin and old mode

  • Loading branch information...
1 parent 1d734a7 commit 1fa5cff4f21782fb1ba499c38e690a13d70ba765 @subzey subzey committed with tjfontaine Jul 8, 2013
Showing with 17 additions and 5 deletions.
  1. +17 −5 doc/api/process.markdown
View
@@ -164,22 +164,34 @@ that writes to them are usually blocking.
## process.stdin
-A `Readable Stream` for stdin. The stdin stream is paused by default, so one
-must call `process.stdin.resume()` to read from it.
+A `Readable Stream` for stdin.
Example of opening standard input and listening for both events:
- process.stdin.resume();
process.stdin.setEncoding('utf8');
- process.stdin.on('data', function(chunk) {
- process.stdout.write('data: ' + chunk);
+ process.stdin.on('readable', function(chunk) {
+ var chunk = process.stdin.read();
+ if (chunk !== null) {
+ process.stdout.write('data: ' + chunk);
+ }
});
process.stdin.on('end', function() {
process.stdout.write('end');
});
+As a Stream, `process.stdin` can also be used in "old" mode that is compatible
+with scripts written for node prior v0.10.
+For more information see
+[Stream compatibility](stream.html#stream_compatibility_with_older_node_versions).
+
+In "old" Streams mode the stdin stream is paused by default, so one
+must call `process.stdin.resume()` to read from it. Note also that calling
+`process.stdin.resume()` itself would switch stream to "old" mode.
+
+If you are starting a new project you should prefer a more recent "new" Streams
+mode over "old" one.
## process.argv

0 comments on commit 1fa5cff

Please sign in to comment.