blob: 632f0d7224be857c67651ea68b20fd4895dc9086 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
# sister ANSI [](https://www.npmjs.com/package/sisteransi) [](https://travis-ci.org/terkelg/sisteransi) [](https://www.npmjs.com/package/sisteransi)
> Ansi escape codes faster than you can say "[Bam bam](https://www.youtube.com/watch?v=OcaPu9JPenU)".
## Installation
```
npm install sisteransi
```
## Usage
```js
const ansi = require('sisteransi');
// or const { cursor } = require('sisteransi');
const p = str => process.stdout.write(str);
// move cursor to 2, 1
p(ansi.cursor.to(2, 1));
// to up, one down
p(ansi.cursor.up(2)+ansi.cursor.down(1));
```
## API
### cursor
#### to(x, y)
Set the absolute position of the cursor. `x0` `y0` is the top left of the screen.
#### move(x, y)
Set the position of the cursor relative to its current position.
#### up(count = 1)
Move cursor up a specific amount of rows. Default is `1`.
#### down(count = 1)
Move cursor down a specific amount of rows. Default is `1`.
#### forward(count = 1)
Move cursor forward a specific amount of rows. Default is `1`.
#### backward(count = 1)
Move cursor backward a specific amount of rows. Default is `1`.
#### nextLine(count = 1)
Move cursor to the next line a specific amount of lines. Default is `1`.
#### prevLine(count = 1)
Move cursor to the previous a specific amount of lines. Default is `1`.
#### left
Move cursor to the left side.
#### hide
Hide cursor.
#### show
Show cursor.
#### save
Save cursor position.
#### restore
Restore cursor position.
### scroll
#### up(count = 1)
Scroll display up a specific amount of lines. Default to `1`.
#### down(count = 1)
Scroll display down a specific amount of lines. Default to `1`.
### erase
#### screen
Erase the screen and move the cursor the top left position.
#### up(count = 1)
Erase the screen from the current line up to the top of the screen. Default to `1`.
#### down(count = 2)
Erase the screen from the current line down to the bottom of the screen. Default to `1`.
#### line
Erase the entire current line.
#### lineEnd
Erase from the current cursor position to the end of the current line.
#### lineStart
Erase from the current cursor position to the start of the current line.
#### lines(count)
Erase from the current cursor position up the specified amount of rows.
## Credit
This is a fork of [ansi-escapes](https://github.com/sindresorhus/ansi-escapes).
## License
MIT © [Terkel Gjervig](https://terkel.com)
|
