@@ -3,8 +3,6 @@ ANSI escape codes for manipulating the terminal
3
3
4
4
[ ![ version] ( https://img.shields.io/npm/v/ansi-escape.svg )] ( https://www.npmjs.org/package/ansi-escape )
5
5
[ ![ status] ( https://travis-ci.org/zoubin/ansi-escape.svg?branch=master )] ( https://travis-ci.org/zoubin/ansi-escape )
6
- [ ![ dependencies] ( https://david-dm.org/zoubin/ansi-escape.svg )] ( https://david-dm.org/zoubin/ansi-escape )
7
- [ ![ devDependencies] ( https://david-dm.org/zoubin/ansi-escape/dev-status.svg )] ( https://david-dm.org/zoubin/ansi-escape#info=devDependencies )
8
6
9
7
## Usage
10
8
@@ -39,45 +37,45 @@ Output:
39
37
## Cursors
40
38
41
39
### cursorUp(n = 1)
42
- ### cuu(n = 1)
43
- ### up(n = 1)
40
+
41
+ Alias: ` cuu ` , ` up `
44
42
45
43
Moves the cursor ` n ` cells up.
46
44
47
45
### cursorDown(n = 1)
48
- ### cud(n = 1)
49
- ### down(n = 1)
46
+
47
+ Alias: ` cud ` , ` down `
50
48
51
49
Moves the cursor ` n ` cells down.
52
50
53
51
### cursorForward(n = 1)
54
- ### cuf(n = 1)
55
- ### forward(n = 1)
52
+
53
+ Alias: ` cuf ` , ` forward `
56
54
57
55
Moves the cursor ` n ` cells forward.
58
56
59
57
### cursorBackward(n = 1)
60
- ### cub(n = 1)
61
- ### back(n = 1)
58
+
59
+ Alias: ` cub ` , ` back `
62
60
63
61
Moves the cursor ` n ` cells backward.
64
62
65
63
66
64
### cursorColumn(n = 1)
67
- ### cha(n = 1)
68
- ### col(n = 1)
65
+
66
+ Alias: ` cha ` , ` col `
69
67
70
68
Moves the cursor to column ` n ` .
71
69
72
70
### cursorPosition(n = 1, m = 1)
73
- ### cup(n = 1, m = 1)
71
+
72
+ Alias: ` cup `
74
73
75
74
Moves the cursor to row ` n ` , column ` m ` .
76
75
77
76
### eraseDisplay(n = 0)
78
- ### eraseDisplayEnd
79
- ### eraseDisplayStart
80
- ### eraseDisplayEntire
77
+
78
+ Sugar: ` eraseDisplayEnd ` , ` eraseDisplayStart ` , ` eraseDisplayEntire `
81
79
82
80
Clears part of the screen.
83
81
@@ -86,9 +84,8 @@ Clears part of the screen.
86
84
* If ` n ` is 2, clear entire screen (and moves cursor to upper left on DOS ANSI.SYS).
87
85
88
86
### eraseLine(n = 0)
89
- ### eraseLineEnd
90
- ### eraseLineStart
91
- ### eraseLineEntire
87
+
88
+ Sugar: ` eraseLineEnd ` , ` eraseLineStart ` , ` eraseLineEntire `
92
89
93
90
Erases part of the line.
94
91
@@ -99,36 +96,40 @@ Erases part of the line.
99
96
Cursor position does not change.
100
97
101
98
### scrollUp(n = 1)
102
- ### su(n = 1)
99
+
100
+ Alias: ` su `
103
101
104
102
Scroll whole page up by n (default 1) lines.
105
103
New lines are added at the bottom.
106
104
107
105
### scrollDown(n = 1)
108
- ### sd(n = 1)
106
+
107
+ Alias: ` sd `
109
108
110
109
Scroll whole page down by n (default 1) lines.
111
110
New lines are added at the top.
112
111
113
112
### saveCursorPosition
114
- ### saveCursor
115
- ### scp
113
+
114
+ Alias: ` scp ` , ` saveCursor `
116
115
117
116
Saves the cursor position.
118
117
119
118
### restoreCursorPosition
120
- ### restoreCursor
121
- ### rcp
119
+
120
+ Alias: ` rcp ` , ` restoreCursor `
122
121
123
122
Restores the cursor position.
124
123
125
124
### hideCursor
126
- ### hide
125
+
126
+ Alias: ` hide `
127
127
128
128
Hides the cursor.
129
129
130
130
### showCursor
131
- ### show
131
+
132
+ Alias: ` show `
132
133
133
134
Shows the cursor.
134
135
0 commit comments