canonical
Version:
Canonical code style linter and formatter for JavaScript, SCSS and CSS.
133 lines (67 loc) • 2.37 kB
Markdown
ansi-escapes [](https://travis-ci.org/sindresorhus/ansi-escapes)
[ANSI escape codes](http://www.termsys.demon.co.uk/vtansi.htm) for manipulating the terminal
# Install
```
npm install --save ansi-escapes
```
# Usage
```js
var ansiEscapes = require('ansi-escapes');
// moves the cursor two rows up and to the left
process.stdout.write(ansiEscapes.cursorUp(2) + ansiEscapes.cursorLeft);
//=> '\u001b[2A\u001b[1000D'
```
# API
## cursorTo([x, [y]])
Set the absolute position of the cursor. `x0` `y0` is the top left of the screen.
Specify either both `x` & `y`, only `x`, or nothing.
## cursorMove(x, [y])
Set the position of the cursor relative to its current position.
## cursorUp(count)
Move cursor up a specific amount of rows. Default is `1`.
## cursorDown(count)
Move cursor down a specific amount of rows. Default is `1`.
## cursorForward(count)
Move cursor forward a specific amount of rows. Default is `1`.
## cursorBackward(count)
Move cursor backward a specific amount of rows. Default is `1`.
## cursorLeft
Move cursor to the left side.
## cursorSavePosition
Save cursor position.
## cursorRestorePosition
Restore saved cursor position.
## cursorGetPosition
Get cursor position.
## cursorNextLine
Move cursor to the next line.
## cursorPrevLine
Move cursor to the previous line.
## cursorHide
Hide cursor.
## cursorShow
Show cursor.
## eraseLines(count)
Erase from the current cursor position up the specified amount of rows.
## eraseEndLine
Erase from the current cursor position to the end of the current line.
## eraseStartLine
Erase from the current cursor position to the start of the current line.
## eraseLine
Erase the entire current line.
## eraseDown
Erase the screen from the current line down to the bottom of the screen.
## eraseUp
Erase the screen from the current line up to the top of the screen.
## eraseScreen
Erase the screen and move the cursor the top left position.
## scrollUp
Scroll display up one line.
## scrollDown
Scroll display down one line.
## beep
Output a beeping sound.
# Related
- [ansi-styles](https://github.com/chalk/ansi-styles) - ANSI escape codes for styling strings in the terminal
# License
MIT © [Sindre Sorhus](http://sindresorhus.com)