Skip to content

doc: modernize and fix code examples in readline.md #12634

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
wants to merge 2 commits into from
Closed

doc: modernize and fix code examples in readline.md #12634

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e17f4e
doc: improve UX in readline.md code examples
vsemozhetbyt Apr 24, 2017
2a6b727
doc: replace indexOf by startsWith in readline.md
vsemozhetbyt Apr 24, 2017
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
6 changes: 3 additions & 3 deletions doc/api/readline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ For example:

```js
rl.on('SIGINT', () => {
rl.question('Are you sure you want to exit?', (answer) => {
rl.question('Are you sure you want to exit? ', (answer) => {
if (answer.match(/^y(es)?$/i)) rl.pause();
});
});
Expand Down Expand Up @@ -255,7 +255,7 @@ If the `readline.Interface` was created with `output` set to `null` or
Example usage:

```js
rl.question('What is your favorite food?', (answer) => {
rl.question('What is your favorite food? ', (answer) => {
console.log(`Oh, so your favorite food is ${answer}`);
});
```
Expand Down Expand Up @@ -414,7 +414,7 @@ For instance: `[[substr1, substr2, ...], originalsubstring]`.
```js
function completer(line) {
const completions = '.help .error .exit .quit .q'.split(' ');
const hits = completions.filter((c) => c.indexOf(line) === 0);
const hits = completions.filter((c) => c.startsWith(line));
// show all completions if none found
return [hits.length ? hits : completions, line];
}
Expand Down