-
-
Notifications
You must be signed in to change notification settings - Fork 8
/
index.d.ts
122 lines (110 loc) · 1.49 KB
/
index.d.ts
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
114
115
116
117
118
119
120
121
122
/**
Style of the box border.
*/
export type BoxStyle = {
readonly topLeft: string;
readonly top: string;
readonly topRight: string;
readonly right: string;
readonly bottomRight: string;
readonly bottom: string;
readonly bottomLeft: string;
readonly left: string;
};
/**
All box styles.
*/
export type Boxes = {
/**
@example
```
┌────┐
│ │
└────┘
```
*/
readonly single: BoxStyle;
/**
@example
```
╔════╗
║ ║
╚════╝
```
*/
readonly double: BoxStyle;
/**
@example
```
╭────╮
│ │
╰────╯
```
*/
readonly round: BoxStyle;
/**
@example
```
┏━━━━┓
┃ ┃
┗━━━━┛
```
*/
readonly bold: BoxStyle;
/**
@example
```
╓────╖
║ ║
╙────╜
```
*/
readonly singleDouble: BoxStyle;
/**
@example
```
╒════╕
│ │
╘════╛
```
*/
readonly doubleSingle: BoxStyle;
/**
@example
```
+----+
| |
+----+
```
*/
readonly classic: BoxStyle;
/**
@example
```
↘↓↓↓↓↙
→ ←
↗↑↑↑↑↖
```
*/
readonly arrow: BoxStyle;
};
/**
Boxes for use in the terminal.
@example
```
import cliBoxes from 'cli-boxes';
console.log(cliBoxes.single);
// {
// topLeft: '┌',
// top: '─',
// topRight: '┐',
// right: '│',
// bottomRight: '┘',
// bottom: '─',
// bottomLeft: '└',
// left: '│'
// }
```
*/
declare const cliBoxes: Boxes;
export default cliBoxes;