summaryrefslogtreecommitdiff
path: root/doc/api/readline.md
diff options
context:
space:
mode:
authorJames M Snell <jasnell@gmail.com>2016-08-26 21:36:43 -0700
committerJames M Snell <jasnell@gmail.com>2016-08-29 15:29:59 -0700
commit61fa50d29888318cd416e61dee7e9719cd9f3b9a (patch)
treee0fa688b4eacd189ec69c3af4e69dbb1cae2482f /doc/api/readline.md
parent4537cf2377c9db383e9f8236a5e93c3b1b1fd008 (diff)
downloadandroid-node-v8-61fa50d29888318cd416e61dee7e9719cd9f3b9a.tar.gz
android-node-v8-61fa50d29888318cd416e61dee7e9719cd9f3b9a.tar.bz2
android-node-v8-61fa50d29888318cd416e61dee7e9719cd9f3b9a.zip
doc: readline write() is processed as input
Fixes: https://github.com/nodejs/node/issues/4402 PR-URL: https://github.com/nodejs/node/pull/8295 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'doc/api/readline.md')
-rw-r--r--doc/api/readline.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md
index c01397d571..2ffe08a31b 100644
--- a/doc/api/readline.md
+++ b/doc/api/readline.md
@@ -315,6 +315,9 @@ rl.write('Delete this!');
rl.write(null, {ctrl: true, name: 'u'});
```
+*Note*: The `rl.write()` method will write the data to the `readline`
+Interface's `input` *as if it were provided by the user*.
+
## readline.clearLine(stream, dir)
<!-- YAML
added: v0.7.7