diff options
| author | cjihrig <cjihrig@gmail.com> | 2019-07-13 20:10:17 -0400 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2019-07-16 10:03:19 -0400 |
| commit | 462f43824f6af577bde27da76d9f33365eddcfe7 (patch) | |
| tree | 12c9d41f2b0856a23a265f9227518f03bf3703e5 /doc/api/readline.md | |
| parent | 795c7482f24c0c2f1b2db8d004b03ea373b6381b (diff) | |
| download | android-node-v8-462f43824f6af577bde27da76d9f33365eddcfe7.tar.gz android-node-v8-462f43824f6af577bde27da76d9f33365eddcfe7.tar.bz2 android-node-v8-462f43824f6af577bde27da76d9f33365eddcfe7.zip | |
readline: expose stream API in cursorTo()
This commit adds an optional callback to cursorTo(), 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/api/readline.md')
| -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 43314e136f..4ff572f2e5 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -487,14 +487,22 @@ function completer(linePartial, callback) { } ``` -## readline.cursorTo(stream, x, y) +## readline.cursorTo(stream, x, y[, 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} * `x` {number} * `y` {number} +* `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.cursorTo()` method moves cursor to the specified position in a given [TTY][] `stream`. |