diff options
| author | cjihrig <cjihrig@gmail.com> | 2019-07-13 18:08:19 -0400 |
|---|---|---|
| committer | Michaël Zasso <targos@protonmail.com> | 2019-07-20 11:13:05 +0200 |
| commit | 0f5af4430471ff157e8db23536f2c7fda7f449b2 (patch) | |
| tree | 1a1a5a89a1c83b1311e302daec5941144874d48c /doc | |
| parent | 2308c7412a12d3d7a61a8b66ba236f8a17a1c699 (diff) | |
| download | android-node-v8-0f5af4430471ff157e8db23536f2c7fda7f449b2.tar.gz android-node-v8-0f5af4430471ff157e8db23536f2c7fda7f449b2.tar.bz2 android-node-v8-0f5af4430471ff157e8db23536f2c7fda7f449b2.zip | |
readline: expose stream API in clearLine()
This commit adds an optional callback to clearLine(), which
is passed to the stream's write() method. It also exposes the
return value of write().
PR-URL: https://github.com/nodejs/node/pull/28674
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/readline.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md index b295ace5b3..936ffb5d84 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -346,9 +346,13 @@ async function processLineByLine() { } ``` -## readline.clearLine(stream, dir) +## readline.clearLine(stream, dir[, callback]) <!-- YAML added: v0.7.7 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/28674 + description: The stream's write() callback and return value are exposed. --> * `stream` {stream.Writable} @@ -356,6 +360,10 @@ added: v0.7.7 * `-1` - to the left from cursor * `1` - to the right from cursor * `0` - the entire line +* `callback` {Function} Invoked once the operation completes. +* Returns: {boolean} `false` if `stream` wishes for the calling code to wait for + the `'drain'` event to be emitted before continuing to write additional data; + otherwise `true`. The `readline.clearLine()` method clears current line of given [TTY][] stream in a specified direction identified by `dir`. |