Skip to content

Commit

Permalink
readme: remove references to stderr for shell()
Browse files Browse the repository at this point in the history
  • Loading branch information
mscdex committed Jan 23, 2019
1 parent 706906a commit 3b3a7a7
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,7 @@ conn.on('ready', function() {
console.log('Stream :: close');
conn.end();
}).on('data', function(data) {
console.log('STDOUT: ' + data);
}).stderr.on('data', function(data) {
console.log('STDERR: ' + data);
console.log('OUTPUT: ' + data);
});
stream.end('ls -l\nexit\n');
});
Expand Down Expand Up @@ -982,12 +980,12 @@ This is a normal **streams2** Duplex Stream (used both by clients and servers),

* If there was an `exit` event, the `close` event will be passed the same arguments for convenience.

* A `stderr` property contains a Readable stream that represents output from stderr.

* For shell() and exec():

* The readable side represents stdout and the writable side represents stdin.

* A `stderr` property contains a Readable stream that represents output from stderr.

* **signal**(< _string_ >signalName) - _boolean_ - Sends a POSIX signal to the current process on the server. Valid signal names are: 'ABRT', 'ALRM', 'FPE', 'HUP', 'ILL', 'INT', 'KILL', 'PIPE', 'QUIT', 'SEGV', 'TERM', 'USR1', and 'USR2'. Some server implementations may ignore this request if they do not support signals. Note: If you are trying to send SIGINT and you find `signal()` doesn't work, try writing `'\x03'` to the Channel stream instead. Returns `false` if you should wait for the `continue` event before sending any more traffic.

* **setWindow**(< _integer_ >rows, < _integer_ >cols, < _integer_ >height, < _integer_ >width) - _boolean_ - Lets the server know that the local terminal window has been resized. The meaning of these arguments are described in the 'Pseudo-TTY settings' section. Returns `false` if you should wait for the `continue` event before sending any more traffic.
Expand Down

0 comments on commit 3b3a7a7

Please sign in to comment.