mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
74102ab53d
Though it is not currently documented, `head` prop accepts `Cell[]`, not `string[]`. I've made PR to cli-table2 regarding this (https://github.com/jamestalmage/cli-table2/pull/53), but typings should be fixed whether it is megred or not
102 lines
2.7 KiB
TypeScript
102 lines
2.7 KiB
TypeScript
// Type definitions for cli-table2 0.2
|
|
// Project: https://github.com/jamestalmage/cli-table2
|
|
// Definitions by: Melvin Groenhoff <https://github.com/mgroenhoff>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.2
|
|
|
|
declare namespace CliTable2 {
|
|
type CharName =
|
|
"top" |
|
|
"top-mid" |
|
|
"top-left" |
|
|
"top-right" |
|
|
"bottom" |
|
|
"bottom-mid" |
|
|
"bottom-left" |
|
|
"bottom-right" |
|
|
"left" |
|
|
"left-mid" |
|
|
"mid" |
|
|
"mid-mid" |
|
|
"right" |
|
|
"right-mid" |
|
|
"middle";
|
|
|
|
type HorizontalAlignment = "left" | "center" | "right";
|
|
type VerticalAlignment = "top" | "center" | "bottom";
|
|
|
|
interface TableOptions {
|
|
truncate: string;
|
|
colWidths: Array<number | null>;
|
|
rowHeights: Array<number | null>;
|
|
colAligns: HorizontalAlignment[];
|
|
rowAligns: VerticalAlignment[];
|
|
head: Cell[];
|
|
wordWrap: boolean;
|
|
}
|
|
|
|
interface TableInstanceOptions extends TableOptions {
|
|
chars: Record<CharName, string>;
|
|
style: {
|
|
"padding-left": number;
|
|
"padding-right": number;
|
|
head: string[];
|
|
border: string[];
|
|
compact: boolean;
|
|
};
|
|
}
|
|
|
|
interface TableConstructorOptions extends Partial<TableOptions> {
|
|
chars?: Partial<Record<CharName, string>>;
|
|
style?: Partial<TableInstanceOptions["style"]>;
|
|
}
|
|
|
|
type CellValue = boolean | number | string | null | undefined;
|
|
|
|
interface CellOptions {
|
|
content: CellValue;
|
|
chars?: Partial<Record<CharName, string>>;
|
|
truncate?: string;
|
|
colSpan?: number;
|
|
rowSpan?: number;
|
|
hAlign?: HorizontalAlignment;
|
|
vAlign?: VerticalAlignment;
|
|
style?: {
|
|
"padding-left"?: number;
|
|
"padding-right"?: number;
|
|
head?: string[];
|
|
border?: string[];
|
|
};
|
|
}
|
|
|
|
interface GenericTable<T> extends Array<T> {
|
|
options: TableInstanceOptions;
|
|
readonly width: number;
|
|
}
|
|
|
|
type Table = HorizontalTable | VerticalTable | CrossTable;
|
|
type Cell = CellValue | CellOptions;
|
|
|
|
type HorizontalTable = GenericTable<HorizontalTableRow>;
|
|
type HorizontalTableRow = Cell[];
|
|
|
|
type VerticalTable = GenericTable<VerticalTableRow>;
|
|
interface VerticalTableRow {
|
|
[name: string]: Cell;
|
|
}
|
|
|
|
type CrossTable = GenericTable<CrossTableRow>;
|
|
interface CrossTableRow {
|
|
[name: string]: Cell[];
|
|
}
|
|
}
|
|
|
|
interface CliTable2 {
|
|
new (options?: CliTable2.TableConstructorOptions): CliTable2.Table;
|
|
readonly prototype: CliTable2.Table;
|
|
}
|
|
|
|
declare const CliTable2: CliTable2;
|
|
|
|
export = CliTable2;
|