diff options
| author | Victor Widell <victor@topmost.se> | 2014-03-30 12:34:45 +0200 |
|---|---|---|
| committer | Chris Dickinson <christopher.s.dickinson@gmail.com> | 2014-10-06 19:24:29 -0500 |
| commit | 8392e8cdfb71e8cc03e110f7b30ed104b3b136bd (patch) | |
| tree | 7c6c2c1c2715ca3df367739588b5249137fdfb8b /doc | |
| parent | 87ce067636a6ea52cd978c68f9e837d5d115b4f0 (diff) | |
| download | node-new-8392e8cdfb71e8cc03e110f7b30ed104b3b136bd.tar.gz | |
doc: improve readLine.pause()
The docs for readLine.pause are misleading. I seriously spent hours on this. If
it isn't a bug, at least it should be well documented.
Someone else stumbled on this too:
http://stackoverflow.com/questions/21341050/pausing-readline-in-node-js
Reviewed-by: Trevor Norris <trev.norris@gmail.com>
Reviewed-by: Chris Dickinson <christopher.s.dickinson@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/readline.markdown | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/api/readline.markdown b/doc/api/readline.markdown index 6aab28679b..055bc39bdf 100644 --- a/doc/api/readline.markdown +++ b/doc/api/readline.markdown @@ -125,6 +125,8 @@ Example usage: Pauses the readline `input` stream, allowing it to be resumed later if needed. +Note that this doesn't immediately pause the stream of events. Several events may be emitted after calling `pause`, including `line`. + ### rl.resume() Resumes the readline `input` stream. |