Skip to content

[readline doc] include line/cursor in readline documentation

Rodrigo Muino Tomonari requested to merge github/fork/Js-Brecht/js-brecht/readline-line-cursor into master

Documents the existence and purpose of the line and cursor properties, in an effort to make their usage public.

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 an input processor. This allows you to utilize the work that's been done in readline, instead of trying to recreate it.

Refs: https://github.com/nodejs/node/issues/30347 Refs: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/40513

Checklist

Merge request reports