Skip to content

[node/readline] Expose 'line' & 'cursor' properties #40513

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

Merged
amcasey merged 2 commits into from
Dec 9, 2019
Merged

[node/readline] Expose 'line' & 'cursor' properties #40513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab9a46a
[node/readline] expose line/cursor properties + tests
Js-Brecht Nov 19, 2019
7351483
Merge remote-tracking branch 'upstream/master' into js-brecht/readlin…
Js-Brecht Nov 26, 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
7 changes: 7 additions & 0 deletions types/node/readline.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ declare module "readline" {
class Interface extends events.EventEmitter {
readonly terminal: boolean;

// Need direct access to line/cursor data, for use in external processes
// see: https://github.com/nodejs/node/issues/30347
/** The current input data */
readonly line: string;
/** The current cursor position in the input line */
readonly cursor: number;

/**
* NOTE: According to the documentation:
*
Expand Down
11 changes: 11 additions & 0 deletions types/node/test/readline.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,17 @@ const rl: readline.ReadLine = readline.createInterface(new stream.Readable());
rl.write('asd', key);
}

{
const data: string | Buffer = "test";
rl.line; // $ExpectType string
rl.cursor; // $ExpectType number

rl.write(data);

rl.line; // $ExpectType string
rl.cursor; // $ExpectType number
}

{
const strm: NodeJS.WritableStream = new stream.Writable();
const x = 1;
Expand Down
7 changes: 7 additions & 0 deletions types/node/v10/readline.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ declare module "readline" {
class Interface extends events.EventEmitter {
readonly terminal: boolean;

// Need direct access to line/cursor data, for use in external processes
// see: https://github.com/nodejs/node/issues/30347
/** The current input data */
readonly line: string;
/** The current cursor position in the input line */
readonly cursor: number;

/**
* NOTE: According to the documentation:
*
Expand Down