Skip to content
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

Jump to bottom

Add in missing docs for exposed readline functions #3847

Closed
wants to merge 1 commit into from
Closed

Add in missing docs for exposed readline functions #3847

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions doc/api/readline.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,24 @@ a `"resize"` event on the `output` if/when the columns ever change

Move cursor to the specified position in a given TTY stream.

## readline.emitKeypressEvents(stream)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this is meant to be public or not

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not.


Accepts a readable Stream instance and makes it emit "keypress" events.

## readline.getStringWidth(str)

Returns the number of columns required to display the given string.

## readline.isFullWidthCodePoint(code)

Returns true if the character represented by a given Unicode code point is
full-width. Otherwise, returns false.

## readline.moveCursor(stream, dx, dy)

Move cursor relative to it's current position in a given TTY stream.

## readline.stripVTControlCharacters(str)

Tries to remove all VT control characters. Use to estimate displayed string
width. **May be buggy due to not running a real state machine.**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i.e. not public XD