Browse Source

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>
v0.11.15-release
Victor Widell 11 years ago
committed by Chris Dickinson
parent
commit
8392e8cdfb
  1. 2
      doc/api/readline.markdown

2
doc/api/readline.markdown

@ -125,6 +125,8 @@ Example usage:
Pauses the readline `input` stream, allowing it to be resumed later if needed. 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() ### rl.resume()
Resumes the readline `input` stream. Resumes the readline `input` stream.

Loading…
Cancel
Save