index.d.ts
1.51 KB
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
declare namespace cliBoxes {
/**
Style of the box border.
*/
interface BoxStyle {
readonly topLeft: string;
readonly topRight: string;
readonly bottomLeft: string;
readonly bottomRight: string;
readonly horizontal: string;
readonly vertical: string;
}
/**
All box styles.
*/
interface 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;
}
}
/**
Boxes for use in the terminal.
@example
```
import cliBoxes = require('cli-boxes');
console.log(cliBoxes.single);
// {
// topLeft: '┌',
// topRight: '┐',
// bottomRight: '┘',
// bottomLeft: '└',
// vertical: '│',
// horizontal: '─'
// }
```
*/
declare const cliBoxes: cliBoxes.Boxes & {
// TODO: Remove this for the next major release
default: typeof cliBoxes;
};
export = cliBoxes;