summaryrefslogtreecommitdiff
path: root/doc/api/readline.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/readline.md')
-rw-r--r--doc/api/readline.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md
index 936ffb5d84..43314e136f 100644
--- a/doc/api/readline.md
+++ b/doc/api/readline.md
@@ -525,14 +525,22 @@ if (process.stdin.isTTY)
process.stdin.setRawMode(true);
```
-## readline.moveCursor(stream, dx, dy)
+## readline.moveCursor(stream, dx, dy[, 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}
* `dx` {number}
* `dy` {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.moveCursor()` method moves the cursor *relative* to its current
position in a given [TTY][] `stream`.