1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
|
7 |
|
8 | type HorizontalTableRow = string[];
|
9 | type VerticalTableRow = Record<string, string>;
|
10 | type CrossTableRow = Record<string, string[]>;
|
11 | type TableRow = HorizontalTableRow | VerticalTableRow | CrossTableRow;
|
12 |
|
13 | interface TableOptions<T extends TableRow = TableRow> {
|
14 | rows?: T[];
|
15 | chars?: {
|
16 | [k in
|
17 | | 'top'
|
18 | | 'top-mid'
|
19 | | 'top-left'
|
20 | | 'top-right'
|
21 | | 'bottom'
|
22 | | 'bottom-mid'
|
23 | | 'bottom-left'
|
24 | | 'bottom-right'
|
25 | | 'left'
|
26 | | 'left-mid'
|
27 | | 'mid'
|
28 | | 'mid-mid'
|
29 | | 'right'
|
30 | | 'right-mid'
|
31 | | 'middle']?: string;
|
32 | };
|
33 | truncate?: string;
|
34 | colors?: boolean;
|
35 | colWidths?: number[];
|
36 | colAligns?: Array<'left' | 'middle' | 'right'>;
|
37 | style?: {
|
38 | 'padding-left'?: number;
|
39 | 'padding-right'?: number;
|
40 | head?: string[];
|
41 | border?: string[];
|
42 | compact?: boolean;
|
43 | };
|
44 | head?: string[];
|
45 | }
|
46 |
|
47 | declare class Table<T extends TableRow = TableRow> extends Array<T> {
|
48 | |
49 |
|
50 |
|
51 |
|
52 |
|
53 |
|
54 | constructor(options?: T extends CrossTableRow ? never : TableOptions<T>);
|
55 | constructor(options: T extends CrossTableRow ? TableOptions<T> & { head: ['', ...string[]] } : never);
|
56 |
|
57 | /**
|
58 | * Width getter
|
59 | *
|
60 | * @return width
|
61 | * @api public
|
62 | */
|
63 | get width(): number;
|
64 |
|
65 | /**
|
66 | * Render to a string.
|
67 | *
|
68 | * @return table representation
|
69 | * @api public
|
70 | */
|
71 | render(): string;
|
72 |
|
73 | /**
|
74 | * Render to a string.
|
75 | *
|
76 | * @return table representation
|
77 | * @api public
|
78 | */
|
79 | toString(): string;
|
80 |
|
81 | static readonly version: string;
|
82 | }
|
83 |
|
84 | export = Table;
|