Skip to content

[readline doc] include line/cursor in readline documentation #30667

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Js-Brecht wants to merge 6 commits into from
Closed

[readline doc] include line/cursor in readline documentation #30667

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7e55ab7
doc: include line/cursor in readline documentation
Js-Brecht Nov 23, 2019
d8d3bd9
yaml documentation
Js-Brecht Dec 2, 2019
5710c46
update results fn to align with standard debounce usage
Js-Brecht Dec 2, 2019
2fa2d8d
change `rl.line` type to {string|undefined}
Js-Brecht Dec 6, 2019
f193236
change `rl.cursor` type to {number|undefined}
Js-Brecht Dec 6, 2019
ac4e8ba
YAML doc > added: 0.1.98
Js-Brecht Dec 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: include line/cursor in readline documentation 
Documents the existence and purpose of the `line` and `cursor`
properties.  `line` can be used for reading the current input value
during runtime, if reading from a TTY stream.  Both properties are
necessary when developing a custom CLI input process using `readline`
as a backend.

Refs: #30347
Refs: DefinitelyTyped/DefinitelyTyped#40513
  • Loading branch information
@Js-Brecht
Js-Brecht committed Nov 23, 2019
commit 7e55ab7e6c8843d74d2a4b08498ff25fd0749eba
42 changes: 42 additions & 0 deletions doc/api/readline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,48 @@ async function processLineByLine() {
}
```

### rl.line

* {string}
Comment thread
Js-Brecht marked this conversation as resolved.
Outdated

The current input data being processed by node.

This can be used when collecting input from a TTY stream to retrieve the
current value that has been processed thus far, prior to the `line` event
being emitted. Once the `line` event has been emitted, this property will
be an empty string.

Be aware that modifying the value during the instance runtime may have
unintended consequences if `rl.cursor` is not also controlled.

**If not using a TTY stream for input, use the [`'line'`][] event.**

One possible use case would be as follows:

```js
const values = ['lorem ipsum', 'dolor sit amet'];
const rl = readline.createInterface(process.stdin);
process.stdin.on('keypress', (c, k) => {
debounce(() => {
console.log(
'\n',
values.filter((val) => val.startsWith(rl.line)).join(' ')
);
}, 300);
});
```

### rl.cursor

* {number}

The cursor position relative to `rl.line`.

This will track where the current cursor lands in the input string, when
reading input from a TTY stream. The position of cursor determines the
portion of the input string that will be modified as input is processed,
as well as the column where the terminal caret will be rendered.

## readline.clearLine(stream, dir\[, callback\])
<!-- YAML
added: v0.7.7
Expand Down